eslint-utils
Advanced tools
Package description
The eslint-utils package provides utility functions for developers working with ESLint, a static code analysis tool for identifying problematic patterns in JavaScript code. It offers a set of APIs that can be used to manipulate and query the abstract syntax tree (AST) generated by ESLint, making it easier to create custom rules and analyze code.
AST Utilities
Provides functions to interact with the AST, such as finding variables, their references, and their definitions within the code.
{"findVariable": "function (initializer) { return getVariableByName(initializer, 'myVariable'); }"}Reference Utilities
Offers methods to determine if a variable is being used in the code, which can help in identifying unused variables and potential bugs.
{"isUsedVariable": "function (variable) { return isUsedVariable(variable); }"}Scope Analysis
Allows for analysis of variable scope, which can be used to ensure that variables are declared and used within the correct scope.
{"getInnermostScope": "function (scope, node) { return getInnermostScope(scope, node); }"}ESLint is the core package that eslint-utils is designed to complement. It provides the framework for static code analysis, including parsing code into an AST, managing rules, and reporting issues. eslint-utils offers additional utilities that can be used within the context of ESLint's ecosystem.
babel-eslint is a parser that allows ESLint to run on source code that is transpiled with Babel. While it does not provide utility functions like eslint-utils, it serves a similar purpose in extending the capabilities of ESLint to work with a wider range of JavaScript syntax.
typescript-eslint is a plugin that enables ESLint to support TypeScript, a superset of JavaScript. It includes a parser and a set of rules specifically designed for TypeScript code. Like eslint-utils, it extends the functionality of ESLint but is focused on TypeScript rather than providing general utility functions.
Readme
This package provides utility functions and classes for make ESLint custom rules.
For example, there is the class which tracks variable references.
const { ReferenceTracker } = require("eslint-utils")
module.exports = {
meta: {},
create(context) {
return {
"Program:exit"() {
const tracker = new ReferenceTracker(context.getScope())
// Track the references of global variables.
for (const { node, path } of tracker.iterateGlobalReferences({
// Iterate the call expressions of `console.log`, `console.info`
console: {
log: { [ReferenceTracker.CALL]: true },
info: { [ReferenceTracker.CALL]: true },
},
})) {
context.report({
node,
message: "Don't use {{name}}.",
data: { name: path.join(".") },
})
}
// Track the references of CommonJS modules.
for (const { node, path } of tracker.iterateCjsReferences({
// Iterate the access of `fs.exists`.
fs: {
exists: { [ReferenceTracker.READ]: true },
},
})) {
context.report({
node,
message: "Don't use {{name}}.",
data: { name: path.join(".") },
})
}
}
}
},
}
npm install eslint-utils
6.5.0 or newer.See API reference.
See releases.
Welcome contributing!
Please use GitHub's Issues/PRs.
npm test runs tests and measures coverage.npm run clean removes the coverage result of npm test command.npm run coverage shows the coverage result of the last npm test command.npm run lint runs ESLint.npm run watch runs tests on each file change.FAQs
Utilities for ESLint plugins.
We found that eslint-utils demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.