Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cartant/eslint-etc
Utils for ESLint TypeScript rules
https://github.com/cartant/eslint-etc
Last synced: about 2 months ago
JSON representation
Utils for ESLint TypeScript rules
- Host: GitHub
- URL: https://github.com/cartant/eslint-etc
- Owner: cartant
- License: mit
- Created: 2019-09-08T15:08:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T15:45:12.000Z (over 1 year ago)
- Last Synced: 2024-04-25T23:03:38.157Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 568 KB
- Stars: 15
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# eslint-etc
[](https://github.com/cartant/eslint-etc/blob/master/LICENSE)
[](https://www.npmjs.com/package/eslint-etc)
[](https://npmjs.org/package/eslint-etc)
[](https://app.circleci.com/pipelines/github/cartant)
[](https://david-dm.org/cartant/eslint-etc)
[](https://david-dm.org/cartant/eslint-etc#info=devDependencies)
[](https://david-dm.org/cartant/eslint-etc#info=peerDependencies)
More utils for use with `eslint`.
I use these utils to implement and test my own ESLint rules. That's their primary purpose, so the documentation is ... light.
## fromFixture
`fromFixture` allows TSLint-like fixtures to be used to test ESlint rules. Using fixtures means that you don't have to specify lines and columns. Instead, you underline the failure locations within the fixture, like this:
```ts
{
invalid: [
fromFixture(stripIndent`
const name = "alice";
~~~~ [foo { "identifier": "name" }]
~~~~~~~ [bar]
const role = 'cto';
~~~~ [foo { "identifier": "role" }]
`),
fromFixture(stripIndent`
const name = "alice";
~~~~ [foo { "identifier": "name" }]
const role = 'cto';
~~~~ [foo { "identifier": "role" }]
`, {
options: [{ bar: false }]
}),
]
}
```
which is equivalent to the following:
```ts
{
invalid: [{
code: `const name = "alice";
const role = 'cto';`,
errors: [{
column: 7,
endColumn: 11,
line: 1,
endLine: 1,
messageId: "foo",
data: {
identifier: "name",
},
}, {
column: 14,
endColumn: 21,
line: 1,
endLine: 1,
messageId: "bar",
data: {},
}, {
column: 7,
endColumn: 11,
line: 2,
endLine: 2,
messageId: "foo",
data: {
identifier: "role",
},
}]
}, {
code: `const name = "alice";
const role = 'cto';`,
errors: [{
column: 7,
endColumn: 11,
line: 1,
endLine: 1,
messageId: "foo",
data: {
identifier: "name",
},
}, {
column: 7,
endColumn: 11,
line: 2,
endLine: 2,
messageId: "foo",
data: {
identifier: "role",
},
}],
options: [{
bar: false
}]
}]
}
```
Specifying `data` in the fixture is optional. If it's omitted, `data` defaults to `{}`.
The second, optional, argument passed to `fromFixture` can be used to pass additional test case properties - `options` and `output`, etc.
### Suggestions
A `suggestions` array can be passed to `fromFixture` via its second, optional parameter and, when passed, a `suggest` annotation can be used within the fixture, like this:
```ts
fromFixture(stripIndent`
const a = "alice";
~~~~~~~ [foo suggest]
`, {
suggestions: [{
messageId: "suggestionForFoo",
output: "/* suggestion output goes here */"
}]
}),
```
And it's possible to include multiple `suggest` annotations and suggestions in a single fixture:
```ts
fromFixture(stripIndent`
const a = "alice";
~~~~~~~ [foo suggest 0]
const b = "bob";
~~~~~ [bar suggest 1]
`, {
suggestions: [{
messageId: "suggestionForFoo",
output: "/* suggestion for foo output goes here */"
}, {
messageId: "suggestionForBar",
output: "/* suggestion for bar output goes here */"
}]
}),
```
The `suggest` annotations work with the `suggestions` array in the following manner:
- If `suggest` is specified with no indices, all suggestions are associated with the annotated error.
- If `suggest` is specified with indices, suggestions at those indices are associated with the annotated error.
- If `suggest` is not specified, no suggestions are associated with the annotated error.
- And if `suggestions` are specified without a `suggest` annotation being used, `fromFixture` will throw an error.
And if the rule has both a fixer and suggestions, you can specify an `output` - for the fixer - in conjunction with a `suggestions` array:
```ts
fromFixture(stripIndent`
const a = "alice";
~~~~~~~ [foo suggest]
`, {
output: "/* fixer output goes here */",
suggestions: [{
messageId: "suggestionForFoo",
output: "/* suggestion output goes here */"
}]
}),
```