eslint-visitor-keys

v4.2.0

Constants and utilities about visitor keys to traverse AST. For more information about how to use this package see README

Latest version published 2 months ago

License: BSD-2-Clause

NPM

GitHub

Package Health Score

94 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Healthy
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.2.0	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.1.0	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.4.3	\|	08/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.0	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.0	\|	08/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-2-Clause

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Key ecosystem project

Weekly Downloads (69,337,086)

GitHub Stars: 2.29K
Forks: 196
Contributors: 60

Direct Usage Popularity

The npm package eslint-visitor-keys receives a total of 69,337,086 downloads a week. As such, we scored eslint-visitor-keys popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package eslint-visitor-keys, we found that it has been starred 2,292 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 60
Funding: Yes

With more than 10 contributors for the eslint-visitor-keys repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 4
Open PR: 1
Last Release: 2 months ago
Last Commit: 1 day ago

Further analysis of the maintenance status of eslint-visitor-keys based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that eslint-visitor-keys demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^18.18.0 || ^20.9.0 || >=21.1.0

Age: 7 years
Dependencies: 0 Direct
Versions: 19
Install Size: 36.1 kB
Dist-tags: 1
# of Files: 9
Maintainers: 2
TS Typings: Yes

eslint-visitor-keys has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use eslint-visitor-keys?

To help you get started, we've collected the most common ways that eslint-visitor-keys is being used within popular public projects.

mysticatea / vue-eslint-parser / src / ast / traverse.ts View on Github

/**
 * @author Toru Nagashima 
 * @copyright 2017 Toru Nagashima. All rights reserved.
 * See LICENSE file in root directory for full license.
 */
import Evk, { VisitorKeys } from "eslint-visitor-keys"
import { Node } from "./nodes"

//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------

const KEYS = Evk.unionWith({
    VAttribute: ["key", "value"],
    VDirectiveKey: ["name", "argument", "modifiers"],
    VDocumentFragment: ["children"],
    VElement: ["startTag", "children", "endTag"],
    VEndTag: [],
    VExpressionContainer: ["expression"],
    VFilter: ["callee", "arguments"],
    VFilterSequenceExpression: ["expression", "filters"],
    VForExpression: ["left", "right"],
    VIdentifier: [],
    VLiteral: [],
    VOnExpression: ["body"],
    VSlotScopeExpression: ["params"],
    VStartTag: ["attributes"],
    VText: [],
})

View more ways to use eslint-visitor-keys

eslint-visitor-keys

Constants and utilities about visitor keys to traverse AST.

💿 Installation

Use npm to install.

$ npm install eslint-visitor-keys

Requirements

Node.js ^18.18.0, ^20.9.0, or >=21.1.0

📖 Usage

To use in an ESM file:

import * as evk from "eslint-visitor-keys"

To use in a CommonJS file:

const evk = require("eslint-visitor-keys")

evk.KEYS

> type: { [type: string]: string[] | undefined }

Visitor keys. This keys are frozen.

This is an object. Keys are the type of ESTree nodes. Their values are an array of property names which have child nodes.

For example:

console.log(evk.KEYS.AssignmentExpression) // → ["left", "right"]

evk.getKeys(node)

> type: (node: object) => string[]

Get the visitor keys of a given AST node.

This is similar to Object.keys(node) of ES Standard, but some keys are excluded: parent, leadingComments, trailingComments, and names which start with _.

This will be used to traverse unknown nodes.

For example:

const node = {
    type: "AssignmentExpression",
    left: { type: "Identifier", name: "foo" },
    right: { type: "Literal", value: 0 }
}
console.log(evk.getKeys(node)) // → ["type", "left", "right"]

evk.unionWith(additionalKeys)

> type: (additionalKeys: object) => { [type: string]: string[] | undefined }

Make the union set with evk.KEYS and the given keys.

The order of keys is, additionalKeys is at first, then evk.KEYS is concatenated after that.
It removes duplicated keys as keeping the first one.

For example:

console.log(evk.unionWith({
    MethodDefinition: ["decorators"]
})) // → { ..., MethodDefinition: ["decorators", "key", "value"], ... }

📰 Change log

See GitHub releases.

🍻 Contributing

Welcome. See ESLint contribution guidelines.

Development commands

npm test runs tests and measures code coverage.
npm run lint checks source codes with ESLint.
npm run test:open-coverage opens the code coverage report of the previous test with your default browser.

eslint-visitor-keys development dependencies

@types/estree @types/estree-jsx @typescript-eslint/parser c8 chai eslint-release esquery json-diff mocha opener rollup rollup-plugin-dts tsd typescript

FAQs

What is eslint-visitor-keys?

Constants and utilities about visitor keys to traverse AST. Visit Snyk Advisor to see a full health score report for eslint-visitor-keys, including popularity, security, maintenance & community analysis.

Is eslint-visitor-keys popular?

The npm package eslint-visitor-keys receives a total of 69,337,086 weekly downloads. As such, eslint-visitor-keys popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is eslint-visitor-keys well maintained?

We found that eslint-visitor-keys demonstrated a healthy version release cadence and project activity. It has a community of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is eslint-visitor-keys safe to use?

The npm package eslint-visitor-keys was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 01:12 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (69,337,086)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use eslint-visitor-keys?

eslint-visitor-keys

💿 Installation

Requirements

📖 Usage

evk.KEYS

evk.getKeys(node)

evk.unionWith(additionalKeys)

📰 Change log

🍻 Contributing

Development commands

Sponsors

Platinum Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Technology Sponsors

eslint-visitor-keys development dependencies

FAQs

What is eslint-visitor-keys?

Is eslint-visitor-keys popular?

Is eslint-visitor-keys well maintained?

Is eslint-visitor-keys safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues