feat: sort all scripts unless npm-run-all is a dependency (#232)

* feat: sort all scripts unless `npm-run-all` is a dependency * refactor: suggestions from code review Co-authored-by: fisker Cheung <[email protected]> * refactor: suggestions from code review * style: prettier * fix: pipe Co-authored-by: Keith Cirkel <[email protected]> Co-authored-by: fisker Cheung <[email protected]>
keithamus · Sep 24, 2021 · 675ed2f · 675ed2f
1 parent 385d043
commit 675ed2f
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 11 deletions.
diff --git a/index.js b/index.js
@@ -6,14 +6,15 @@ const isPlainObject = require('is-plain-obj')
 
 const hasOwnProperty = (object, property) =>
   Object.prototype.hasOwnProperty.call(object, property)
-const pipe = (fns) => (x) => fns.reduce((result, fn) => fn(result), x)
+const pipe = (fns) => (x, ...args) =>
+  fns.reduce((result, fn) => fn(result, ...args), x)
 const onArray = (fn) => (x) => (Array.isArray(x) ? fn(x) : x)
 const onStringArray = (fn) => (x) =>
   Array.isArray(x) && x.every((item) => typeof item === 'string') ? fn(x) : x
 const uniq = onStringArray((xs) => xs.filter((x, i) => i === xs.indexOf(x)))
 const sortArray = onStringArray((array) => [...array].sort())
 const uniqAndSortArray = pipe([uniq, sortArray])
-const onObject = (fn) => (x) => (isPlainObject(x) ? fn(x) : x)
+const onObject = (fn) => (x, ...args) => (isPlainObject(x) ? fn(x, ...args) : x)
 const sortObjectBy = (comparator, deep) => {
   const over = onObject((object) => {
     object = sortObjectKeys(object, comparator)
@@ -38,9 +39,9 @@ const sortDirectories = sortObjectBy([
   'example',
   'test',
 ])
-const overProperty = (property, over) => (object) =>
+const overProperty = (property, over) => (object, ...args) =>
   hasOwnProperty(object, property)
-    ? Object.assign(object, { [property]: over(object[property]) })
+    ? Object.assign(object, { [property]: over(object[property], ...args) })
     : object
 const sortGitHooks = sortObjectBy(gitHooks)
 
@@ -131,7 +132,14 @@ const defaultNpmScripts = new Set([
   'version',
 ])
 
-const sortScripts = onObject((scripts) => {
+const hasDevDependency = (dependency, packageJson) => {
+  return (
+    'devDependencies' in packageJson &&
+    !!packageJson.devDependencies[dependency]
+  )
+}
+
+const sortScripts = onObject((scripts, packageJson) => {
   const names = Object.keys(scripts)
   const prefixable = new Set()
 
@@ -144,6 +152,10 @@ const sortScripts = onObject((scripts) => {
     return name
   })
 
+  if (!hasDevDependency('npm-run-all', packageJson)) {
+    keys.sort()
+  }
+
   const order = keys.reduce(
     (order, key) =>
       order.concat(
@@ -334,7 +346,7 @@ function sortPackageJson(jsonIsh, options = {}) {
         ]
       }
 
-      return overFields(sortObjectKeys(json, sortOrder))
+      return overFields(sortObjectKeys(json, sortOrder), json)
     }),
   )
 }

diff --git a/tests/scripts.js b/tests/scripts.js
@@ -18,7 +18,24 @@ const fixture = {
   'pre-fetch-info': 'foo',
 }
 
-const expect = {
+const expectAllSorted = {
+  preinstall: 'echo "Installing"',
+  postinstall: 'echo "Installed"',
+  multiply: '2 * 3',
+  'pre-fetch-info': 'foo',
+  prepare: 'npm run build',
+  preprettier: 'echo "not pretty"',
+  prettier: 'prettier -l "**/*.js"',
+  postprettier: 'echo "so pretty"',
+  start: 'node server.js',
+  pretest: 'xyz',
+  test: 'node test.js',
+  posttest: 'abc',
+  prewatch: 'echo "about to watch"',
+  watch: 'watch things',
+}
+
+const expectPreAndPostSorted = {
   pretest: 'xyz',
   test: 'node test.js',
   posttest: 'abc',
@@ -36,9 +53,18 @@ const expect = {
 }
 
 for (const field of ['scripts', 'betterScripts']) {
-  test(field, macro.sortObject, {
-    path: field,
-    value: fixture,
-    expect,
+  test(`${field} when npm-run-all is not a dev dependency`, macro.sortObject, {
+    value: { [field]: fixture },
+    expect: { [field]: expectAllSorted },
+  })
+  test(`${field} when npm-run-all is a dev dependency`, macro.sortObject, {
+    value: {
+      [field]: fixture,
+      devDependencies: { 'npm-run-all': '^1.0.0' },
+    },
+    expect: {
+      [field]: expectPreAndPostSorted,
+      devDependencies: { 'npm-run-all': '^1.0.0' },
+    },
   })
 }