Skip to content

Update .editorconfig and launchsettings.json#145

Merged
adrianwyatt merged 3 commits intomicrosoft:mainfrom
lemillermicrosoft:u/lemiller/devex
Mar 23, 2023
Merged

Update .editorconfig and launchsettings.json#145
adrianwyatt merged 3 commits intomicrosoft:mainfrom
lemillermicrosoft:u/lemiller/devex

Conversation

@lemillermicrosoft
Copy link
Member

@lemillermicrosoft lemillermicrosoft commented Mar 23, 2023

Motivation and Context

Improve developer experience in VSCode. Today, VSCode will auto apply fixes for style rules listed here: https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/unnecessary-code-rules

These result in changes the team does not want to be included in our style and creates a pain in development flow.

Additionally, launchsettings.json for kernel-syntax-examples will override any user configured environment variables. To reduce the burden on folks already set up for this development flow, we can update this file.

Description

This change specifies most all of the unnecessary code rules to none except for IDE0005 for removing unnecessary usings.

For launchsettings.json, commented out the environment variables. For folks who use this method today, they can uncomment and add their keys and run git update-index --assume-unchanged <filename> to prevent the file changes from being included in their commits. For the rest, the default experience, no action will be required.

Contribution Checklist

      Summary: This commit updates the .editorconfig file to disable all style rules by default for C# files, as they are not relevant for the project and can interfere with the auto-save feature of the IDE. It also disables the VSTHRD111 analyzer, which warns about not using ConfigureAwait(false) in async methods, as this is not needed for the project and can reduce readability. These changes are intended to improve the developer experience and avoid unnecessary warnings.
      Summary: This commit comments out the environment variables related to Bing and OpenAI APIs in the launchSettings.json file, since they are not used in the current version of the project. This avoids potential confusion and errors when running the project locally or deploying it to a different environment. The variables can be uncommented and updated if needed in the future.
      Summary: This commit updates the .editorconfig file to disable several style rules that are not relevant or useful for the C# code base. These rules include ones that suggest using var, removing unused usings, simplifying names, and removing unused parameters. By disabling these rules, the code base can avoid unnecessary noise and warnings from the analyzers and most importantly, auto updates on file save from IDEs.
@lemillermicrosoft lemillermicrosoft added main PR: ready for review All feedback addressed, ready for reviews labels Mar 23, 2023
@lemillermicrosoft lemillermicrosoft marked this pull request as ready for review March 23, 2023 17:30
Copy link
Member

@rogerbarreto rogerbarreto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally I would prefer having those variables within the project launch definition same way we have with the .env and discourage the dev experience to ⁠set User variables manually in Windows.

Another way would be to create a fallback logic that if a lauchSettings Environment variables are empty, try get them from Windows User Environments

Environment.GetEnvironmentVariable("variable", EnvironmentVariableTarget.User);

@adrianwyatt adrianwyatt merged commit fefe712 into microsoft:main Mar 23, 2023
dehoward pushed a commit to lemillermicrosoft/semantic-kernel that referenced this pull request Jun 1, 2023
Improve developer experience in VSCode. Today, VSCode will auto apply
fixes for style rules listed here:
https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/unnecessary-code-rules

These result in changes the team does not want to be included in our
style and creates a pain in development flow.

Additionally, launchsettings.json for `kernel-syntax-examples` will
override any user configured environment variables. To reduce the burden
on folks already set up for this development flow, we can update this
file.
golden-aries pushed a commit to golden-aries/semantic-kernel that referenced this pull request Oct 10, 2023
### Motivation and Context

<!-- Thank you for your contribution to the copilot-chat repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

Added new app state for setting user info, refactored app views, and
added shared styles for informative views.

This is a fix for a bug where the webapp would get stuck on the Loading
Chats page. Something with SSO caused this.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
- The App component now transitions to a SettingUserInfo state after
successfully discovering the backend, and then to the LoadingChats state
after successfully setting the active user info.
- The user info status text in the App component has been updated to
display a default message while fetching user information, and an error
component has been added to display an error message at view level.
- A new useSharedClasses hook has been added to provide a set of shared
styles for informative views.
- The BackendProbe component has also been updated to use the shared
informativeView class.
- Added tesseract data files to gitignore

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [Contribution
Guidelines](https://github.com/microsoft/copilot-chat/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/copilot-chat/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
~~- [ ] All unit tests pass, and I have added new tests where possible~~
- [x] I didn't break anyone 😄
johnoliver pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
Improve developer experience in VSCode. Today, VSCode will auto apply
fixes for style rules listed here:
https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/unnecessary-code-rules

These result in changes the team does not want to be included in our
style and creates a pain in development flow.

Additionally, launchsettings.json for `kernel-syntax-examples` will
override any user configured environment variables. To reduce the burden
on folks already set up for this development flow, we can update this
file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: ready for review All feedback addressed, ready for reviews

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants