routie dev init since i didn't adhere to any proper guidance up until now
This commit is contained in:
+21
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Yosuke Ota
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
+148
@@ -0,0 +1,148 @@
|
||||
# yaml-eslint-parser
|
||||
|
||||
A YAML parser that produces output [compatible with ESLint](https://eslint.org/docs/developer-guide/working-with-custom-parsers#all-nodes).
|
||||
|
||||
_This parser is backed by excellent [yaml](https://github.com/eemeli/yaml) package and it is heavily inspired by [yaml-unist-parser](https://github.com/ikatyang/yaml-unist-parser) package._
|
||||
|
||||
[](https://www.npmjs.com/package/yaml-eslint-parser)
|
||||
[](https://www.npmjs.com/package/yaml-eslint-parser)
|
||||
[](http://www.npmtrends.com/yaml-eslint-parser)
|
||||
[](http://www.npmtrends.com/yaml-eslint-parser)
|
||||
[](http://www.npmtrends.com/yaml-eslint-parser)
|
||||
[](http://www.npmtrends.com/yaml-eslint-parser)
|
||||
[](http://www.npmtrends.com/yaml-eslint-parser)
|
||||
[](https://github.com/ota-meshi/yaml-eslint-parser/actions?query=workflow%3ACI)
|
||||
[](https://coveralls.io/github/ota-meshi/yaml-eslint-parser?branch=master)
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install --save-dev yaml-eslint-parser
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Configuration
|
||||
|
||||
Use `eslint.config.js` file to configure parser (ESLint v9+). See also: [https://eslint.org/docs/latest/use/configure/](https://eslint.org/docs/latest/use/configure/).
|
||||
|
||||
Example **eslint.config.js**:
|
||||
|
||||
```js
|
||||
import * as yamlParser from "yaml-eslint-parser";
|
||||
|
||||
export default [
|
||||
{
|
||||
files: ["*.yaml", "*.yml"],
|
||||
languageOptions: {
|
||||
parser: yamlParser,
|
||||
},
|
||||
},
|
||||
];
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>For ESLint v8 and earlier (.eslintrc.js)</summary>
|
||||
|
||||
```js
|
||||
module.exports = {
|
||||
overrides: [
|
||||
{
|
||||
files: ["*.yaml", "*.yml"],
|
||||
parser: "yaml-eslint-parser",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Advanced Configuration
|
||||
|
||||
The following additional configuration options are available by specifying them in [parserOptions](https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options) in your ESLint configuration file.
|
||||
|
||||
Example **eslint.config.js**:
|
||||
|
||||
```js
|
||||
import * as yamlParser from "yaml-eslint-parser";
|
||||
|
||||
export default [
|
||||
{
|
||||
files: ["*.yaml", "*.yml"],
|
||||
languageOptions: {
|
||||
parser: yamlParser,
|
||||
// Additional configuration options
|
||||
parserOptions: {
|
||||
defaultYAMLVersion: "1.2",
|
||||
},
|
||||
},
|
||||
},
|
||||
];
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>For ESLint v8 and earlier (.eslintrc.js)</summary>
|
||||
|
||||
```js
|
||||
module.exports = {
|
||||
overrides: [
|
||||
{
|
||||
files: ["*.yaml", "*.yml"],
|
||||
parser: "yaml-eslint-parser",
|
||||
// Additional configuration options
|
||||
parserOptions: {
|
||||
defaultYAMLVersion: "1.2",
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### `parserOptions.defaultYAMLVersion`
|
||||
|
||||
Set to `"1.2"` or `"1.1"`. Select the YAML version used by documents without a `%YAML` directive.
|
||||
If not specified, the [yaml](https://eemeli.org/yaml/)'s default `version` option (`"1.2"`) is used.
|
||||
See <https://eemeli.org/yaml/#document-options> for details.
|
||||
|
||||
## Usage for Custom Rules / Plugins
|
||||
|
||||
- [AST.md](./docs/AST.md) is AST specification.
|
||||
- [block-mapping.ts](https://github.com/ota-meshi/eslint-plugin-yml/blob/master/src/rules/block-mapping.ts) is an example.
|
||||
- You can see the AST on the [Online DEMO](https://ota-meshi.github.io/yaml-eslint-parser/).
|
||||
|
||||
## Usage for Directly
|
||||
|
||||
Example:
|
||||
|
||||
```ts
|
||||
import type { AST } from "yaml-eslint-parser";
|
||||
import { parseYAML, getStaticYAMLValue } from "yaml-eslint-parser";
|
||||
|
||||
const code = `
|
||||
american:
|
||||
- Boston Red Sox
|
||||
- Detroit Tigers
|
||||
- New York Yankees
|
||||
national:
|
||||
- New York Mets
|
||||
- Chicago Cubs
|
||||
- Atlanta Braves
|
||||
`;
|
||||
|
||||
const ast: AST.YAMLProgram = parseYAML(code);
|
||||
console.log(ast);
|
||||
|
||||
const value = getStaticYAMLValue(ast);
|
||||
console.log(value);
|
||||
```
|
||||
|
||||
## Related Packages
|
||||
|
||||
- [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5.
|
||||
- [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) ... ESLint plugin for YAML.
|
||||
- [eslint-plugin-toml](https://github.com/ota-meshi/eslint-plugin-toml) ... ESLint plugin for TOML.
|
||||
- [eslint-plugin-json-schema-validator](https://github.com/ota-meshi/eslint-plugin-json-schema-validator) ... ESLint plugin that validates data using JSON Schema Validator.
|
||||
- [jsonc-eslint-parser](https://github.com/ota-meshi/jsonc-eslint-parser) ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
|
||||
- [toml-eslint-parser](https://github.com/ota-meshi/toml-eslint-parser) ... TOML parser for use with ESLint plugins.
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
//#region rolldown:runtime
|
||||
var __defProp = Object.defineProperty;
|
||||
var __exportAll = (all, symbols) => {
|
||||
let target = {};
|
||||
for (var name in all) {
|
||||
__defProp(target, name, {
|
||||
get: all[name],
|
||||
enumerable: true
|
||||
});
|
||||
}
|
||||
if (symbols) {
|
||||
__defProp(target, Symbol.toStringTag, { value: "Module" });
|
||||
}
|
||||
return target;
|
||||
};
|
||||
|
||||
//#endregion
|
||||
export { __exportAll as t };
|
||||
+224
@@ -0,0 +1,224 @@
|
||||
import { DocumentOptions } from "yaml";
|
||||
import { VisitorKeys as VisitorKeys$1 } from "eslint-visitor-keys";
|
||||
import { SourceCode } from "eslint";
|
||||
|
||||
//#region src/utils.d.ts
|
||||
type YAMLVersion = NonNullable<DocumentOptions["version"]>;
|
||||
type YAMLContentValue = string | number | boolean | null | YAMLContentValue[] | YAMLMappingValue;
|
||||
type YAMLMappingValue = {
|
||||
[key: string]: YAMLContentValue;
|
||||
[key: number]: YAMLContentValue;
|
||||
};
|
||||
declare function getStaticYAMLValue(node: YAMLMapping | YAMLPair): YAMLMappingValue;
|
||||
declare function getStaticYAMLValue(node: YAMLSequence): YAMLContentValue[];
|
||||
declare function getStaticYAMLValue(node: YAMLScalar): string | number | boolean | null;
|
||||
declare function getStaticYAMLValue(node: YAMLAlias | YAMLProgram | YAMLDocument | YAMLContent | YAMLPair | YAMLWithMeta): YAMLContentValue;
|
||||
declare namespace ast_d_exports {
|
||||
export { Comment, Locations, Position, Range, SourceLocation, Token, YAMLAlias, YAMLAnchor, YAMLBlockFoldedScalar, YAMLBlockLiteralScalar, YAMLBlockMapping, YAMLBlockSequence, YAMLContent, YAMLDirective, YAMLDirectiveForTAG, YAMLDirectiveForUnknown, YAMLDirectiveForYAML, YAMLDocument, YAMLDoubleQuotedScalar, YAMLFlowMapping, YAMLFlowSequence, YAMLMapping, YAMLNode, YAMLPair, YAMLPlainScalar, YAMLProgram, YAMLScalar, YAMLSequence, YAMLSingleQuotedScalar, YAMLTag, YAMLWithMeta };
|
||||
}
|
||||
type Range = [number, number];
|
||||
interface Locations {
|
||||
loc: SourceLocation;
|
||||
range: Range;
|
||||
}
|
||||
interface BaseYAMLNode extends Locations {
|
||||
type: string;
|
||||
}
|
||||
interface SourceLocation {
|
||||
start: Position;
|
||||
end: Position;
|
||||
}
|
||||
interface Token extends BaseYAMLNode {
|
||||
type: "Directive" | "Marker" | "Punctuator" | "Identifier" | "String" | "Boolean" | "Numeric" | "Null" | "BlockLiteral" | "BlockFolded";
|
||||
value: string;
|
||||
}
|
||||
interface Comment extends BaseYAMLNode {
|
||||
type: "Line" | "Block";
|
||||
value: string;
|
||||
}
|
||||
interface Position {
|
||||
/** >= 1 */
|
||||
line: number;
|
||||
/** >= 0 */
|
||||
column: number;
|
||||
}
|
||||
type YAMLNode = YAMLProgram | YAMLDocument | YAMLDirective | YAMLContent | YAMLPair | YAMLWithMeta | YAMLAnchor | YAMLTag;
|
||||
interface YAMLProgram extends BaseYAMLNode {
|
||||
type: "Program";
|
||||
body: YAMLDocument[];
|
||||
sourceType: "module";
|
||||
comments: Comment[];
|
||||
tokens: Token[];
|
||||
parent: null;
|
||||
}
|
||||
interface YAMLDocument extends BaseYAMLNode {
|
||||
type: "YAMLDocument";
|
||||
directives: YAMLDirective[];
|
||||
content: YAMLContent | YAMLWithMeta | null;
|
||||
parent: YAMLProgram;
|
||||
anchors: {
|
||||
[key: string]: YAMLAnchor[];
|
||||
};
|
||||
version: YAMLVersion;
|
||||
}
|
||||
interface BaseYAMLDirective extends BaseYAMLNode {
|
||||
type: "YAMLDirective";
|
||||
value: string;
|
||||
kind: "YAML" | "TAG" | null;
|
||||
parent: YAMLDocument;
|
||||
}
|
||||
interface YAMLDirectiveForYAML extends BaseYAMLDirective {
|
||||
kind: "YAML";
|
||||
version: string;
|
||||
}
|
||||
interface YAMLDirectiveForTAG extends BaseYAMLDirective {
|
||||
kind: "TAG";
|
||||
handle: string;
|
||||
prefix: string;
|
||||
}
|
||||
interface YAMLDirectiveForUnknown extends BaseYAMLDirective {
|
||||
kind: null;
|
||||
}
|
||||
type YAMLDirective = YAMLDirectiveForYAML | YAMLDirectiveForTAG | YAMLDirectiveForUnknown;
|
||||
interface YAMLWithMeta extends BaseYAMLNode {
|
||||
type: "YAMLWithMeta";
|
||||
anchor: YAMLAnchor | null;
|
||||
tag: YAMLTag | null;
|
||||
value: Exclude<YAMLContent, YAMLAlias> | null;
|
||||
parent: YAMLDocument | YAMLPair | YAMLSequence;
|
||||
}
|
||||
interface YAMLAnchor extends BaseYAMLNode {
|
||||
type: "YAMLAnchor";
|
||||
name: string;
|
||||
parent: YAMLWithMeta;
|
||||
}
|
||||
interface YAMLTag extends BaseYAMLNode {
|
||||
type: "YAMLTag";
|
||||
tag: string;
|
||||
raw: string;
|
||||
parent: YAMLWithMeta;
|
||||
}
|
||||
interface BaseYAMLContentNode extends BaseYAMLNode {
|
||||
parent: YAMLDocument | YAMLPair | YAMLSequence | YAMLWithMeta;
|
||||
}
|
||||
type YAMLContent = YAMLMapping | YAMLSequence | YAMLScalar | YAMLAlias;
|
||||
type YAMLMapping = YAMLBlockMapping | YAMLFlowMapping;
|
||||
interface YAMLBlockMapping extends BaseYAMLContentNode {
|
||||
type: "YAMLMapping";
|
||||
style: "block";
|
||||
pairs: YAMLPair[];
|
||||
}
|
||||
interface YAMLFlowMapping extends BaseYAMLContentNode {
|
||||
type: "YAMLMapping";
|
||||
style: "flow";
|
||||
pairs: YAMLPair[];
|
||||
}
|
||||
interface YAMLPair extends BaseYAMLNode {
|
||||
type: "YAMLPair";
|
||||
key: YAMLContent | YAMLWithMeta | null;
|
||||
value: YAMLContent | YAMLWithMeta | null;
|
||||
parent: YAMLMapping;
|
||||
}
|
||||
type YAMLSequence = YAMLBlockSequence | YAMLFlowSequence;
|
||||
interface YAMLBlockSequence extends BaseYAMLContentNode {
|
||||
type: "YAMLSequence";
|
||||
style: "block";
|
||||
entries: (YAMLContent | YAMLWithMeta | null)[];
|
||||
}
|
||||
interface YAMLFlowSequence extends BaseYAMLContentNode {
|
||||
type: "YAMLSequence";
|
||||
style: "flow";
|
||||
entries: (YAMLContent | YAMLWithMeta)[];
|
||||
}
|
||||
type YAMLScalar = YAMLPlainScalar | YAMLDoubleQuotedScalar | YAMLSingleQuotedScalar | YAMLBlockLiteralScalar | YAMLBlockFoldedScalar;
|
||||
interface YAMLPlainScalar extends BaseYAMLContentNode {
|
||||
type: "YAMLScalar";
|
||||
style: "plain";
|
||||
strValue: string;
|
||||
value: string | number | boolean | null;
|
||||
raw: string;
|
||||
}
|
||||
interface YAMLDoubleQuotedScalar extends BaseYAMLContentNode {
|
||||
type: "YAMLScalar";
|
||||
style: "double-quoted";
|
||||
strValue: string;
|
||||
value: string;
|
||||
raw: string;
|
||||
}
|
||||
interface YAMLSingleQuotedScalar extends BaseYAMLContentNode {
|
||||
type: "YAMLScalar";
|
||||
style: "single-quoted";
|
||||
strValue: string;
|
||||
value: string;
|
||||
raw: string;
|
||||
}
|
||||
interface YAMLBlockLiteralScalar extends BaseYAMLContentNode {
|
||||
type: "YAMLScalar";
|
||||
style: "literal";
|
||||
chomping: "clip" | "keep" | "strip";
|
||||
indent: null | number;
|
||||
value: string;
|
||||
}
|
||||
interface YAMLBlockFoldedScalar extends BaseYAMLContentNode {
|
||||
type: "YAMLScalar";
|
||||
style: "folded";
|
||||
chomping: "clip" | "keep" | "strip";
|
||||
indent: null | number;
|
||||
value: string;
|
||||
}
|
||||
interface YAMLAlias extends BaseYAMLContentNode {
|
||||
type: "YAMLAlias";
|
||||
name: string;
|
||||
}
|
||||
//#endregion
|
||||
//#region src/parser.d.ts
|
||||
/**
|
||||
* Parse YAML source code
|
||||
*/
|
||||
declare function parseYAML(code: string, options?: any): YAMLProgram;
|
||||
//#endregion
|
||||
//#region src/traverse.d.ts
|
||||
interface Visitor<N> {
|
||||
visitorKeys?: VisitorKeys$1;
|
||||
enterNode(node: N, parent: N | null): void;
|
||||
leaveNode(node: N, parent: N | null): void;
|
||||
}
|
||||
declare function traverseNodes(node: YAMLNode, visitor: Visitor<YAMLNode>): void;
|
||||
//#endregion
|
||||
//#region src/errors.d.ts
|
||||
/**
|
||||
* YAML parse errors.
|
||||
*/
|
||||
declare class ParseError extends SyntaxError {
|
||||
index: number;
|
||||
lineNumber: number;
|
||||
column: number;
|
||||
/**
|
||||
* Initialize this ParseError instance.
|
||||
* @param message The error message.
|
||||
* @param offset The offset number of this error.
|
||||
* @param line The line number of this error.
|
||||
* @param column The column number of this error.
|
||||
*/
|
||||
constructor(message: string, offset: number, line: number, column: number);
|
||||
}
|
||||
declare namespace meta_d_exports {
|
||||
export { name, version };
|
||||
}
|
||||
declare const name: "yaml-eslint-parser";
|
||||
declare const version: "2.0.0";
|
||||
//#endregion
|
||||
//#region src/index.d.ts
|
||||
declare const VisitorKeys: SourceCode.VisitorKeys;
|
||||
/**
|
||||
* Parse source code
|
||||
*/
|
||||
declare function parseForESLint(code: string, options?: any): {
|
||||
ast: YAMLProgram;
|
||||
visitorKeys: SourceCode.VisitorKeys;
|
||||
services: {
|
||||
isYAML: boolean;
|
||||
};
|
||||
};
|
||||
//#endregion
|
||||
export { type ast_d_exports as AST, ParseError, VisitorKeys, getStaticYAMLValue, meta_d_exports as meta, name, parseForESLint, parseYAML, traverseNodes };
|
||||
+1604
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+201
@@ -0,0 +1,201 @@
|
||||
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.
|
||||
Generated
Vendored
+123
@@ -0,0 +1,123 @@
|
||||
# eslint-visitor-keys
|
||||
|
||||
[](https://www.npmjs.com/package/eslint-visitor-keys)
|
||||
[](http://www.npmtrends.com/eslint-visitor-keys)
|
||||
[](https://github.com/eslint/js/actions)
|
||||
|
||||
Constants and utilities about visitor keys to traverse AST.
|
||||
|
||||
## 💿 Installation
|
||||
|
||||
Use [npm] to install.
|
||||
|
||||
```bash
|
||||
$ npm install eslint-visitor-keys
|
||||
```
|
||||
|
||||
### Requirements
|
||||
|
||||
- [Node.js] `^20.19.0`, `^22.13.0`, or `>=24`
|
||||
|
||||
## 📖 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/js/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 test:open-coverage` opens the code coverage report of the previous test with your default browser.
|
||||
|
||||
[npm]: https://www.npmjs.com/
|
||||
[Node.js]: https://nodejs.org/
|
||||
[ESTree]: https://github.com/estree/estree
|
||||
|
||||
<!-- NOTE: This section is autogenerated. Do not manually edit.-->
|
||||
<!--sponsorsstart-->
|
||||
|
||||
## Sponsors
|
||||
|
||||
The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://eslint.org/donate)
|
||||
to get your logo on our READMEs and [website](https://eslint.org/sponsors).
|
||||
|
||||
<h3>Platinum Sponsors</h3>
|
||||
<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a></p><h3>Gold Sponsors</h3>
|
||||
<p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a></p><h3>Silver Sponsors</h3>
|
||||
<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/d472863/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/2d6c3b6/logo.png" alt="Liftoff" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
|
||||
<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://opensource.sap.com"><img src="https://avatars.githubusercontent.com/u/2531208" alt="SAP" height="32"></a> <a href="https://www.crawljobs.com/"><img src="https://images.opencollective.com/crawljobs-poland/fa43a17/logo.png" alt="CrawlJobs" height="32"></a> <a href="https://depot.dev"><img src="https://images.opencollective.com/depot/39125a1/logo.png" alt="Depot" height="32"></a> <a href="https://www.n-ix.com/"><img src="https://images.opencollective.com/n-ix-ltd/575a7a5/logo.png" alt="N-iX Ltd" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a> <a href="https://www.lambdatest.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="TestMu AI Open Source Office (Formerly LambdaTest)" height="32"></a></p>
|
||||
<h3>Technology Sponsors</h3>
|
||||
Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.
|
||||
<p><a href="https://netlify.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/netlify-icon.svg" alt="Netlify" height="32"></a> <a href="https://algolia.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/algolia-icon.svg" alt="Algolia" height="32"></a> <a href="https://1password.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/1password-icon.svg" alt="1Password" height="32"></a></p>
|
||||
<!--sponsorsend-->
|
||||
Generated
Vendored
+187
@@ -0,0 +1,187 @@
|
||||
'use strict';
|
||||
|
||||
/* eslint-disable jsdoc/valid-types -- doesn't allow `readonly`.
|
||||
TODO: remove eslint-disable when https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/164 is fixed
|
||||
*/
|
||||
/**
|
||||
* @typedef {{ readonly [type: string]: ReadonlyArray<string> }} VisitorKeys
|
||||
*/
|
||||
/* eslint-enable jsdoc/valid-types -- doesn't allow `readonly string[]`. TODO: check why */
|
||||
|
||||
/**
|
||||
* @type {VisitorKeys}
|
||||
*/
|
||||
const KEYS = {
|
||||
ArrayExpression: ["elements"],
|
||||
ArrayPattern: ["elements"],
|
||||
ArrowFunctionExpression: ["params", "body"],
|
||||
AssignmentExpression: ["left", "right"],
|
||||
AssignmentPattern: ["left", "right"],
|
||||
AwaitExpression: ["argument"],
|
||||
BinaryExpression: ["left", "right"],
|
||||
BlockStatement: ["body"],
|
||||
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: [],
|
||||
ExperimentalRestProperty: ["argument"],
|
||||
ExperimentalSpreadProperty: ["argument"],
|
||||
ExportAllDeclaration: ["exported", "source", "attributes"],
|
||||
ExportDefaultDeclaration: ["declaration"],
|
||||
ExportNamedDeclaration: [
|
||||
"declaration",
|
||||
"specifiers",
|
||||
"source",
|
||||
"attributes",
|
||||
],
|
||||
ExportSpecifier: ["local", "exported"],
|
||||
ExpressionStatement: ["expression"],
|
||||
ForInStatement: ["left", "right", "body"],
|
||||
ForOfStatement: ["left", "right", "body"],
|
||||
ForStatement: ["init", "test", "update", "body"],
|
||||
FunctionDeclaration: ["id", "params", "body"],
|
||||
FunctionExpression: ["id", "params", "body"],
|
||||
Identifier: [],
|
||||
IfStatement: ["test", "consequent", "alternate"],
|
||||
ImportAttribute: ["key", "value"],
|
||||
ImportDeclaration: ["specifiers", "source", "attributes"],
|
||||
ImportDefaultSpecifier: ["local"],
|
||||
ImportExpression: ["source", "options"],
|
||||
ImportNamespaceSpecifier: ["local"],
|
||||
ImportSpecifier: ["imported", "local"],
|
||||
JSXAttribute: ["name", "value"],
|
||||
JSXClosingElement: ["name"],
|
||||
JSXClosingFragment: [],
|
||||
JSXElement: ["openingElement", "children", "closingElement"],
|
||||
JSXEmptyExpression: [],
|
||||
JSXExpressionContainer: ["expression"],
|
||||
JSXFragment: ["openingFragment", "children", "closingFragment"],
|
||||
JSXIdentifier: [],
|
||||
JSXMemberExpression: ["object", "property"],
|
||||
JSXNamespacedName: ["namespace", "name"],
|
||||
JSXOpeningElement: ["name", "attributes"],
|
||||
JSXOpeningFragment: [],
|
||||
JSXSpreadAttribute: ["argument"],
|
||||
JSXSpreadChild: ["expression"],
|
||||
JSXText: [],
|
||||
LabeledStatement: ["label", "body"],
|
||||
Literal: [],
|
||||
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: [],
|
||||
SwitchCase: ["test", "consequent"],
|
||||
SwitchStatement: ["discriminant", "cases"],
|
||||
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);
|
||||
|
||||
/**
|
||||
* @author Toru Nagashima <https://github.com/mysticatea>
|
||||
* See LICENSE file in root directory for full license.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef {import('./visitor-keys.js').VisitorKeys} 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] !== "_";
|
||||
}
|
||||
|
||||
/* eslint-disable jsdoc/valid-types -- doesn't allow `readonly`.
|
||||
TODO: remove eslint-disable when https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/164 is fixed
|
||||
*/
|
||||
/**
|
||||
* Get visitor keys of a given node.
|
||||
* @param {Object} node The AST node to get keys.
|
||||
* @returns {readonly string[]} Visitor keys of the node.
|
||||
*/
|
||||
function getKeys(node) {
|
||||
return Object.keys(node).filter(filterKey);
|
||||
}
|
||||
/* eslint-enable jsdoc/valid-types -- doesn't allow `readonly` */
|
||||
|
||||
/**
|
||||
* Make the union set with `KEYS` and given keys.
|
||||
* @param {VisitorKeys} additionalKeys The additional keys.
|
||||
* @returns {VisitorKeys} The union set.
|
||||
*/
|
||||
function unionWith(additionalKeys) {
|
||||
const retv =
|
||||
/** @type {{ [type: string]: ReadonlyArray<string> }} */
|
||||
(Object.assign({}, KEYS));
|
||||
|
||||
for (const type of Object.keys(additionalKeys)) {
|
||||
if (Object.hasOwn(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);
|
||||
}
|
||||
|
||||
exports.KEYS = KEYS;
|
||||
exports.getKeys = getKeys;
|
||||
exports.unionWith = unionWith;
|
||||
Generated
Vendored
+28
@@ -0,0 +1,28 @@
|
||||
type VisitorKeys$1 = {
|
||||
readonly [type: string]: ReadonlyArray<string>;
|
||||
};
|
||||
/**
|
||||
* @typedef {{ readonly [type: string]: ReadonlyArray<string> }} VisitorKeys
|
||||
*/
|
||||
/**
|
||||
* @type {VisitorKeys}
|
||||
*/
|
||||
declare const KEYS: VisitorKeys$1;
|
||||
|
||||
/**
|
||||
* Get visitor keys of a given node.
|
||||
* @param {Object} node The AST node to get keys.
|
||||
* @returns {readonly string[]} Visitor keys of the node.
|
||||
*/
|
||||
declare function getKeys(node: Object): readonly string[];
|
||||
/**
|
||||
* Make the union set with `KEYS` and given keys.
|
||||
* @param {VisitorKeys} additionalKeys The additional keys.
|
||||
* @returns {VisitorKeys} The union set.
|
||||
*/
|
||||
declare function unionWith(additionalKeys: VisitorKeys): VisitorKeys;
|
||||
|
||||
type VisitorKeys = VisitorKeys$1;
|
||||
|
||||
export { KEYS, getKeys, unionWith };
|
||||
export type { VisitorKeys };
|
||||
Generated
Vendored
+16
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* 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: Object): readonly string[];
|
||||
/**
|
||||
* Make the union set with `KEYS` and given keys.
|
||||
* @param {VisitorKeys} additionalKeys The additional keys.
|
||||
* @returns {VisitorKeys} The union set.
|
||||
*/
|
||||
export function unionWith(additionalKeys: VisitorKeys): VisitorKeys;
|
||||
export { KEYS };
|
||||
export type VisitorKeys = import("./visitor-keys.js").VisitorKeys;
|
||||
import KEYS from "./visitor-keys.js";
|
||||
//# sourceMappingURL=index.d.ts.map
|
||||
Generated
Vendored
+12
@@ -0,0 +1,12 @@
|
||||
export default KEYS;
|
||||
export type VisitorKeys = {
|
||||
readonly [type: string]: ReadonlyArray<string>;
|
||||
};
|
||||
/**
|
||||
* @typedef {{ readonly [type: string]: ReadonlyArray<string> }} VisitorKeys
|
||||
*/
|
||||
/**
|
||||
* @type {VisitorKeys}
|
||||
*/
|
||||
declare const KEYS: VisitorKeys;
|
||||
//# sourceMappingURL=visitor-keys.d.ts.map
|
||||
Generated
Vendored
+67
@@ -0,0 +1,67 @@
|
||||
/**
|
||||
* @author Toru Nagashima <https://github.com/mysticatea>
|
||||
* See LICENSE file in root directory for full license.
|
||||
*/
|
||||
import KEYS from "./visitor-keys.js";
|
||||
|
||||
/**
|
||||
* @typedef {import('./visitor-keys.js').VisitorKeys} 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] !== "_";
|
||||
}
|
||||
|
||||
/* eslint-disable jsdoc/valid-types -- doesn't allow `readonly`.
|
||||
TODO: remove eslint-disable when https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/164 is fixed
|
||||
*/
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
/* eslint-enable jsdoc/valid-types -- doesn't allow `readonly` */
|
||||
|
||||
/**
|
||||
* 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<string> }} */
|
||||
(Object.assign({}, KEYS));
|
||||
|
||||
for (const type of Object.keys(additionalKeys)) {
|
||||
if (Object.hasOwn(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 };
|
||||
Generated
Vendored
+118
@@ -0,0 +1,118 @@
|
||||
/* eslint-disable jsdoc/valid-types -- doesn't allow `readonly`.
|
||||
TODO: remove eslint-disable when https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/164 is fixed
|
||||
*/
|
||||
/**
|
||||
* @typedef {{ readonly [type: string]: ReadonlyArray<string> }} VisitorKeys
|
||||
*/
|
||||
/* eslint-enable jsdoc/valid-types -- doesn't allow `readonly string[]`. TODO: check why */
|
||||
|
||||
/**
|
||||
* @type {VisitorKeys}
|
||||
*/
|
||||
const KEYS = {
|
||||
ArrayExpression: ["elements"],
|
||||
ArrayPattern: ["elements"],
|
||||
ArrowFunctionExpression: ["params", "body"],
|
||||
AssignmentExpression: ["left", "right"],
|
||||
AssignmentPattern: ["left", "right"],
|
||||
AwaitExpression: ["argument"],
|
||||
BinaryExpression: ["left", "right"],
|
||||
BlockStatement: ["body"],
|
||||
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: [],
|
||||
ExperimentalRestProperty: ["argument"],
|
||||
ExperimentalSpreadProperty: ["argument"],
|
||||
ExportAllDeclaration: ["exported", "source", "attributes"],
|
||||
ExportDefaultDeclaration: ["declaration"],
|
||||
ExportNamedDeclaration: [
|
||||
"declaration",
|
||||
"specifiers",
|
||||
"source",
|
||||
"attributes",
|
||||
],
|
||||
ExportSpecifier: ["local", "exported"],
|
||||
ExpressionStatement: ["expression"],
|
||||
ForInStatement: ["left", "right", "body"],
|
||||
ForOfStatement: ["left", "right", "body"],
|
||||
ForStatement: ["init", "test", "update", "body"],
|
||||
FunctionDeclaration: ["id", "params", "body"],
|
||||
FunctionExpression: ["id", "params", "body"],
|
||||
Identifier: [],
|
||||
IfStatement: ["test", "consequent", "alternate"],
|
||||
ImportAttribute: ["key", "value"],
|
||||
ImportDeclaration: ["specifiers", "source", "attributes"],
|
||||
ImportDefaultSpecifier: ["local"],
|
||||
ImportExpression: ["source", "options"],
|
||||
ImportNamespaceSpecifier: ["local"],
|
||||
ImportSpecifier: ["imported", "local"],
|
||||
JSXAttribute: ["name", "value"],
|
||||
JSXClosingElement: ["name"],
|
||||
JSXClosingFragment: [],
|
||||
JSXElement: ["openingElement", "children", "closingElement"],
|
||||
JSXEmptyExpression: [],
|
||||
JSXExpressionContainer: ["expression"],
|
||||
JSXFragment: ["openingFragment", "children", "closingFragment"],
|
||||
JSXIdentifier: [],
|
||||
JSXMemberExpression: ["object", "property"],
|
||||
JSXNamespacedName: ["namespace", "name"],
|
||||
JSXOpeningElement: ["name", "attributes"],
|
||||
JSXOpeningFragment: [],
|
||||
JSXSpreadAttribute: ["argument"],
|
||||
JSXSpreadChild: ["expression"],
|
||||
JSXText: [],
|
||||
LabeledStatement: ["label", "body"],
|
||||
Literal: [],
|
||||
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: [],
|
||||
SwitchCase: ["test", "consequent"],
|
||||
SwitchStatement: ["discriminant", "cases"],
|
||||
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;
|
||||
Generated
Vendored
+57
@@ -0,0 +1,57 @@
|
||||
{
|
||||
"name": "eslint-visitor-keys",
|
||||
"version": "5.0.1",
|
||||
"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",
|
||||
"dist/eslint-visitor-keys.d.cts",
|
||||
"lib"
|
||||
],
|
||||
"engines": {
|
||||
"node": "^20.19.0 || ^22.13.0 || >=24"
|
||||
},
|
||||
"devDependencies": {
|
||||
"rollup-plugin-dts": "^6.2.3",
|
||||
"tsd": "^0.33.0"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "npm run build:cjs && npm run build:types",
|
||||
"build:cjs": "rollup -c",
|
||||
"build:debug": "npm run build:cjs -- -m && npm run build:types",
|
||||
"build:types": "tsc -v && tsc",
|
||||
"test": "mocha \"tests/**/*.test.cjs\" && mocha \"tests/**/*.test.js\" && npm run test:types",
|
||||
"test:coverage": "c8 npm test",
|
||||
"test:types": "tsd"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/eslint/js.git",
|
||||
"directory": "packages/eslint-visitor-keys"
|
||||
},
|
||||
"funding": "https://opencollective.com/eslint",
|
||||
"keywords": [
|
||||
"eslint"
|
||||
],
|
||||
"author": "Toru Nagashima (https://github.com/mysticatea)",
|
||||
"license": "Apache-2.0",
|
||||
"bugs": {
|
||||
"url": "https://github.com/eslint/js/issues"
|
||||
},
|
||||
"homepage": "https://github.com/eslint/js/blob/main/packages/eslint-visitor-keys/README.md",
|
||||
"sideEffects": false
|
||||
}
|
||||
+101
@@ -0,0 +1,101 @@
|
||||
{
|
||||
"name": "yaml-eslint-parser",
|
||||
"version": "2.0.0",
|
||||
"description": "A YAML parser that produces output compatible with ESLint",
|
||||
"type": "module",
|
||||
"main": "lib/index.mjs",
|
||||
"types": "lib/index.d.mts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./lib/index.d.mts",
|
||||
"default": "./lib/index.mjs"
|
||||
},
|
||||
"./package.json": "./package.json"
|
||||
},
|
||||
"files": [
|
||||
"lib"
|
||||
],
|
||||
"engines": {
|
||||
"node": "^20.19.0 || ^22.13.0 || >=24"
|
||||
},
|
||||
"scripts": {
|
||||
"prebuild": "npm run -s clean",
|
||||
"build": "npm run build:meta && tsdown",
|
||||
"build:meta": "tsx ./tools/update-meta.ts",
|
||||
"clean": "rimraf .nyc_output lib coverage",
|
||||
"lint": "npm run lint:js && npm run lint:ts",
|
||||
"lint:js": "eslint .",
|
||||
"lint:ts": "tsc --project ./tsconfig.build.json",
|
||||
"eslint-fix": "npm run lint -- --fix",
|
||||
"test": "mocha \"tests/src/**/*.ts\" --reporter dot --timeout 60000",
|
||||
"cover": "nyc --reporter=lcov npm run test",
|
||||
"debug": "mocha \"tests/src/**/*.ts\" --reporter dot",
|
||||
"preversion": "npm run lint && npm test",
|
||||
"update-fixtures": "tsx ./tools/update-fixtures.ts",
|
||||
"benchmark": "tsx benchmark/index.ts",
|
||||
"prerelease": "npm run clean && npm run build",
|
||||
"release": "changeset publish",
|
||||
"version:ci": "env-cmd -e version-ci -- npm run build:meta && changeset version",
|
||||
"strict-type-check": "tsc --project ./tsconfig.build.json --noEmit --module esnext --moduleResolution bundler"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/ota-meshi/yaml-eslint-parser.git"
|
||||
},
|
||||
"keywords": [
|
||||
"yaml",
|
||||
"eslint",
|
||||
"parser"
|
||||
],
|
||||
"author": "Yosuke Ota",
|
||||
"funding": "https://github.com/sponsors/ota-meshi",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/ota-meshi/yaml-eslint-parser/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ota-meshi/yaml-eslint-parser#readme",
|
||||
"dependencies": {
|
||||
"eslint-visitor-keys": "^5.0.0",
|
||||
"yaml": "^2.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@changesets/changelog-github": "^0.5.0",
|
||||
"@changesets/cli": "^2.24.2",
|
||||
"@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
|
||||
"@ota-meshi/eslint-plugin": "^0.18.0",
|
||||
"@types/benchmark": "^2.1.1",
|
||||
"@types/eslint": "^9.0.0",
|
||||
"@types/eslint-visitor-keys": "^3.0.0",
|
||||
"@types/mocha": "^10.0.0",
|
||||
"@types/node": "^24.0.0",
|
||||
"@types/semver": "^7.3.10",
|
||||
"@typescript-eslint/eslint-plugin": "^8.16.0",
|
||||
"@typescript-eslint/parser": "^8.16.0",
|
||||
"benchmark": "^2.1.4",
|
||||
"env-cmd": "^11.0.0",
|
||||
"eslint": "^9.15.0",
|
||||
"eslint-config-prettier": "^10.0.0",
|
||||
"eslint-plugin-eslint-comments": "^3.2.0",
|
||||
"eslint-plugin-jsdoc": "^62.0.0",
|
||||
"eslint-plugin-json-schema-validator": "^5.0.0",
|
||||
"eslint-plugin-jsonc": "^2.0.0",
|
||||
"eslint-plugin-n": "^17.0.0",
|
||||
"eslint-plugin-node-dependencies": "^1.0.0",
|
||||
"eslint-plugin-prettier": "^5.0.0",
|
||||
"eslint-plugin-regexp": "^2.0.0",
|
||||
"eslint-plugin-vue": "^10.0.0",
|
||||
"mocha": "^11.0.0",
|
||||
"nyc": "^17.0.0",
|
||||
"prettier": "^3.0.0",
|
||||
"semver": "^7.3.7",
|
||||
"tsdown": "^0.19.0",
|
||||
"tsx": "^4.21.0",
|
||||
"typescript": "^5.0.0",
|
||||
"typescript-eslint": "^8.16.0",
|
||||
"vue-eslint-parser": "^10.0.0",
|
||||
"yaml-test-suite": "^0.1.0"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user