feat: huge performance boost, better json fixing, sorting presets (#1)

Author: kuceb

.eslintignore

@@ -1,4 +1,4 @@
 !.*
 test/fixtures
-
+**/node_modules
 **/package-lock.json

README.md

@@ -7,11 +7,11 @@
     <a href="https://github.com/bkucera/eslint-plugin-json-format/blob/master/LICENSE"><img src="https://img.shields.io/github/license/bkucera/eslint-plugin-json-format.svg"></a>
 </div>
 
-Lint and auto-fix your `json` with `eslint`
+Lint, format, and auto-fix your `json` with `eslint`
 
 ## Features
 
-- lint and auto-fix `json` files (files ending with `.json` or `rc`)
+- lint, format, and auto-fix `json` files (files ending with `.json` or `rc`)
 - auto-sort `package.json` files (default `true`, can be disabled and sorting configured)
 - ignores `json-with-comments` files (default `["**/.tsconfig.json", ".vscode/**"]`)
 - ignores certain files by default (default `["**/package-lock.json"]`)
@@ -55,43 +55,33 @@ eslint --ext .js,.json,.eslintrc,.babelrc --fix .
 !.*
 ```
 
-## Configuration
+## Settings
 
-### default configuration** (`.eslintrc`):
+### default settings (`.eslintrc`):
 ```json
 "settings": {
   "json/sort-package-json": true,
   "json/ignore-files": ["**/package-lock.json"],
   "json/json-with-comments-files": ["**/tsconfig.json", ".vscode/**"],
-  "json/package-json-sort-order": [
-      "name",
-      "version",
-      "description",
-      "private",
-      "main",
-      "browser",
-      "scripts",
-      "husky",
-      "dependencies",
-      "devDependencies",
-      "peerDependencies",
-      "files",
-      "bin",
-      "engines",
-      "types",
-      "typings",
-      "productName",
-      "license",
-      "repository",
-      "homepage",
-      "author",
-      "bugs",
-    ]
+  "json/package-json-sort-order": "pro"
 }
 ```
 > Note: glob patterns use [`minimatch`](https://github.com/isaacs/minimatch/) against pathnames relative to the project root (cwd)
 
-### examples:
+### `package-json-sort-order`
+You can configure the exact sort order of your `package.json` files (or turn it off entirely with the `sort-package-json` setting)
+
+By default the sort order is `"pro"` (will change to "standard" in next major version)
+
+#### Available sorting options
+
+**"pro"**: places scripts and depenedencies at the top, reducing need to scroll down to view them. Pros only.
+
+**"standard"**: default from [`sort-package-json`](https://github.com/keithamus/sort-package-json). This is a sane, standard order.
+
+**["your", "custom", "order", "here"]**: provide an array to manually set the sort order.
+
+### Settings examples
 
 to turn off `sort-package-json` for example, in your `.eslintrc`:
 ```json

lib/index.js

@@ -1,12 +1,16 @@
 const _ = require('lodash')
 const debug = require('debug')('json')
-const Diff = require('diff')
+const diffMatchPatch = require('diff-match-patch')
 const lineColumn = require('line-column')
 const path = require('path')
 const { getSettings, SETTINGS } = require('./settings')
 const { parseJSON, formatJSON, sortPkgJSON, initializeEslintPlugin, includesFile } = require('./utils')
 const { stripIndent } = require('common-tags')
 
+const dmp = new diffMatchPatch()
+
+dmp.Diff_Timeout = 0.1
+
 const pluginName = 'json'
 
 initializeEslintPlugin({
@@ -49,33 +53,35 @@ initializeEslintPlugin({
           saveState
         )
 
-        debug('verify:', ret)
-
         return ret
       }
 
       const source = textOrSourceCode
 
-      debug({ source })
+      // debug({ source })
 
       let parsed
 
+      const startTime = new Date()
+
       try {
         parsed = parseJSON(source)
       } catch (e) {
         debug('parseJSON error:', e.message)
 
-        const res = /JSON5: (.*?) at (\d+):(\d+)/.exec(e.message)
+        const res = /(.*)\sin JSON at position (\d+)/.exec(e.message)
 
         let line = 1
         let col = 1
         let message = e.message
 
         if (res) {
-          debug(res[1], res[2])
-          line = res[2]
-          col = res[3]
+          debug('error parsed as:', res)
           message = res[1]
+          const lineCol = lineColumn(source, +res[2])
+
+          line = lineCol.line
+          col = lineCol.col
         }
 
         const ret = {
@@ -92,15 +98,21 @@ initializeEslintPlugin({
         return [ret]
 
       }
-      debug({ parsed })
+      const endTime = new Date()
+
+      debug('parsed:', endTime - startTime)
+      // debug({ parsed })
 
       const formatted = formatJSON(parsed)
 
-      debug({ formatted })
+      debug('formatted')
+
+      // debug({ formatted })
 
       let fixes = getFixes(source, formatted)
 
       if (mode === 'package-json') {
+        debug('sorting JSON')
         const sorted = formatJSON(sortPkgJSON(parsed, pluginSettings['package-json-sort-order']))
 
         if (sorted !== formatted) {
@@ -121,7 +133,9 @@ initializeEslintPlugin({
         }
       }
 
-      debug({ fixes })
+      // debug({ fixes })
+
+      debug('fixes count:', fixes.length)
 
       messages = messages.concat(fixes)
 
@@ -144,7 +158,7 @@ function getMode (pluginSettings, filenameOrOptions) {
 
   debug({ extension })
 
-  debug({ pluginSettings })
+  // debug({ pluginSettings })
 
   const basename = path.basename(filename)
 
@@ -192,15 +206,31 @@ function getMode (pluginSettings, filenameOrOptions) {
 
 const getFixes = (source, formatted) => {
 
-  const diff = Diff.diffChars(source, formatted)
+  const startTime = new Date()
+  // old, slow diff algo
+  // const diff = Diff.diffChars(source, formatted)
+  const diff = dmp.diff_main(source, formatted)
+  const endTime = new Date()
 
-  debug({ diff })
+  debug('diff time:', endTime - startTime)
+  // debug({ diff })
+  debug('diff length:', diff.length)
 
   let index = 0
 
   let fixes = []
 
-  _.each(diff, (d) => {
+  _.each(diff, (_d) => {
+
+    // const d = _d
+    const d = {
+      added: _d[0] === 1,
+      removed: _d[0] === -1,
+      value: _d[1],
+      count: _d[1].length,
+    }
+
+    // debug({ d })
 
     const valEscaped = d.value ? JSON.stringify(d.value) : ''
 

lib/settings.js

@@ -26,31 +26,35 @@ const schema = {
     ],
   },
   'package-json-sort-order': {
-    type: 'array',
-    default: [
-      'name',
-      'version',
-      'description',
-      'private',
-      'main',
-      'browser',
-      'scripts',
-      'husky',
-      'dependencies',
-      'devDependencies',
-      'peerDependencies',
-      'files',
-      'bin',
-      'engines',
-      'types',
-      'typings',
-      'productName',
-      'license',
-      'repository',
-      'homepage',
-      'author',
-      'bugs',
-    ],
+    type: ['array'],
+    default: 'pro',
+    presets: {
+      'standard': [],
+      'pro': [
+        'name',
+        'version',
+        'description',
+        'private',
+        'main',
+        'browser',
+        'scripts',
+        'husky',
+        'dependencies',
+        'devDependencies',
+        'peerDependencies',
+        'files',
+        'bin',
+        'engines',
+        'types',
+        'typings',
+        'productName',
+        'license',
+        'repository',
+        'homepage',
+        'author',
+        'bugs',
+      ],
+    },
   },
 }
 
@@ -65,51 +69,88 @@ function getSetting (settings, name) {
 function getSettings (settings) {
   const errors = []
   const warnings = []
-  const pluginSettings = _.mapValues(schema, (val, ruleName) => {
+  const pluginSettings = _.mapValues(schema, (setting, ruleName) => {
     let settingValue = getSetting(settings, ruleName)
 
     if (settingValue == null) {
-      settingValue = val.default
+      settingValue = setting.default
+    } else {
+      debug('user supplied setting:', ruleName)
     }
 
-    if (val.deprecated) {
-      if (settingValue != null) {
-        if (val.renamed) {
-          errors.push({
-            message: stripIndent`
-              Eslint Settings Error: [${namespace}]:
-                Using deprecated settings key: "${namespace}/${ruleName}"
-                Please rename this settings key to: "${namespace}/${val.renamed}"
-              `,
-          })
-        }
-      }
+    try {
+      settingValue = getFinalSettingValue(settingValue, setting, ruleName)
+    } catch (e) {
+      errors.push({
+        message: e.message,
+      })
 
       return
     }
 
-    const type = typeOf(settingValue)
-
-    debug('setting value', { ruleName, settingValue, type })
-    if (type !== val.type) {
-      throw new Error(stripIndent`
-      ESLint Settings Error [${namespace}]: 
-        invalid property value ${namespace}/${ruleName}
-        expected type of ${val.type}, but got ${type}`)
-    }
-
-    { return settingValue }
+    return settingValue
   })
 
-  debug({ pluginSettings })
-
   return { pluginSettings, warnings, errors }
 }
 
 module.exports = {
   getSettings,
   SETTINGS: _.mapValues(schema, (__, key) => key),
   schema,
+  getDefault: (key) => getFinalSettingValue(schema[key].default, schema[key], key),
 }
 
-const typeOf = (obj) => Object.prototype.toString.call(obj).replace(/\[\w+ (\w+)\]/, '$1').toLowerCase()
+const typeOf = (obj) => {
+  return Object.prototype.toString.call(obj).replace(/\[\w+ (\w+)\]/, '$1').toLowerCase()
+}
+
+const getFinalSettingValue = (val, setting, ruleName) => {
+  const type = typeOf(val)
+  const allowedTypes = _.isArray(setting.type) ? setting.type : [setting.type]
+
+  // debug({ ruleName, allowedTypes, type })
+  if (setting.deprecated) {
+    if (val != null) {
+      throwDeprecatedError(setting, ruleName)
+    }
+
+    return
+  }
+
+  if (setting.presets && type === 'string') {
+    if (!setting.presets[val]) {
+      throwInvalidTypeError(type, setting, allowedTypes, ruleName)
+    }
+
+    return setting.presets[val]
+  }
+
+  if (!_.includes(allowedTypes, type)) {
+    throwInvalidTypeError(type, setting, allowedTypes, ruleName)
+  }
+
+  return val
+
+}
+
+const throwInvalidTypeError = (type, setting, allowedTypes, ruleName) => {
+  throw new Error(stripIndent`
+      ESLint Settings Error [${namespace}]:
+        invalid property value ${namespace}/${ruleName}
+        expected type of ${allowedTypes.join(', ')}, but got ${type}
+        ${setting.presets ? `
+          You may also use one of the following preset values via string:
+            ${_.keys(setting.presets).map((v) => `'${v}'`).join(', ')}
+          ` : ''}
+        `)
+
+}
+
+const throwDeprecatedError = (setting, ruleName) => {
+  throw new Error(stripIndent`
+    Eslint Settings Error: [${namespace}]:
+      Using deprecated settings key: "${namespace}/${ruleName}"
+      ${setting.renamed ? `Please rename this settings key to: "${namespace}/${setting.renamed}"` : ''}
+  `)
+}