putout 22.2.1 → 22.3.3

package/ChangeLog

@@ -1,3 +1,32 @@
+2021.11.30, v22.3.3
+
+fix:
+- (putout) validate-options: add support of optional message
+
+
+2021.11.30, v22.3.2
+
+fix:
+- (putout) validate-options: rm rule names: has no sense for validation as any rule provided by plugin supported
+
+
+2021.11.30, v22.3.1
+
+feature:
+- validate-options: improve support of rules, match
+- (putout) validate-options: improve validations: ignore, processors
+- (putout) validate-options: add descriptions
+
+
+2021.11.30, v22.3.0
+
+feature:
+- (putout) add config validation
+- (@putout/plugin-remove-empty-pattern) improve support of nested destructuring
+- (@putout/plugin-tape) add-stop-all: add support of mockRequire
+- (@putout/plugin-remove-unused-variables) improve support of nested destructuring
+
+
 2021.11.28, v22.2.1
 
 fix:

package/lib/cli/exit-codes.js

@@ -13,5 +13,6 @@ module.exports = {
     UNHANDLED: 9,
     RULLER_WITH_FIX: 10,
     RULLER_NO_FILES: 11,
+    INVALID_CONFIG: 12,
 };
 

package/lib/cli/exit-codes.mjs

@@ -10,4 +10,4 @@ export const CANNOT_LOAD_PROCESSOR = 8;
 export const UNHANDLED = 9;
 export const RULLER_WITH_FIX = 10;
 export const RULLER_NO_FILES = 11;
-
+export const INVALID_CONFIG = 12;

package/lib/cli/index.js

@@ -53,6 +53,7 @@ const {
     UNHANDLED,
     RULLER_WITH_FIX,
     RULLER_NO_FILES,
+    INVALID_CONFIG,
 } = require('./exit-codes');
 
 const cwd = process.cwd();
@@ -217,11 +218,7 @@ module.exports = async ({argv, halt, log, write, logError, readFile, writeFile})
     }
     
     const noConfig = !args.config;
-    const {
-        formatter,
-        ignore,
-        processors = defaultProcessors,
-    } = getOptions({
+    const [configError, config] = tryCatch(getOptions, {
         name: `${cwd}/*`,
         rulesdir,
         noConfig,
@@ -229,6 +226,15 @@ module.exports = async ({argv, halt, log, write, logError, readFile, writeFile})
         plugins,
     });
     
+    if (configError)
+        return exit(INVALID_CONFIG, configError);
+    
+    const {
+        formatter,
+        ignore,
+        processors = defaultProcessors,
+    } = config;
+    
     const [currentFormat, formatterOptions] = getFormatter(format || formatter, exit);
     const [error, processorRunners] = tryCatch(getProcessorRunners, processors);
     
@@ -311,7 +317,7 @@ module.exports = async ({argv, halt, log, write, logError, readFile, writeFile})
         const resolvedName = resolve(name)
             .replace(/^\./, cwd);
         
-        const options = getOptions({
+        const [configError, options] = tryCatch(getOptions, {
             name: resolvedName,
             rulesdir,
             noConfig,
@@ -319,6 +325,9 @@ module.exports = async ({argv, halt, log, write, logError, readFile, writeFile})
             plugins,
         });
         
+        if (configError)
+            return exit(INVALID_CONFIG, configError);
+        
         const {dir} = options;
         
         if (fileCache.canUseCache(name, options)) {

package/lib/parse-options/index.js

@@ -16,6 +16,7 @@ const defaultOptions = require('../../putout.json');
 const merge = require('../merge');
 const recursiveRead = require('./recursive-read');
 const applyModuleTypeRules = require('./apply-module-type-rules');
+const {validateOptions} = require('./validate-options');
 
 const home = homedir();
 
@@ -62,6 +63,8 @@ module.exports = (info = {}) => {
         mergedMatch,
     );
     
+    validateOptions(resultOptions);
+    
     return {
         ...resultOptions,
         dir,

package/lib/parse-options/validate-options/index.js

@@ -0,0 +1,51 @@
+'use strict';
+
+const Ajv = require('ajv');
+const schema = require('./schema.json');
+
+const ajv = new Ajv({
+    strict: true,
+    allowUnionTypes: true,
+});
+
+const validate = ajv.compile(schema);
+
+module.exports.validateOptions = (options) => {
+    validate(options);
+    
+    const [error] = validate.errors || [];
+    
+    if (error)
+        throw Error(`.putout.json: ${parsePath(error)}${parseAdditional(error)}${parseMessage(error)}${parseAllowed(error)}`);
+};
+
+function parseAllowed(error) {
+    const {allowedValues} = error.params;
+    
+    if (!allowedValues)
+        return '';
+    
+    return ` (${allowedValues.join('/')})`;
+}
+
+function parseMessage(error) {
+    return error.message.replace(',', ' or ');
+}
+
+const parseAdditional = (error) => {
+    const {additionalProperty} = error.params;
+    
+    if (!additionalProperty)
+        return '';
+    
+    return `${additionalProperty}: `;
+};
+
+const parsePath = (error) => {
+    const {instancePath} = error;
+    
+    if (!instancePath)
+        return '';
+    
+    return `${error.instancePath.slice(1)}: `;
+};

package/lib/parse-options/validate-options/schema.json

@@ -0,0 +1,92 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "additionalProperties": false,
+    "definitions": {
+        "rule": {
+            "oneOf": [{
+                "description": "🐊Putout rule\n\n\"off\" means rule is off\n\"on\" means it is a on\n",
+                "enum": [ "on", "off"]
+            }, {
+                "type": "array",
+                "items": [{
+                    "enum": [ "on", "off"]
+                }, {
+                    "type": "object"
+                }],
+                "minItems": 2,
+                "additionalItems": false
+            }, {
+                "type": "array",
+                "items": [{
+                    "enum": [ "on", "off"]
+                }, {
+                    "type": "string"
+                }, {
+                    "type": "object"
+                }],
+                "minItems": 3,
+                "additionalItems": false
+            }, {
+                "type": "array",
+                "items": [{
+                    "enum": [ "on", "off"]
+                }, {
+                    "type": "string"
+                }],
+                "minItems": 2,
+                "additionalItems": false
+            }]
+        },
+        "rules": {
+            "description": "🐊Putout comes with a large number of rules. You can modify which rules your project uses.",
+            "type": "object",
+            "patternProperties": {
+                "^.*$": {
+                    "$ref": "#/definitions/rule"
+                }
+            }
+        }
+    },
+    "properties": {
+        "parser": {
+            "description": "Tell 🐊Putout which parser to use",
+            "type": "string"
+        },
+        "formatter": {
+            "description": "Choose the way to show information about errors found",
+            "type": ["string", "array"]
+        },
+        "processors": {
+            "description": "Tell 🐊Putout which processors to use to support file types other then JavaScript",
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+                "type": "string"
+            }
+        },
+        "ignore": {
+            "description": "Tell 🐊Putout to ignore specific files and directories.",
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+                "type": "string"
+            }
+        },
+        "match": {
+            "description": "Allows to match rules for files and folders, specified by glob patterns.",
+            "type": "object",
+            "patternProperties": {
+                "^.*$": {
+                    "$ref": "#/definitions/rules"
+                }
+            }
+        },
+        "plugins": {
+            "description": "Tell 🐊Putout which plugins to load",
+            "type": "array",
+            "uniqueItems": true
+        },
+        "rules": {"$ref": "#/definitions/rules"}
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "putout",
-  "version": "22.2.1",
+  "version": "22.3.3",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊 Pluggable and configurable code transformer with built-in eslint, babel plugins and jscodeshift codemods support of js, jsx typescript, flow files, markdown, yaml and json",
   "homepage": "http://github.com/coderaiser/putout",
@@ -178,6 +178,7 @@
     "@putout/processor-markdown": "^5.0.0",
     "@putout/processor-yaml": "^3.0.0",
     "@putout/traverse": "^4.0.0",
+    "ajv": "^8.8.2",
     "chalk": "^4.0.0",
     "ci-info": "^3.1.1",
     "debug": "^4.1.1",

package/putout.json

@@ -108,9 +108,6 @@
         "**/build",
         "**/package-lock.json"
     ],
-    "exclude": [
-        ".md"
-    ],
     "rules": {
         "apply-array-at": "off",
         "apply-as-type-assertions": "off",