feat: merge sort-package-json settings (#2)

* major: merge sort-package-json settings

* fix typo

BREAKING CHANGE: merge package-json-sort-order into sort-package-json setting

Co-Authored-By: Pedro Augusto de Paula Barbosa <[email protected]>

Author: kuceb

README.md

@@ -63,22 +63,22 @@ eslint --ext .js,.json,.eslintrc,.babelrc --fix .
   "json/sort-package-json": true,
   "json/ignore-files": ["**/package-lock.json"],
   "json/json-with-comments-files": ["**/tsconfig.json", ".vscode/**"],
-  "json/package-json-sort-order": "pro"
+  "json/package-json-sort-order": "standard"
 }
 ```
 > Note: glob patterns use [`minimatch`](https://github.com/isaacs/minimatch/) against pathnames relative to the project root (cwd)
 
 ### `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)
+> By default the sort order is `"standard"`
 
 #### 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.
 
+**"pro"**: places scripts and dependencies at the top, reducing need to scroll down to view them. Pros only.
+
 **["your", "custom", "order", "here"]**: provide an array to manually set the sort order.
 
 ### Settings examples

docs/logo.gvdesign

@@ -113,7 +113,7 @@ initializeEslintPlugin({
 
       if (mode === 'package-json') {
         debug('sorting JSON')
-        const sorted = formatJSON(sortPkgJSON(parsed, pluginSettings['package-json-sort-order']))
+        const sorted = formatJSON(sortPkgJSON(parsed, pluginSettings['sort-package-json']))
 
         if (sorted !== formatted) {
 
@@ -186,7 +186,7 @@ function getMode (pluginSettings, filenameOrOptions) {
     }
   }
 
-  if (pluginSettings[SETTINGS['sort-package-json']]) {
+  if (pluginSettings[SETTINGS['sort-package-json']] !== false) {
     if (['package.json', '__package.json'].includes(basename)) {
       return 'package-json'
     }

docs/logo.svg

@@ -16,18 +16,8 @@ const schema = {
     ],
   },
   'sort-package-json': {
-    type: 'boolean',
-    default: true,
-  },
-  'ignore-files': {
-    type: 'array',
-    default: [
-      '**/package-lock.json',
-    ],
-  },
-  'package-json-sort-order': {
-    type: ['array'],
-    default: 'pro',
+    type: ['array', 'boolean'],
+    default: 'standard',
     presets: {
       'standard': [],
       'pro': [
@@ -56,6 +46,17 @@ const schema = {
       ],
     },
   },
+  'ignore-files': {
+    type: 'array',
+    default: [
+      '**/package-lock.json',
+    ],
+  },
+  'package-json-sort-order': {
+    type: 'boolean',
+    deprecated: true,
+    renamed: 'sort-package-json',
+  },
 }
 
 function getSetting (settings, name) {

lib/index.js

@@ -6,8 +6,14 @@ exports[`main spec configuration ignores json-with-comments-files (for now) 1`]
 To remove this warning add \\".vscode/settings.json\\" to your \`.eslintignore\` file"
 `;
 
-exports[`main spec errors bad settings json-with-comments-filenames 1`] = `
+exports[`main spec errors bad settings @deprecate json-with-comments-filenames 1`] = `
 "Eslint Settings Error: [json]:
   Using deprecated settings key: \\"json/json-with-comments-filenames\\"
   Please rename this settings key to: \\"json/json-with-comments-files\\""
 `;
+
+exports[`main spec errors bad settings @deprecate package-json-sort-order 1`] = `
+"Eslint Settings Error: [json]:
+  Using deprecated settings key: \\"json/package-json-sort-order\\"
+  Please rename this settings key to: \\"json/sort-package-json\\""
+`;

lib/settings.js

@@ -14,7 +14,7 @@ const getFormatted = async (filename) => {
 }
 
 const getFormattedAndSorted = async (filename) => {
-  return formatJSON(sortPkgJSON(parseJSON(await getFormatted(filename)), settings.getDefault('package-json-sort-order')))
+  return formatJSON(sortPkgJSON(parseJSON(await getFormatted(filename)), settings.getDefault('sort-package-json')))
 }
 
 function execute (file, baseConfig) {
@@ -208,15 +208,20 @@ describe('main spec', () => {
 
     // starts out of order
     expectOrder(_.keys(JSON.parse(await getFormatted(filename))), [
-      'license',
-      'dependencies',
+      'keywords',
+      'version',
     ])
 
     expect(result.output).toBe(await getFormattedAndSorted(filename))
     const resultOrder = _.keys(JSON.parse(result.output))
 
     // ends up in order
-    expectOrder(resultOrder, ['dependencies', 'license'])
+    expectOrder(resultOrder, [
+      'version',
+      'keywords',
+      'license',
+      'dependencies',
+    ])
   })
 
   describe('configuration', () => {
@@ -298,7 +303,7 @@ describe('main spec', () => {
       const filename = './fixtures/sort-order/__package.json'
       const { result } = execute(filename, {
         fix: true,
-        settings: { 'json/package-json-sort-order': ['foo', 'bar'] },
+        settings: { 'json/sort-package-json': ['foo', 'bar'] },
       })
 
       expectOrder(_.keys(parseJSON(result.output)), ['foo', 'bar'])
@@ -309,7 +314,7 @@ describe('main spec', () => {
       const { result } = execute(filename, {
         fix: true,
         // standard order is default from sort-package-json package
-        settings: { 'json/package-json-sort-order': 'standard' },
+        settings: { 'json/sort-package-json': 'pro' },
       })
 
       // starts out of order
@@ -322,7 +327,11 @@ describe('main spec', () => {
       const resultOrder = _.keys(JSON.parse(result.output))
 
       // ends up in order
-      expectOrder(resultOrder, ['license', 'dependencies'])
+      expectOrder(resultOrder, [
+        'dependencies',
+        'license',
+      ])
+
     })
 
   })
@@ -424,7 +433,7 @@ describe('main spec', () => {
     })
 
     describe('bad settings', () => {
-      it('json-with-comments-filenames', async () => {
+      it('@deprecate json-with-comments-filenames', async () => {
         const filename = './fixtures/demo.json'
         const { result } = execute(filename, {
           fix: true,
@@ -434,6 +443,17 @@ describe('main spec', () => {
         expect(result.warningCount).toBe(1)
         expect(result.messages[0].message).toMatchSnapshot()
       })
+
+      it('@deprecate package-json-sort-order', async () => {
+        const filename = './fixtures/sort-order/__package.json'
+        const { result } = execute(filename, {
+          fix: true,
+          settings: { 'json/package-json-sort-order': ['foo', 'bar'] },
+        })
+
+        expect(result.warningCount).toBe(1)
+        expect(result.messages[0].message).toMatchSnapshot()
+      })
     })
   })