feature(putout) add recursive read of config

Author: coderaiser

.putout.json

@@ -1,6 +1,10 @@
 {
+    "match": {
+        "**/packages/plugin-*": {
+            "putout": "on"
+        }
+    },
     "rules": {
-        "putout": "on",
         "remove-useless-spread/object": ["on", {
             "exclude": "module.exports.rules = __"
         }]

packages/plugin-extract-object-properties/README.md

@@ -37,11 +37,11 @@ const {isIdentifier} = a.types;
 
 ```js
 const {
-    operate,
+    operator,
     types,
 } = a;
 
-const {replaceWith} = operate;
+const {replaceWith} = operator;
 const {isIdentifier} = types;
 ```
 

packages/plugin-regexp/.putout.json

@@ -1,4 +1,7 @@
 {
+    "rules": {
+        "putout": "off"
+    },
     "match": {
         "*.md": {
             "regexp": "off"

packages/putout/lib/parse-options/index.js

@@ -5,7 +5,6 @@ const {readdirSync} = require('fs');
 const {
     dirname,
     join,
-    relative,
 } = require('path');
 
 const once = require('once');
@@ -15,9 +14,9 @@ const findUp = require('find-up');
 const parseMatch = require('./parse-match');
 const defaultOptions = require('../../putout.json');
 const merge = require('../merge');
+const recursiveRead = require('./recursive-read');
 
 const home = homedir();
-const cwd = process.cwd();
 
 module.exports = (info = {}) => {
     const {
@@ -29,29 +28,33 @@ module.exports = (info = {}) => {
         readCodeMods = _readCodeMods,
     } = info;
 
-    const [dir, customOptions] = readOptions(dirname(name));
+    const [dir, customOptions] = readOptions(name);
     const homeOptions = readHomeOptions();
-    const relativeName = relative(cwd, name);
+    const defaultMatch = parseMatch(name, defaultOptions.match);
 
-    const defaultMatch = parseMatch(relativeName, defaultOptions.match);
-    const mergedOptions = merge(
+    const optionsList = [
         defaultOptions,
         homeOptions,
         defaultMatch,
         customOptions,
         options,
+    ];
+    
+    const mergedOptions = merge(...optionsList);
+    const mergedDefaultsMatch = merge(
+        mergedOptions,
+        parseMatch(name, mergedOptions.match),
+        options,
     );
 
-    const mergedMatch = parseMatch(relativeName, mergedOptions.match);
-    const customMatch = parseMatch(relativeName, options.match);
+    const mergedMatch = merge(customOptions, options, parseMatch(name, options.match));
 
     const resultOptions = merge(
         readCodeMods(),
         readRules(dir, rulesdir),
         mergedOptions,
+        mergedDefaultsMatch,
         mergedMatch,
-        options,
-        customMatch,
     );
 
     return {
@@ -60,17 +63,13 @@ module.exports = (info = {}) => {
     };
 };
 
-function _readOptions(cwd) {
-    const putoutPath = findUp.sync('.putout.json', {
-        cwd,
-    });
+function _readOptions(name) {
+    const [dir, options] = recursiveRead(name, '.putout.json');
 
-    if (putoutPath)
-        return [
-            dirname(putoutPath),
-            require(putoutPath),
-        ];
+    if (dir)
+        return [dir, options];
 
+    const cwd = dirname(name);
     const packagePath = findUp.sync('package.json', {
         cwd,
     });
@@ -79,6 +78,7 @@ function _readOptions(cwd) {
         return [
             dirname(packagePath),
             require(packagePath).putout || {},
+            {},
         ];
 
     return [

packages/putout/lib/parse-options/index.spec.js

@@ -426,15 +426,14 @@ test('putout: parseOptions: read rules: error', (t) => {
     t.end();
 });
 
-test('putout: parseOptions: readOptions: error', (t) => {
+test('putout: parseOptions: readOptions: do not returns dir, load rules can not read', (t) => {
     const empty = {};
 
     const readHomeOptions = stub().returns(empty);
     const readCodeMods = stub().returns(empty);
-    const sync = stub();
+    const readOptions = stub().returns(['', empty]);
 
     mockRequire('../../putout.json', empty);
-    mockRequire('find-up', {sync});
 
     const {readdirSync} = fs;
     fs.readdirSync = () => {
@@ -459,6 +458,7 @@ test('putout: parseOptions: readOptions: error', (t) => {
         options,
         readHomeOptions,
         readCodeMods,
+        readOptions,
         rulesdir: '.',
     });
 
@@ -486,6 +486,7 @@ test('putout: parseOptions: readOptions: .putout.json', (t) => {
 
     const readHomeOptions = stub().returns(empty);
     const readCodeMods = stub().returns(empty);
+    const readOptions = stub().returns(['../..', {}]);
     const sync = (a) => {
         if (a === '.putout.json')
             return '../../putout.json';
@@ -519,6 +520,7 @@ test('putout: parseOptions: readOptions: .putout.json', (t) => {
         options,
         readHomeOptions,
         readCodeMods,
+        readOptions,
         rulesdir: '.',
     });
 
@@ -541,21 +543,14 @@ test('putout: parseOptions: readOptions: .putout.json', (t) => {
     t.end();
 });
 
-test('putout: parseOptions: readOptions: package.json', (t) => {
+test('putout: parseOptions: can not readd dir', (t) => {
     const empty = {};
 
     const readHomeOptions = stub().returns(empty);
     const readCodeMods = stub().returns(empty);
-    const sync = (a) => {
-        if (a === 'package.json')
-            return './package.json';
-        
-        return null;
-    };
+    const readOptions = stub().returns(['.', empty]);
 
     mockRequire('../../putout.json', empty);
-    mockRequire('./package.json', empty);
-    mockRequire('find-up', {sync});
 
     const {readdirSync} = fs;
     fs.readdirSync = () => {
@@ -580,6 +575,7 @@ test('putout: parseOptions: readOptions: package.json', (t) => {
         options,
         readHomeOptions,
         readCodeMods,
+        readOptions,
         rulesdir: '.',
     });
 
@@ -671,10 +667,12 @@ test('putout: parseOptions: readHomeOptions', (t) => {
 test('putout: parseOptions: no args', (t) => {
     const empty = {};
     const {homedir} = os;
+    const read = stub().returns(['', {}]);
     const sync = stub();
 
     os.homedir = stub().returns('/');
 
+    mockRequire('./recursive-read', read);
     mockRequire('./package.json', empty);
     mockRequire('../../putout.json', empty);
     mockRequire('find-up', {
@@ -696,3 +694,52 @@ test('putout: parseOptions: no args', (t) => {
     t.deepEqual(result, expected);
     t.end();
 });
+
+test('putout: parseOptions: readOptions: package.json', (t) => {
+    const empty = {};
+    
+    const readHomeOptions = stub().returns(empty);
+    const readCodeMods = stub().returns(empty);
+    const read = stub().returns(['', {}]);
+    
+    mockRequire('../../putout.json', empty);
+    mockRequire('./recursive-read', read);
+    
+    const parseOptions = reRequire('.');
+    
+    const options = {
+        rules: {
+            'remove-only': 'off',
+        },
+        match: {
+            '*.spec.js': {
+                'remove-only': 'on',
+            },
+        },
+    };
+    
+    const result = parseOptions({
+        name: 'parse-options.spec.js',
+        options,
+        readHomeOptions,
+        readCodeMods,
+    });
+    
+    delete result.dir;
+    
+    const expected = {
+        match: {
+            '*.spec.js': {
+                'remove-only': 'on',
+            },
+        },
+        rules: {
+            'remove-only': 'on',
+        },
+    };
+    
+    stopAll();
+    
+    t.deepEqual(result, expected);
+    t.end();
+});

packages/putout/lib/parse-options/parse-match.spec.js

@@ -206,3 +206,25 @@ test('putout: parse-match: extension: long path', (t) => {
     t.end();
 });
 
+test('putout: parse-match: similar matches', (t) => {
+    const match = {
+        'packages/plugin-*': {
+            putout: 'on',
+        },
+        'packages/plugin-putout/README.md': {
+            putout: 'off',
+        },
+    };
+    
+    const expected = {
+        rules: {
+            putout: 'off',
+        },
+    };
+    
+    const result = parseMatch('packages/plugin-putout/README.md', match);
+    
+    t.deepEqual(result, expected, 'should equal');
+    t.end();
+});
+

packages/putout/lib/parse-options/recursive-read.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const {join, dirname} = require('path');
+const tryCatch = require('try-catch');
+
+const merge = require('../merge');
+const parseMatch = require('./parse-match');
+
+module.exports = (name, configName) => {
+    let mainDir;
+    
+    let dir = name;
+    const optionsList = [];
+    
+    while (dir !== '/' && dir !== '.') {
+        const path = join(dir, configName);
+        const [, nextResult] = tryCatch(require, path);
+        
+        if (nextResult) {
+            mainDir = mainDir || dir;
+            optionsList.push(nextResult);
+        }
+        
+        dir = dirname(dir);
+    }
+    
+    let mergedOptions = merge(...optionsList);
+    
+    for (const currentOptions of optionsList.reverse())
+        mergedOptions = merge(
+            mergedOptions,
+            currentOptions,
+            parseMatch(
+                name,
+                currentOptions.match,
+            ),
+        );
+    
+    return [mainDir, mergedOptions];
+};
+

packages/putout/lib/parse-options/recursive-read.spec.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const {join} = require('path');
+
+const test = require('supertape');
+const read = require('./recursive-read');
+
+test('putout: parse-options: recursive read: dir', (t) => {
+    const [dir] = read(__filename, '.putout.json');
+    
+    t.equal(dir, join(__dirname, '../..'));
+    t.end();
+});
+
+test('putout: parse-options: called from eslint', (t) => {
+    const [dir] = read('<input>', '.putout.json');
+    
+    t.notOk(dir);
+    t.end();
+});