feature: @putout/plugin-variables: remove-unused

Author: coderaiser

README.md

@@ -296,8 +296,8 @@ So, if you want to convert it to [`ESM`](https://developer.mozilla.org/en-US/doc
 `putout index.js --disable-all` will find next errors:
 
 ```sh
- 1:4   error   'unused' is defined but never used                        remove-unused-variables
- 7:23  error   'a' is defined but never used                             remove-unused-variables
+ 1:4   error   'unused' is defined but never used                        variables/remove-unused
+ 7:23  error   'a' is defined but never used                             variables/remove-unused
  3:0   error   Use arrow function                                        convert-to-arrow-function
  1:0   error   Add missing 'use strict' directive on top of CommonJS     nodejs/dd-missing-strict-cmode
  8:4   error   Reject is useless in async functions, use throw instead   promises/convert-reject-to-throw
@@ -310,7 +310,7 @@ It will create config file `.putout.json`:
 ```json
 {
     "rules": {
-        "remove-unused-variables": "off",
+        "variables/remove-unused": "off",
         "convert-to-arrow-function": "off",
         "nodejs/add-missing-strict-mode": "off",
         "promises/convert-reject-to-throw": "off",
@@ -325,7 +325,7 @@ Then running `putout index.js --enable nodejs/convert-commonjs-to-esm` will upda
 ```diff
 {
     "rules": {
-        "remove-unused-variables": "off",
+        "variables/remove-unused": "off",
         "convert-to-arrow-function": "off",
         "nodejs/add-missing-strict-mode": "off",
         "promises/convert-reject-to-throw": "off",
@@ -541,12 +541,16 @@ const source = `
 
 #### Plugins
 
-🐊**Putout** supports dynamic loading of plugins from `node_modules`. Let's consider example of using the [remove-unused-variables](https://github.com/coderaiser/putout/tree/master/packages/plugin-remove-unused-variables/README.md#readme) plugin:
+🐊**Putout** supports dynamic loading of plugins from `node_modules`. Let's consider example of using the [variables/remove-unused](https://github.com/coderaiser/putout/tree/master/packages/plugin-variables/README.md#remove-unused) plugin:
 
 ```js
 putout(source, {
+    rules: {
+        'variables': 'off',
+        'variables/remove-unused': 'on',
+    },
     plugins: [
-        'remove-unused-variables',
+        'variables',
     ],
 });
 
@@ -568,16 +572,20 @@ In the following example redundant variables are found without making changes to
 ```js
 putout(source, {
     fix: false,
+    rules: {
+        'variables': 'off',
+        'variables/remove-unused': 'on',
+    },
     plugins: [
-        'remove-unused-variables',
+        'variables',
     ],
 });
 
 // returns
 ({
     code: '\n' + `    const hello = 'world';\n` + `    const hi = 'there';\n` + '    \n' + '    console.log(hello);\n',
     places: [{
-        rule: 'remove-unused-variables',
+        rule: 'variables/remove-unused',
         message: '"hi" is defined but never used',
         position: {
             line: 3,
@@ -2159,7 +2167,6 @@ It has a lot of plugins divided by groups:
 
 | Package | Version |
 |--------|-------|
-| [`@putout/plugin-remove-unused-variables`](/packages/plugin-remove-unused-variables#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-remove-unused-variables.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-remove-unused-variables) |
 | [`@putout/plugin-remove-unreferenced-variables`](/packages/plugin-remove-unreferenced-variables#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-remove-unreferenced-variables.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-remove-unreferenced-variables) |
 | [`@putout/plugin-remove-duplicate-keys`](/packages/plugin-remove-duplicate-keys#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-remove-duplicate-keys.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-remove-duplicate-keys) |
 | [`@putout/plugin-remove-duplicate-case`](/packages/plugin-remove-duplicate-case#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-remove-duplicate-case.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-remove-duplicate-case) |
@@ -2362,7 +2369,7 @@ You can disable rules using `"off"`, or enable them (in `match` section) using `
 ```json
 {
     "rules": {
-        "remove-unused-variables": "off"
+        "variables/remove-unused": "off"
     }
 }
 ```
@@ -2372,7 +2379,7 @@ Or pass options using `rules` section:
 ```json
 {
     "rules": {
-        "remove-unused-variables": ["on", {
+        "variables/remove-unused": ["on", {
             "exclude": "const global = __"
         }]
     }
@@ -2387,7 +2394,7 @@ Pass an array when you have a couple templates to exclude:
 ```json
 {
     "rules": {
-        "remove-unused-variables": ["on", {
+        "variables/remove-unused": ["on", {
             "exclude": [
                 "VariableDeclaration"
             ]
@@ -2670,7 +2677,7 @@ If you don't want to publish a **plugin** you developed, you can pass it to 🐊
 ```js
 putout('const a = 5', {
     plugins: [
-        ['remove-unused-variables', require('@putout/plugin-remove-unused-variables')],
+        ['variables', require('@putout/plugin-variables')],
     ],
 });
 ```
@@ -2814,7 +2821,7 @@ Just create `.babelrc.json` file with configuration you need.
     "plugins": [
         ["putout", {
             "rules": {
-                "remove-unused-variables": "off"
+                "variables/remove-unused": "off"
             }
         }]
     ]

packages/engine-loader/lib/index.spec.js

@@ -7,7 +7,7 @@ const {validateRulesRelations} = require('./index');
 
 test('engine-loader: load-plugins', (t) => {
     const result = loadPlugins({
-        pluginNames: ['remove-unused-variables'],
+        pluginNames: ['remove-debugger'],
     });
 
     t.equal(result.length, 1);

packages/engine-loader/test/load-plugins.js

@@ -19,7 +19,7 @@ const fixture = readFixtures(['shebang', 'shebang-fix']);
 
 test('putout: loader: user plugin', (t) => {
     const {_findPath} = Module;
-    const rmVars = 'remove-unused-variables';
+    const rmVars = 'remove-debugger';
 
     const rmUnusedVars = require(`@putout/plugin-${rmVars}`);
 
@@ -39,7 +39,7 @@ test('putout: loader: user plugin', (t) => {
         return _findPath(name, paths);
     });
 
-    const {code} = putout(`const t = 'hello'`, {
+    const {code} = putout(`debugger`, {
         loadPlugins,
         plugins: [rmVars],
     });
@@ -63,15 +63,15 @@ test('putout: loader: can not find', (t) => {
 });
 
 test('putout: loader: function', (t) => {
-    const rmVars = 'remove-unused-variables';
+    const rmVars = 'remove-debugger';
     const rmVarsPlugin = require(`@putout/plugin-${rmVars}`);
 
     mockRequire(`@putout/plugin-${rmVars}`, null);
 
     reRequire('..');
     const putout = reRequire('putout');
 
-    const {code} = putout(`const t = 'hello'`, {
+    const {code} = putout(`debugger;`, {
         plugins: [{
             [rmVars]: rmVarsPlugin,
         }],
@@ -84,15 +84,15 @@ test('putout: loader: function', (t) => {
 });
 
 test('putout: loader: function: rules', (t) => {
-    const rmVars = 'remove-unused-variables';
+    const rmVars = 'remove-debugger';
     const rmVarsPlugin = require(`@putout/plugin-${rmVars}`);
 
     mockRequire(`@putout/plugin-${rmVars}`, null);
 
     reRequire('..');
     const putout = reRequire('putout');
 
-    const {code} = putout(`const t = 'hello'`, {
+    const {code} = putout(`debugger`, {
         plugins: [{
             'brand-new-rule': {
                 rules: {
@@ -109,15 +109,15 @@ test('putout: loader: function: rules', (t) => {
 });
 
 test('putout: loader: disabled rule', (t) => {
-    const rmVars = 'remove-unused-variables';
+    const rmVars = 'remove-debugger';
     const rmVarsPlugin = require(`@putout/plugin-${rmVars}`);
 
     mockRequire(`@putout/plugin-${rmVars}`, null);
 
     reRequire('..');
     const putout = reRequire('putout');
 
-    const {code} = putout(`const t = 'hello'`, {
+    const {code} = putout(`debugger`, {
         rules: {
             [rmVars]: false,
         },
@@ -128,7 +128,7 @@ test('putout: loader: disabled rule', (t) => {
 
     stopAll();
 
-    t.equal(code, `const t = 'hello';\n`);
+    t.equal(code, `debugger;\n`);
     t.end();
 });
 
@@ -155,37 +155,37 @@ test('putout: loader: disabled rule from multi rule plugin', (t) => {
 });
 
 test('putout: loader: plugins: array', (t) => {
-    const rmVars = 'remove-unused-variables';
+    const rmVars = 'remove-debugger';
     const rmVarsPlugin = require(`@putout/plugin-${rmVars}`);
 
     mockRequire(`@putout/plugin-${rmVars}`, null);
 
     reRequire('..');
     const putout = reRequire('putout');
 
-    const {code} = putout(`const t = 'hello'`, {
+    const {code} = putout(`debugger;`, {
         rules: {
             [rmVars]: false,
         },
         plugins: [
-            ['remove-unused-variables', rmVarsPlugin],
+            ['remove-debugger', rmVarsPlugin],
         ],
     });
 
     stopAll();
 
-    t.equal(code, `const t = 'hello';\n`);
+    t.equal(code, `debugger;\n`);
     t.end();
 });
 
 test('putout: loader: nested rules', (t) => {
     const {code} = putout(fixture.shebang, {
         rules: {
             'putout/convert-babel-types': 'off',
-            'remove-unused-variables': 'off',
+            'variables': 'off',
         },
         plugins: [
-            'remove-unused-variables',
+            'variables',
             'putout',
         ],
     });

packages/engine-parser/lib/parsers/hermes.spec.js

@@ -10,7 +10,7 @@ const fixture = readFixtures(__dirname, ['hermes', 'hermes-fix']);
 test('putout: parser: hermes', (t) => {
     const {code} = putout(fixture.hermes, {
         parser: 'hermes',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.hermesFix;

packages/engine-parser/lib/printers/babel.spec.js

@@ -62,7 +62,7 @@ test('putout: parser: print: printer: babel: preserve format: trim', (t) => {
     });
 
     transform(ast, source, {
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const result = print(ast, {
@@ -89,7 +89,7 @@ test('putout: parser: print: printer: babel: preserve format: align-spaces: off'
     });
 
     transform(ast, source, {
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const result = print(ast, {

packages/engine-parser/test/parser.js

@@ -46,7 +46,7 @@ const fixture = readFixtures([
 test('putout: parser: export default declaration: acorn', (t) => {
     const {code} = putout(fixture.exportDefaultDeclaration, {
         parser: 'acorn',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.exportDefaultDeclarationFix;
@@ -58,7 +58,7 @@ test('putout: parser: export default declaration: acorn', (t) => {
 test('putout: parser: acorn: parens-typescript', (t) => {
     const {code} = putout(fixture.parensTypescript, {
         parser: 'acorn',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.parensTypescriptFix;
@@ -70,7 +70,7 @@ test('putout: parser: acorn: parens-typescript', (t) => {
 test('putout: parser: export default declaration: esprima', (t) => {
     const {code} = putout(fixture.exportDefaultDeclaration, {
         parser: 'esprima',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.exportDefaultDeclarationFix;
@@ -82,7 +82,7 @@ test('putout: parser: export default declaration: esprima', (t) => {
 test('putout: parser: export default declaration: custom parser', (t) => {
     const [e] = tryCatch(putout, fixture.exportDefaultDeclaration, {
         parser: 'custom',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     t.match(e.message, `Cannot find module 'custom'`);
@@ -105,7 +105,7 @@ test('putout: parser: use strict: parser: espree: debugger', (t) => {
 test('putout: parser: export default declaration: tenko: export default', (t) => {
     const {code} = putout(fixture.exportDefaultDeclaration, {
         parser: 'tenko',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.exportDefaultDeclarationFix;
@@ -116,7 +116,7 @@ test('putout: parser: export default declaration: tenko: export default', (t) =>
 
 test('putout: parser: export default declaration: tenko: throw', (t) => {
     const {code} = putout(fixture.throw, {
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = '\n';
@@ -176,7 +176,7 @@ test('putout: parser: generate', (t) => {
 
 test('putout: parser: flow', (t) => {
     const {code} = putout(fixture.flow, {
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.flowFix;
@@ -202,7 +202,7 @@ test('putout: parser: broken', (t) => {
 test('putout: parser: typescript', (t) => {
     const {code} = putout(fixture.typescript, {
         isTS: true,
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.typescriptFix;
@@ -214,7 +214,7 @@ test('putout: parser: typescript', (t) => {
 test('putout: parser: decorator', (t) => {
     const {code} = putout(fixture.decorator, {
         isTS: true,
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.decorator;
@@ -226,7 +226,7 @@ test('putout: parser: decorator', (t) => {
 test('putout: parser: decorator-legacy', (t) => {
     const {code} = putout(fixture.decoratorLegacy, {
         isTS: true,
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.decoratorLegacy;
@@ -263,7 +263,7 @@ test('putout: parser: jsx: not react', (t) => {
 
 test('putout: parser: strict mode', (t) => {
     const {code} = putout(fixture.strictMode, {
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     t.equal(code, fixture.strictModeFix);
@@ -439,7 +439,7 @@ test('putout: parser: esprima', (t) => {
 test('putout: parser: printer: babel', (t) => {
     const {code} = putout(fixture.printerBabel, {
         printer: 'babel',
-        plugins: ['remove-unused-variables'],
+        plugins: ['variables'],
     });
 
     const expected = fixture.printerBabelFix;