-
-
Notifications
You must be signed in to change notification settings - Fork 107
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
feat: extend detect non literal fs filename #92
Merged
nzakas
merged 5 commits into
eslint-community:main
from
BuZZ-T:feature/extend-detect-non-literal-fs-filename
Dec 6, 2022
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a1ae157
feat: rewritten detect-non-literal-fs-filename rule
BuZZ-T b6d7c3d
refactor: extract searching for ImportDeclaration and VariableDeclara…
BuZZ-T b9569e6
chore: added JSdoc, inlined fsPackagesNames, renamed sink terminology
e46d3e2
chore: changed report params to object
e5e51b1
chore: rename 'sink', remove '?.' for node 12
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,41 @@ | ||
/** | ||
* Returns the ImportDeclaration for the import of the methodName from one of the packageNames | ||
* import { methodName as a } from 'packageName'; | ||
* | ||
* @param {Object} param0 | ||
* @param {string} param0.methodName | ||
* @param {string[]} param0.packageNames | ||
* @param {Object} param0.program The AST program object | ||
* @returns The ImportDeclaration for the import of the methodName from one of the packageNames | ||
*/ | ||
module.exports.getImportDeclaration = ({ methodName, packageNames, program }) => | ||
program.body.find((entry) => entry.type === 'ImportDeclaration' && packageNames.includes(entry.source.value) && entry.specifiers.some((s) => s.local.name === methodName)); | ||
|
||
/** | ||
* Returns the VariableDeclaration for a require based import | ||
* | ||
* @param {Object} param0 | ||
* @param {Function} param0.condition Optional function to check additional conditions on the resulting VariableDeclaration | ||
* @param {boolean} param0.hasObject Whether the information is received by declaration.init or declaration.init.object | ||
* @param {string[]} param0.packageNames The interesting packages the method is imported from | ||
* @param {Object} param0.program The AST program object | ||
* @returns | ||
*/ | ||
module.exports.getVariableDeclaration = ({ condition, hasObject, packageNames, program }) => | ||
program.body | ||
// a node import is a variable declaration | ||
.filter((entry) => entry.type === 'VariableDeclaration') | ||
// one var/let/const may contain multiple declarations, separated by comma, after the "=" sign | ||
.flatMap((d) => d.declarations) | ||
.find((d) => { | ||
const init = hasObject ? d.init.object : d.init; | ||
|
||
return ( | ||
init && | ||
init.callee && | ||
init.callee.name === 'require' && | ||
init.arguments[0].type === 'Literal' && | ||
packageNames.includes(init.arguments[0].value) && | ||
(!condition || condition(d)) | ||
); | ||
}); |
Oops, something went wrong.
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.
Can you include some JSDoc comments for the parameters and return types?