-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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(linter): Generator creating .eslintrc.json at the root path even when .eslintrc.js already exist #10080
Merged
Merged
fix(linter): Generator creating .eslintrc.json at the root path even when .eslintrc.js already exist #10080
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
packages/linter/src/generators/lint-project/__snapshots__/lint-project.spec.ts.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import { containsEslint, findEslintFile } from './eslint-file'; | ||
|
||
import { Tree } from '@nrwl/devkit'; | ||
import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing'; | ||
|
||
describe('@nrwl/linter:eslint-file', () => { | ||
let tree: Tree; | ||
|
||
beforeEach(() => { | ||
tree = createTreeWithEmptyWorkspace(); | ||
}); | ||
|
||
describe('containsEslint', () => { | ||
it('should return false when calling containsEslint without a eslint config', () => { | ||
expect(containsEslint(tree)).toBe(false); | ||
}); | ||
|
||
it('should return true when calling containsEslint with a .eslintrc.json config', () => { | ||
tree.write('.eslintrc.json', '{}'); | ||
expect(containsEslint(tree)).toBe(true); | ||
}); | ||
|
||
it('should return true when calling containsEslint with a .eslintrc.js config', () => { | ||
tree.write('.eslintrc.js', '{}'); | ||
expect(containsEslint(tree)).toBe(true); | ||
}); | ||
|
||
it('should return false when calling containsEslint witn an incorrect eslint file name', () => { | ||
tree.write('.eslintrc.yaml', '{}'); | ||
expect(containsEslint(tree)).toBe(false); | ||
}); | ||
}); | ||
|
||
describe('findEslintFile', () => { | ||
it('should return default name when calling findEslintFile when no eslint is found', () => { | ||
expect(findEslintFile(tree)).toBe('eslintrc.json'); | ||
}); | ||
|
||
it('should return the name of the eslint config when calling findEslintFile', () => { | ||
tree.write('.eslintrc.json', '{}'); | ||
expect(findEslintFile(tree)).toBe('.eslintrc.json'); | ||
}); | ||
|
||
it('should return the name of the eslint config when calling findEslintFile', () => { | ||
tree.write('.eslintrc.js', '{}'); | ||
expect(findEslintFile(tree)).toBe('.eslintrc.js'); | ||
}); | ||
|
||
it('should return default name when calling findEslintFile when no eslint is found', () => { | ||
tree.write('.eslintrc.yaml', '{}'); | ||
|
||
expect(findEslintFile(tree)).toBe('eslintrc.json'); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
import type { Tree } from '@nrwl/devkit'; | ||
|
||
const eslintFileList = ['.eslintrc.json', '.eslintrc.js']; | ||
|
||
export function containsEslint(tree: Tree): boolean { | ||
for (const file of eslintFileList) { | ||
if (tree.exists(file)) { | ||
return true; | ||
} | ||
} | ||
return false; | ||
} | ||
|
||
export function findEslintFile(tree: Tree): string { | ||
for (const file of eslintFileList) { | ||
if (tree.exists(file)) { | ||
return file; | ||
} | ||
} | ||
// Default file | ||
return 'eslintrc.json'; | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AloisH @FrozenPandaz I know this has already been merged, but why wasn't this
.eslintrc.json
?It has changed the behaviour inside of
packages/linter/src/generators/lint-project/lint-project.ts
aboveeslintrc.json
without a leading dot is not ever referenced by https://eslint.org/docs/user-guide/configuring/configuration-files.This seems to be intentional because you have multiple unit tests asserting this, but I haven't understood why we would want to make this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @JamesHenry ! I think I made a mistake ! Thank you for noticing it !
I got one test trying it but I think I just forgot to put a dot.
Should we revert this PR so I can make a new commit fixing it ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless @FrozenPandaz disagrees I think a fast follow on PR would be ok, if will you have chance to do that today?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No worries, I'll follow up with a fix. 👍