Merge pull request #180 from kellyselden/avjFixerOptions

feat: add avjFixerOptions option to validate-schema
kellyselden · Aug 21, 2024 · d384e25 · d384e25
2 parents df3ffc7 + c4b0303
commit d384e25
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 3 deletions.
diff --git a/docs/rules/validate-schema.md b/docs/rules/validate-schema.md
@@ -47,6 +47,7 @@ An options object of:
 
 * `"schema"` a string of your JSON Schema
 * `"prettyErrors"` on by default. Set this to false if you want more machine-readable errors.
+* `"avjFixerOptions"` if you want to autofix some issues. Use this for supported fixers https://ajv.js.org/options.html#options-to-modify-validated-data.
 
 ## When Not To Use It
 

diff --git a/lib/rules/validate-schema.js b/lib/rules/validate-schema.js
@@ -2,6 +2,7 @@
 
 const Ajv = require('ajv');
 const { default: betterAjvErrors } = require('better-ajv-errors');
+const { EOL } = require('os');
 
 let ajv;
 
@@ -10,6 +11,7 @@ module.exports = {
     docs: {
       description: 'require a valid JSON Schema'
     },
+    fixable: 'code',
     schema: [
       {
         'type': 'object',
@@ -20,6 +22,10 @@ module.exports = {
           'prettyErrors': {
             'type': 'boolean',
             'default': true
+          },
+          // https://ajv.js.org/options.html#options-to-modify-validated-data
+          'avjFixerOptions': {
+            'type': 'object'
           }
         },
         'additionalProperties': false
@@ -65,7 +71,14 @@ module.exports = {
 
           context.report({
             node: packageJsonNode,
-            message
+            message,
+            fix(fixer) {
+              let ajvFix = new Ajv(options.avjFixerOptions);
+              let validate = ajvFix.compile(schema);
+              validate(packageJson);
+
+              return fixer.replaceText(packageJsonNode, JSON.stringify(packageJson, null, 2) + EOL);
+            }
           });
         }
       }

diff --git a/tests/lib/rules/validate-schema.js b/tests/lib/rules/validate-schema.js
@@ -42,7 +42,11 @@ new RuleTester().run('validate-schema', rule, preprocess({
       errors: [{
         message: color('[31m[1mNOT[22m[39m[31m must NOT be valid[39m\n\n[0m[31m[1m>[22m[39m[90m 1 |[39m {[32m"foo"[39m[33m:[39m[32m"bar"[39m}[0m\n[0m [90m   |[39m [31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m[31m[1m^[22m[39m [31m[1m👈🏽  [95mnot[31m must NOT be valid[22m[39m[0m'),
         type: 'ObjectExpression'
-      }]
+      }],
+      output: `{
+  "foo": "bar"
+}
+`
     },
     {
       code: '{"foo":"bar"}',
@@ -56,7 +60,37 @@ new RuleTester().run('validate-schema', rule, preprocess({
       errors: [{
         message: '#/not must NOT be valid',
         type: 'ObjectExpression'
-      }]
+      }],
+      output: `{
+  "foo": "bar"
+}
+`
+    },
+    {
+      code: '{"foo":"bar","bar":"foo"}',
+      options: [{
+        schema: schema({
+          'type': 'object',
+          'properties': {
+            'foo': {
+              'const': 'bar'
+            }
+          },
+          'additionalProperties': false
+        }),
+        prettyErrors: false,
+        avjFixerOptions: {
+          removeAdditional: true
+        }
+      }],
+      errors: [{
+        message: '#/additionalProperties must NOT have additional properties',
+        type: 'ObjectExpression'
+      }],
+      output: `{
+  "foo": "bar"
+}
+`
     }
   ]
 }));