Skip to content

Commit 95c59f7

Browse files
committed
feature: eslint-plugin-putout: export plugin (#232)
1 parent b1a4e98 commit 95c59f7

File tree

3 files changed

+35
-6
lines changed

3 files changed

+35
-6
lines changed

packages/eslint-plugin-putout/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,32 @@ npm i putout eslint eslint-plugin-putout -D
1717

1818
## Usage
1919

20-
Update `eslint.config.js` with:
20+
### Plugin
21+
22+
To use `putout` as ESLint plugin you can use in `eslint.config.js`
23+
24+
```js
25+
import putout from 'eslint-plugin-putout';
26+
27+
export default [
28+
rules: {
29+
'putout/putout': 'error',
30+
},
31+
plugins: {
32+
putout,
33+
},
34+
];
35+
```
36+
37+
### Preset
38+
39+
Also you can import one of predefined preset:
40+
41+
-**recommended** - all rules enabled;
42+
-**safe** - dangerous rules disabled;
43+
-**safeAlign** - dangerous rules disabled + add whitespaces on empty lines;
44+
45+
Here is how it can look like:
2146

2247
```js
2348
import {recommended} from 'eslint-plugin-putout';

packages/eslint-plugin-putout/lib/index.mjs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,4 @@ export const configs = {
139139
esm,
140140
};
141141

142-
const {rules} = putout;
143-
144-
export {
145-
rules,
146-
};
142+
export default putout;

packages/eslint-plugin-putout/test/exports.mjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,11 @@ test('eslint-plugin-putout: exports: rules', async (t) => {
77
t.equal(rules, internal.rules);
88
t.end();
99
});
10+
11+
test('eslint-plugin-putout: exports: default', async (t) => {
12+
const result = await import('eslint-plugin-putout');
13+
const internal = await import('../lib/plugin.mjs');
14+
15+
t.equal(result.default, internal);
16+
t.end();
17+
});

0 commit comments

Comments
 (0)