Have ideas to improve npm?Join in the discussion! »

    eslint-visitor-keys
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/eslint-visitor-keys package

    2.1.0 • Public • Published

    eslint-visitor-keys

    npm version Downloads/month Build Status Dependency Status

    Constants and utilities about visitor keys to traverse AST.

    💿 Installation

    Use npm to install.

    $ npm install eslint-visitor-keys

    Requirements

    📖 Usage

    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 coverage opens the code coverage report of the previous test with your default browser.
    • npm run release publishes this package to npm registory.

    Keywords

    none

    Install

    npm i eslint-visitor-keys

    DownloadsWeekly Downloads

    22,939,932

    Version

    2.1.0

    License

    Apache-2.0

    Unpacked Size

    24.7 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar