Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ESLint in samples/apps #1452

Merged
merged 17 commits into from
Jun 23, 2023
Merged

Conversation

dehoward
Copy link
Contributor

@dehoward dehoward commented Jun 13, 2023

Motivation and Context

correctly using ESLint in our sample apps will help us

  • follow best practices,
  • cut down on bugs that the linter can catch, and
  • enforce a unified style

Description

  • adds .env.local to each app to disable ESLint in all environments
    • temporary until the violations are fixed in the app
    • this seemed to be the easiest way to disable ESLint without folks having to do anything, open to suggestions here.
    • this is needed because now the build picks up on our config file and will fail since there are currently violations
  • adds a package.json to samples/apps for the shared dependencies needed for running eslint
  • adds the npm run lint script and eslint package to apps where not already present
  • removes unneeded ESLint config/dependencies from CopilotChat
  • renames .eslingrc.js to .eslintrc.js

Note

this doesn't start enforcing ESLint anywhere or fix any violations, and rather just fixes the config so that we can begin to correct the errors.

there are quite a number of violations just in CopilotChat alone:
image

eslint --fix can fix about half of these, albeit we should review these changes carefully if used.

Contribution Checklist

@dehoward dehoward added PR: ready for review All feedback addressed, ready for reviews samples labels Jun 13, 2023
@dehoward dehoward marked this pull request as draft June 13, 2023 20:52
@adrianwyatt adrianwyatt added the PR: in progress Under development and/or addressing feedback label Jun 14, 2023
@dehoward dehoward marked this pull request as ready for review June 14, 2023 03:26
@dehoward dehoward removed the PR: in progress Under development and/or addressing feedback label Jun 14, 2023
@dehoward dehoward self-assigned this Jun 14, 2023
teresaqhoang
teresaqhoang previously approved these changes Jun 15, 2023
@dehoward dehoward added PR: ready to merge PR has been approved by all reviewers, and is ready to merge. and removed PR: ready for review All feedback addressed, ready for reviews labels Jun 20, 2023
@dehoward dehoward requested a review from a team as a code owner June 20, 2023 22:18
TaoChenOSU
TaoChenOSU previously approved these changes Jun 21, 2023
@adrianwyatt adrianwyatt added this pull request to the merge queue Jun 23, 2023
Merged via the queue into microsoft:main with commit 71120b2 Jun 23, 2023
12 checks passed
shawncal added a commit to shawncal/semantic-kernel that referenced this pull request Jul 6, 2023
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel 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.
-->
correctly using ESLint in our sample apps will help us
- follow best practices, 
- cut down on bugs that the linter can catch, and
- enforce a unified style

### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
- adds `.env.local` to each app to disable ESLint in all environments
  - temporary until the violations are fixed in the app
- this seemed to be the easiest way to disable ESLint without folks
having to do anything, open to suggestions here.
- this is needed because now the build picks up on our config file and
will fail since there are currently violations
- adds a `package.json` to `samples/apps` for the shared dependencies
needed for running `eslint`
- adds the `npm run lint` script and `eslint` package to apps where not
already present
- removes unneeded ESLint config/dependencies from CopilotChat
- renames `.eslingrc.js` to `.eslintrc.js`

### Note
**this doesn't start enforcing ESLint anywhere or fix any violations**,
and rather just fixes the config so that we can begin to correct the
errors.

there are quite a number of violations just in CopilotChat alone:

![image](https://github.com/microsoft/semantic-kernel/assets/52973358/0ac17df8-35a8-4c31-929a-0a9629d5d031)

`eslint --fix` can fix about half of these, albeit we should review
these changes carefully if used.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Shawn Callegari <36091529+shawncal@users.noreply.github.com>
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 semantic-kernel 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.
-->
correctly using ESLint in our sample apps will help us
- follow best practices, 
- cut down on bugs that the linter can catch, and
- enforce a unified style

### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
- adds `.env.local` to each app to disable ESLint in all environments
  - temporary until the violations are fixed in the app
- this seemed to be the easiest way to disable ESLint without folks
having to do anything, open to suggestions here.
- this is needed because now the build picks up on our config file and
will fail since there are currently violations
- adds a `package.json` to `samples/apps` for the shared dependencies
needed for running `eslint`
- adds the `npm run lint` script and `eslint` package to apps where not
already present
- removes unneeded ESLint config/dependencies from CopilotChat
- renames `.eslingrc.js` to `.eslintrc.js`

### Note
**this doesn't start enforcing ESLint anywhere or fix any violations**,
and rather just fixes the config so that we can begin to correct the
errors.

there are quite a number of violations just in CopilotChat alone:

![image](https://github.com/microsoft/semantic-kernel/assets/52973358/0ac17df8-35a8-4c31-929a-0a9629d5d031)

`eslint --fix` can fix about half of these, albeit we should review
these changes carefully if used.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Shawn Callegari <36091529+shawncal@users.noreply.github.com>
johnoliver pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel 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.
-->
correctly using ESLint in our sample apps will help us
- follow best practices, 
- cut down on bugs that the linter can catch, and
- enforce a unified style

### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
- adds `.env.local` to each app to disable ESLint in all environments
  - temporary until the violations are fixed in the app
- this seemed to be the easiest way to disable ESLint without folks
having to do anything, open to suggestions here.
- this is needed because now the build picks up on our config file and
will fail since there are currently violations
- adds a `package.json` to `samples/apps` for the shared dependencies
needed for running `eslint`
- adds the `npm run lint` script and `eslint` package to apps where not
already present
- removes unneeded ESLint config/dependencies from CopilotChat
- renames `.eslingrc.js` to `.eslintrc.js`

### Note
**this doesn't start enforcing ESLint anywhere or fix any violations**,
and rather just fixes the config so that we can begin to correct the
errors.

there are quite a number of violations just in CopilotChat alone:

![image](https://github.com/microsoft/semantic-kernel/assets/52973358/0ac17df8-35a8-4c31-929a-0a9629d5d031)

`eslint --fix` can fix about half of these, albeit we should review
these changes carefully if used.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Shawn Callegari <36091529+shawncal@users.noreply.github.com>
johnoliver pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel 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.
-->
correctly using ESLint in our sample apps will help us
- follow best practices, 
- cut down on bugs that the linter can catch, and
- enforce a unified style

### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
- adds `.env.local` to each app to disable ESLint in all environments
  - temporary until the violations are fixed in the app
- this seemed to be the easiest way to disable ESLint without folks
having to do anything, open to suggestions here.
- this is needed because now the build picks up on our config file and
will fail since there are currently violations
- adds a `package.json` to `samples/apps` for the shared dependencies
needed for running `eslint`
- adds the `npm run lint` script and `eslint` package to apps where not
already present
- removes unneeded ESLint config/dependencies from CopilotChat
- renames `.eslingrc.js` to `.eslintrc.js`

### Note
**this doesn't start enforcing ESLint anywhere or fix any violations**,
and rather just fixes the config so that we can begin to correct the
errors.

there are quite a number of violations just in CopilotChat alone:

![image](https://github.com/microsoft/semantic-kernel/assets/52973358/0ac17df8-35a8-4c31-929a-0a9629d5d031)

`eslint --fix` can fix about half of these, albeit we should review
these changes carefully if used.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Shawn Callegari <36091529+shawncal@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: ready to merge PR has been approved by all reviewers, and is ready to merge.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants