Blame view

node_modules/eslint-visitor-keys/README.md 2.71 KB
ce4c83ff   wxy   εˆε§‹ζδΊ€
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
  # 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] 4.0.0 or later.
  
  ## πŸ“– Usage
  
  ```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:
  
  ```
  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](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/en/
  [ESTree]: https://github.com/estree/estree