Skip to content

Commit f761c92

Browse files
committed
docs(@putout/plugin-remove-console) examples (#39)
1 parent a8e0501 commit f761c92

1 file changed

Lines changed: 9 additions & 25 deletions

File tree

packages/plugin-remove-console/README.md

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-remove-console.svg?style=flat&longCache=true
44
[NPMURL]: https://npmjs.org/package/@putout/plugin-remove-console"npm"
55
[DependencyStatusURL]: https://david-dm.org/coderaiser/putout?path=packages/plugin-remove-console
6-
[DependencyStatusIMGURL]: https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-remove-console
6+
[DependencyStatusIMGURL]: httpsh://david-dm.org/coderaiser/putout.svg?path=packages/plugin-remove-console
77

88
`putout` plugin adds ability to find and remove `console.log` calls.
99

@@ -15,39 +15,23 @@ npm i @putout/plugin-remove-console
1515

1616
## Rule
1717

18-
Rule `remove-console` is enabled by default, to disable add to `.putout.json`:
19-
2018
```json
2119
{
2220
"rules": {
23-
"remove-console": "off"
21+
"remove-console": "on"
2422
}
2523
}
2624
```
2725

28-
## Code Example
26+
## ❌ Incorrect code example
2927

3028
```js
31-
const {readFileSync} = require('fs');
32-
const source = readFileSync('./1.js', 'utf8');
33-
34-
const putout = require('putout');
35-
36-
console.log(source);
37-
// outputs
38-
`
39-
console.log('hello');
40-
`;
41-
42-
const result = putout(source, {
43-
plugins: [
44-
'remove-console',
45-
],
46-
});
47-
// returns
48-
'';
29+
const hello = 'world';
30+
console.log(hello);
4931
```
5032

51-
## License
33+
## ✅ Correct code Example
5234

53-
MIT
35+
```js
36+
const hello = 'world';
37+
```

0 commit comments

Comments
 (0)