pax_global_header00006660000000000000000000000064142015566020014513gustar00rootroot0000000000000052 comment=4bd964896e38036cc6aa85b50b2d64e345deb58b eslint-visitor-keys-3.3.0/000077500000000000000000000000001420155660200154625ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/.editorconfig000066400000000000000000000004361420155660200201420ustar00rootroot00000000000000; EditorConfig file: https://EditorConfig.org ; Install the "EditorConfig" plugin into your editor to use root = true [*] charset = utf-8 end_of_line = lf insert_final_newline = true indent_style = space indent_size = 4 trim_trailing_whitespace = true [package.json] indent_size = 2 eslint-visitor-keys-3.3.0/.eslintrc.json000066400000000000000000000011001420155660200202460ustar00rootroot00000000000000{ "extends": "eslint", "env": { "es2020": true }, "parserOptions": { "sourceType": "module", "ecmaVersion": 2020 }, "settings": { "jsdoc": { "mode": "typescript", "preferredTypes": { "Object": "object", "object<>": "Object" } } }, "overrides": [ { "files": ["*.cjs"], "parserOptions": { "sourceType": "script" } } ], "ignorePatterns": ["/dist", "/coverage"] } eslint-visitor-keys-3.3.0/.gitattributes000066400000000000000000000000231420155660200203500ustar00rootroot00000000000000* text=auto eol=lf eslint-visitor-keys-3.3.0/.github/000077500000000000000000000000001420155660200170225ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/.github/workflows/000077500000000000000000000000001420155660200210575ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/.github/workflows/ci.yml000066400000000000000000000014371420155660200222020ustar00rootroot00000000000000name: CI on: push: branches: - main pull_request: branches: - main jobs: lint: name: Lint runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Setup Node.js uses: actions/setup-node@v2 with: node-version: '12.x' - name: Install dependencies run: npm install - name: Lint files run: npm run lint test: name: Test strategy: matrix: os: [ubuntu-latest] node: [17.x, 16.x, 14.x, 12.x, "12.22.0"] runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: ${{ matrix.node }} - name: Install dependencies run: npm install - name: Run tests run: npm test eslint-visitor-keys-3.3.0/.gitignore000066400000000000000000000001261420155660200174510ustar00rootroot00000000000000/.nyc_output /.vscode /coverage /node_modules /test.* .eslint-release-info.json /dist eslint-visitor-keys-3.3.0/.npmrc000066400000000000000000000000231420155660200165750ustar00rootroot00000000000000package-lock=false eslint-visitor-keys-3.3.0/CHANGELOG.md000066400000000000000000000103531420155660200172750ustar00rootroot00000000000000v3.3.0 - February 11, 2022 * [`7f10327`](https://github.com/eslint/eslint-visitor-keys/commit/7f103276844fb131cfad115ee78eb19f798d5fc8) feat: Bundle JSDoc-built TypeScript declaration file (#34) (Brett Zamir) v3.2.0 - January 15, 2022 * [`5c53218`](https://github.com/eslint/eslint-visitor-keys/commit/5c532184e05440d3c883b3d7864f84eb1b11dc90) feat: add missing JSXOpeningFragment and JSXClosingFragment (#33) (Richard Huang) * [`2a5c9a6`](https://github.com/eslint/eslint-visitor-keys/commit/2a5c9a622d8cb09df9d40a320d146b0941081e11) docs: readme add syntax highlighting (#32) (coderaiser) v3.1.0 - November 8, 2021 * [`5e3e687`](https://github.com/eslint/eslint-visitor-keys/commit/5e3e68779560a1b2edef7923d30165396bce9602) build: upgrade eslint-release to v3.2.0 to support conventional commits (#31) (Milos Djermanovic) * [`53d3939`](https://github.com/eslint/eslint-visitor-keys/commit/53d39390d3560c179cffd08638b50343b0841a30) Build: add node v17 (#30) (唯然) * [`5f5b232`](https://github.com/eslint/eslint-visitor-keys/commit/5f5b232386bd7e217dd61d08aa27c3a1e2a4665e) Update: add StaticBlock (#29) (Milos Djermanovic) * [`e89bff9`](https://github.com/eslint/eslint-visitor-keys/commit/e89bff9fd6a5929b1e8f4d5f9cedec45aa966074) Chore: use actions/setup-node@v2 (薛定谔的猫) * [`7b756cd`](https://github.com/eslint/eslint-visitor-keys/commit/7b756cd37cd28089dfee6015c001fd860e21aead) Docs: Update the minimum Node.js version requirement (#26) (0uep) v3.0.0 - June 24, 2021 * [`701b67d`](https://github.com/eslint/eslint-visitor-keys/commit/701b67de7216cabebc03e7c6205fe47ce3177aa3) Breaking: drop node v10/v13/v15 (refs eslint/eslint#14023) (#23) (薛定谔的猫) * [`f584b12`](https://github.com/eslint/eslint-visitor-keys/commit/f584b121421ceb6c4e034b79943f3c32aaa0541d) Breaking: Switch to ESM (#24) (Brett Zamir) * [`7279e73`](https://github.com/eslint/eslint-visitor-keys/commit/7279e7304e95030a854408191b8fde3c01876451) Build: Update branch reference in CI (#25) (Milos Djermanovic) * [`c6846d6`](https://github.com/eslint/eslint-visitor-keys/commit/c6846d69271c73041b797b7de9c8254dcf439a2e) Upgrade: eslint-release (#21) (Nicholas C. Zakas) v2.1.0 - May 3, 2021 * [`908fdf8`](https://github.com/eslint/eslint-visitor-keys/commit/908fdf8c0d9a352c696c8c1f4901280d1a0795f7) Update: add PrivateIdentifier and PropertyDefinition (#20) (Toru Nagashima) * [`2d7be11`](https://github.com/eslint/eslint-visitor-keys/commit/2d7be11e4d13ac702c9fe3c529cadbd75b370146) Chore: No longer test in Node.js 13 (#17) (Michaël De Boey) * [`b41b509`](https://github.com/eslint/eslint-visitor-keys/commit/b41b509b153ecd8d47af46a421122f64e93d4c67) Docs: Update required Node.js version (#15) (Michaël De Boey) v2.0.0 - August 14, 2020 * [`fb86ca3`](https://github.com/eslint/eslint-visitor-keys/commit/fb86ca315daafc84e23ed9005db40b0892b972a6) Breaking: drop support for Node <10 (#13) (Kai Cataldo) * [`69383b3`](https://github.com/eslint/eslint-visitor-keys/commit/69383b372915e33ada094880ecc6b6e8f8c7ca4e) Chore: move to GitHub Actions (#14) (Kai Cataldo) v1.3.0 - June 19, 2020 * [`c92dd7f`](https://github.com/eslint/eslint-visitor-keys/commit/c92dd7ff96f0044dba12d681406a025b92b4c437) Update: add `ChainExpression` node (#12) (Toru Nagashima) v1.2.0 - June 4, 2020 * [`21f28bf`](https://github.com/eslint/eslint-visitor-keys/commit/21f28bf11be5329d740a8bf6bdbcd0ef13bbf1a2) Update: added exported in exportAllDeclaration key (#10) (Anix) v1.1.0 - August 13, 2019 * [`9331cc0`](https://github.com/eslint/eslint-visitor-keys/commit/9331cc09e756e65b9044c9186445a474b037fac6) Update: add ImportExpression (#8) (Toru Nagashima) * [`5967f58`](https://github.com/eslint/eslint-visitor-keys/commit/5967f583b04f17fba9226aaa394e45d476d2b8af) Chore: add supported Node.js versions to CI (#7) (Kai Cataldo) * [`6f7c60f`](https://github.com/eslint/eslint-visitor-keys/commit/6f7c60fef2ceec9f6323202df718321cec45cab0) Upgrade: eslint-release@1.0.0 (#5) (Teddy Katz) v1.0.0 - December 18, 2017 * 1f6bd38 Breaking: update keys (#4) (Toru Nagashima) v0.1.0 - November 17, 2017 * 17b4a88 Chore: update `repository` field in package.json (#3) (Toru Nagashima) * a5a026b New: eslint-visitor-keys (#1) (Toru Nagashima) * a1a48b8 Update: Change license to Apache 2 (#2) (Ilya Volodin) * 2204715 Initial commit (Toru Nagashima) eslint-visitor-keys-3.3.0/LICENSE000066400000000000000000000261111420155660200164700ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright contributors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. eslint-visitor-keys-3.3.0/README.md000066400000000000000000000055241420155660200167470ustar00rootroot00000000000000# eslint-visitor-keys [![npm version](https://img.shields.io/npm/v/eslint-visitor-keys.svg)](https://www.npmjs.com/package/eslint-visitor-keys) [![Downloads/month](https://img.shields.io/npm/dm/eslint-visitor-keys.svg)](http://www.npmtrends.com/eslint-visitor-keys) [![Build Status](https://travis-ci.org/eslint/eslint-visitor-keys.svg?branch=master)](https://travis-ci.org/eslint/eslint-visitor-keys) [![Dependency Status](https://david-dm.org/eslint/eslint-visitor-keys.svg)](https://david-dm.org/eslint/eslint-visitor-keys) Constants and utilities about visitor keys to traverse AST. ## 💿 Installation Use [npm] to install. ```bash $ npm install eslint-visitor-keys ``` ### Requirements - [Node.js] `^12.22.0`, `^14.17.0`, or `>=16.0.0` ## 📖 Usage To use in an ESM file: ```js import * as evk from "eslint-visitor-keys" ``` To use in a CommonJS file: ```js 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: ```js 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: ```js console.log(evk.unionWith({ MethodDefinition: ["decorators"] })) // → { ..., MethodDefinition: ["decorators", "key", "value"], ... } ``` ## 📰 Change log See [GitHub releases](https://github.com/eslint/eslint-visitor-keys/releases). ## 🍻 Contributing Welcome. See [ESLint contribution guidelines](https://eslint.org/docs/developer-guide/contributing/). ### 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. [npm]: https://www.npmjs.com/ [Node.js]: https://nodejs.org/ [ESTree]: https://github.com/estree/estree eslint-visitor-keys-3.3.0/lib/000077500000000000000000000000001420155660200162305ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/lib/index.js000066400000000000000000000033511420155660200176770ustar00rootroot00000000000000/** * @author Toru Nagashima * See LICENSE file in root directory for full license. */ import KEYS from "./visitor-keys.js"; /** * @typedef {{ readonly [type: string]: ReadonlyArray }} VisitorKeys */ // List to ignore keys. const KEY_BLACKLIST = new Set([ "parent", "leadingComments", "trailingComments" ]); /** * Check whether a given key should be used or not. * @param {string} key The key to check. * @returns {boolean} `true` if the key should be used. */ function filterKey(key) { return !KEY_BLACKLIST.has(key) && key[0] !== "_"; } /** * Get visitor keys of a given node. * @param {object} node The AST node to get keys. * @returns {readonly string[]} Visitor keys of the node. */ export function getKeys(node) { return Object.keys(node).filter(filterKey); } // Disable valid-jsdoc rule because it reports syntax error on the type of @returns. // eslint-disable-next-line valid-jsdoc /** * Make the union set with `KEYS` and given keys. * @param {VisitorKeys} additionalKeys The additional keys. * @returns {VisitorKeys} The union set. */ export function unionWith(additionalKeys) { const retv = /** @type {{ [type: string]: ReadonlyArray }} */ (Object.assign({}, KEYS)); for (const type of Object.keys(additionalKeys)) { if (Object.prototype.hasOwnProperty.call(retv, type)) { const keys = new Set(additionalKeys[type]); for (const key of retv[type]) { keys.add(key); } retv[type] = Object.freeze(Array.from(keys)); } else { retv[type] = Object.freeze(Array.from(additionalKeys[type])); } } return Object.freeze(retv); } export { KEYS }; eslint-visitor-keys-3.3.0/lib/visitor-keys.js000066400000000000000000000121451420155660200212410ustar00rootroot00000000000000/** * @typedef {import('./index.js').VisitorKeys} VisitorKeys */ /** * @type {VisitorKeys} */ const KEYS = { AssignmentExpression: [ "left", "right" ], AssignmentPattern: [ "left", "right" ], ArrayExpression: [ "elements" ], ArrayPattern: [ "elements" ], ArrowFunctionExpression: [ "params", "body" ], AwaitExpression: [ "argument" ], BlockStatement: [ "body" ], BinaryExpression: [ "left", "right" ], BreakStatement: [ "label" ], CallExpression: [ "callee", "arguments" ], CatchClause: [ "param", "body" ], ChainExpression: [ "expression" ], ClassBody: [ "body" ], ClassDeclaration: [ "id", "superClass", "body" ], ClassExpression: [ "id", "superClass", "body" ], ConditionalExpression: [ "test", "consequent", "alternate" ], ContinueStatement: [ "label" ], DebuggerStatement: [], DoWhileStatement: [ "body", "test" ], EmptyStatement: [], ExportAllDeclaration: [ "exported", "source" ], ExportDefaultDeclaration: [ "declaration" ], ExportNamedDeclaration: [ "declaration", "specifiers", "source" ], ExportSpecifier: [ "exported", "local" ], ExpressionStatement: [ "expression" ], ExperimentalRestProperty: [ "argument" ], ExperimentalSpreadProperty: [ "argument" ], ForStatement: [ "init", "test", "update", "body" ], ForInStatement: [ "left", "right", "body" ], ForOfStatement: [ "left", "right", "body" ], FunctionDeclaration: [ "id", "params", "body" ], FunctionExpression: [ "id", "params", "body" ], Identifier: [], IfStatement: [ "test", "consequent", "alternate" ], ImportDeclaration: [ "specifiers", "source" ], ImportDefaultSpecifier: [ "local" ], ImportExpression: [ "source" ], ImportNamespaceSpecifier: [ "local" ], ImportSpecifier: [ "imported", "local" ], JSXAttribute: [ "name", "value" ], JSXClosingElement: [ "name" ], JSXElement: [ "openingElement", "children", "closingElement" ], JSXEmptyExpression: [], JSXExpressionContainer: [ "expression" ], JSXIdentifier: [], JSXMemberExpression: [ "object", "property" ], JSXNamespacedName: [ "namespace", "name" ], JSXOpeningElement: [ "name", "attributes" ], JSXSpreadAttribute: [ "argument" ], JSXText: [], JSXFragment: [ "openingFragment", "children", "closingFragment" ], JSXClosingFragment: [], JSXOpeningFragment: [], Literal: [], LabeledStatement: [ "label", "body" ], LogicalExpression: [ "left", "right" ], MemberExpression: [ "object", "property" ], MetaProperty: [ "meta", "property" ], MethodDefinition: [ "key", "value" ], NewExpression: [ "callee", "arguments" ], ObjectExpression: [ "properties" ], ObjectPattern: [ "properties" ], PrivateIdentifier: [], Program: [ "body" ], Property: [ "key", "value" ], PropertyDefinition: [ "key", "value" ], RestElement: [ "argument" ], ReturnStatement: [ "argument" ], SequenceExpression: [ "expressions" ], SpreadElement: [ "argument" ], StaticBlock: [ "body" ], Super: [], SwitchStatement: [ "discriminant", "cases" ], SwitchCase: [ "test", "consequent" ], TaggedTemplateExpression: [ "tag", "quasi" ], TemplateElement: [], TemplateLiteral: [ "quasis", "expressions" ], ThisExpression: [], ThrowStatement: [ "argument" ], TryStatement: [ "block", "handler", "finalizer" ], UnaryExpression: [ "argument" ], UpdateExpression: [ "argument" ], VariableDeclaration: [ "declarations" ], VariableDeclarator: [ "id", "init" ], WhileStatement: [ "test", "body" ], WithStatement: [ "object", "body" ], YieldExpression: [ "argument" ] }; // Types. const NODE_TYPES = Object.keys(KEYS); // Freeze the keys. for (const type of NODE_TYPES) { Object.freeze(KEYS[type]); } Object.freeze(KEYS); export default KEYS; eslint-visitor-keys-3.3.0/package.json000066400000000000000000000035451420155660200177570ustar00rootroot00000000000000{ "name": "eslint-visitor-keys", "version": "3.3.0", "description": "Constants and utilities about visitor keys to traverse AST.", "type": "module", "main": "dist/eslint-visitor-keys.cjs", "types": "./dist/index.d.ts", "exports": { ".": [ { "import": "./lib/index.js", "require": "./dist/eslint-visitor-keys.cjs" }, "./dist/eslint-visitor-keys.cjs" ], "./package.json": "./package.json" }, "files": [ "dist/index.d.ts", "dist/visitor-keys.d.ts", "dist/eslint-visitor-keys.cjs", "lib" ], "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, "devDependencies": { "c8": "^7.7.3", "eslint": "^7.29.0", "eslint-config-eslint": "^7.0.0", "eslint-plugin-jsdoc": "^35.4.0", "eslint-plugin-node": "^11.1.0", "eslint-release": "^3.2.0", "mocha": "^9.0.1", "opener": "^1.5.2", "rollup": "^2.52.1", "tsd": "^0.19.1", "typescript": "^4.5.5" }, "scripts": { "prepare": "npm run build", "build": "rollup -c && npm run tsc", "lint": "eslint .", "tsc": "tsc", "tsd": "tsd", "test": "mocha tests/lib/**/*.cjs && c8 mocha tests/lib/**/*.js && npm run tsd", "coverage": "c8 report --reporter lcov && opener coverage/lcov-report/index.html", "generate-release": "eslint-generate-release", "generate-alpharelease": "eslint-generate-prerelease alpha", "generate-betarelease": "eslint-generate-prerelease beta", "generate-rcrelease": "eslint-generate-prerelease rc", "publish-release": "eslint-publish-release" }, "repository": "eslint/eslint-visitor-keys", "keywords": [], "author": "Toru Nagashima (https://github.com/mysticatea)", "license": "Apache-2.0", "bugs": { "url": "https://github.com/eslint/eslint-visitor-keys/issues" }, "homepage": "https://github.com/eslint/eslint-visitor-keys#readme" } eslint-visitor-keys-3.3.0/rollup.config.js000066400000000000000000000002701420155660200206000ustar00rootroot00000000000000export default { input: "./lib/index.js", treeshake: false, output: { format: "cjs", file: "dist/eslint-visitor-keys.cjs", sourcemap: true } }; eslint-visitor-keys-3.3.0/test-d/000077500000000000000000000000001420155660200166625ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/test-d/index.test-d.ts000066400000000000000000000022411420155660200215370ustar00rootroot00000000000000import { expectType, expectAssignable, expectError } from 'tsd'; import { KEYS, getKeys, unionWith, VisitorKeys } from "../"; const assignmentExpression = { type: "AssignmentExpression", operator: "=", left: { type: "Identifier", name: "a", range: [ 0, 1 ] }, right: { type: "Literal", value: 5, raw: "5", range: [ 4, 5 ] }, range: [ 0, 5 ] }; expectType<{readonly [type: string]: readonly string[]}>(KEYS); expectType(getKeys(assignmentExpression)); expectType<{readonly [type: string]: readonly string[]}>(unionWith({ TestInterface1: ["left", "right"], TestInterface2: ["expression"] })); const readonlyKeys: { readonly [type: string]: readonly string[] } = { TestInterface1: ["left", "right"] }; expectAssignable(readonlyKeys); // https://github.com/SamVerschueren/tsd/issues/143 // expectError(() => { // const erring: VisitorKeys = { // TestInterface1: ["left", "right"] // }; // erring.TestInterface1 = ["badAttemptOverwrite"]; // }); eslint-visitor-keys-3.3.0/tests/000077500000000000000000000000001420155660200166245ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/tests/lib/000077500000000000000000000000001420155660200173725ustar00rootroot00000000000000eslint-visitor-keys-3.3.0/tests/lib/.eslintrc.json000066400000000000000000000000551420155660200221660ustar00rootroot00000000000000{ "env": { "mocha": true } } eslint-visitor-keys-3.3.0/tests/lib/commonjs.cjs000066400000000000000000000036521420155660200217260ustar00rootroot00000000000000/** * @fileoverview Tests for checking that the commonjs entry points are still accessible * @author Mike Reinstein */ // eslint-disable-next-line strict "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ const assert = require("assert"); const eslintVisitorKeys = require("../../dist/eslint-visitor-keys.cjs"); //------------------------------------------------------------------------------ // Tests //------------------------------------------------------------------------------ describe("commonjs", () => { it("is an object", () => { assert.strictEqual(typeof eslintVisitorKeys, "object"); }); it("has exported keys object", () => { assert.strictEqual(typeof eslintVisitorKeys.KEYS, "object"); }); it("has key array with AST type", () => { assert.ok(Array.isArray(eslintVisitorKeys.KEYS.ArrayExpression)); }); it("has getKeys function", () => { assert.strictEqual(typeof eslintVisitorKeys.getKeys, "function"); }); it("should have getKeys which returns keys", () => { assert.deepStrictEqual(eslintVisitorKeys.getKeys({ a: 1, b: 2 }), ["a", "b"]); }); it("has unionWith function", () => { assert.strictEqual(typeof eslintVisitorKeys.unionWith, "function"); }); it("should have unionWith which includes all additional keys", () => { const additionalKeys = { Program: ["body", "a"], AssignmentExpression: ["b"], additional: ["c"], MethodDefinition: ["a", "key", "b"] }; const unionKeys = eslintVisitorKeys.unionWith(additionalKeys); for (const type of Object.keys(additionalKeys)) { for (const key of additionalKeys[type]) { assert(unionKeys[type].indexOf(key) !== -1, `'${key}' should be included in '${type}'.`); } } }); }); eslint-visitor-keys-3.3.0/tests/lib/index.js000066400000000000000000000047601420155660200210460ustar00rootroot00000000000000/** * @author Toru Nagashima * See LICENSE file in root directory for full license. */ import assert from "assert"; import * as evk from "../../lib/index.js"; import keys from "../../lib/visitor-keys.js"; describe("eslint-visitor-keys", () => { describe("KEYS", () => { it("should be same as lib/visitor-keys.js", () => { assert.deepStrictEqual(evk.KEYS, keys); }); }); describe("getKeys()", () => { it("should return keys", () => { assert.deepStrictEqual(evk.getKeys({ a: 1, b: 2 }), ["a", "b"]); }); it("should not include 'parent' in the result", () => { assert.deepStrictEqual(evk.getKeys({ a: 1, b: 2, parent: 3 }), ["a", "b"]); }); it("should not include 'leadingComments' in the result", () => { assert.deepStrictEqual(evk.getKeys({ a: 1, b: 2, leadingComments: 3 }), ["a", "b"]); }); it("should not include 'trailingComments' in the result", () => { assert.deepStrictEqual(evk.getKeys({ a: 1, b: 2, trailingComments: 3 }), ["a", "b"]); }); it("should not include '_foo' in the result", () => { assert.deepStrictEqual(evk.getKeys({ a: 1, b: 2, _foo: 3 }), ["a", "b"]); }); }); describe("unionWith()", () => { const additionalKeys = { Program: ["body", "a"], AssignmentExpression: ["b"], additional: ["c"], MethodDefinition: ["a", "key", "b"] }; const unionKeys = evk.unionWith(additionalKeys); it("should include all keys of lib/visitor-keys.js", () => { for (const type of Object.keys(keys)) { for (const key of keys[type]) { assert(unionKeys[type].indexOf(key) !== -1, `'${key}' should be included in '${type}'.`); } } }); it("should include all additional keys", () => { for (const type of Object.keys(additionalKeys)) { for (const key of additionalKeys[type]) { assert(unionKeys[type].indexOf(key) !== -1, `'${key}' should be included in '${type}'.`); } } }); it("should not have duplicate", () => { assert(unionKeys.Program.filter(key => key === "body").length === 1); }); it("should add additional keys, then concatenate original keys", () => { assert.deepStrictEqual(unionKeys.MethodDefinition, ["a", "key", "b", "value"]); }); }); }); eslint-visitor-keys-3.3.0/tsconfig.json000066400000000000000000000006351420155660200201750ustar00rootroot00000000000000{ "compilerOptions": { "lib": ["es2020"], "moduleResolution": "node", "module": "esnext", "resolveJsonModule": true, "allowJs": true, "checkJs": true, "noEmit": false, "declaration": true, "declarationMap": true, "emitDeclarationOnly": true, "strict": true, "target": "es6", "outDir": "dist" }, "include": ["lib/**/*.js"], "exclude": ["node_modules"] }