feat(npm-scripts): sort test scripts above other scripts

Author: travi

src/package/scripts/script-comparator.js

@@ -18,6 +18,14 @@ function getBaseScriptOf(script) {
   return script.replace(/^(?:pre|post)/, '');
 }
 
+function getCategoryOrder(base) {
+  if (base.startsWith('lint:')) return 0;
+  if ('test:unit' === base) return 1;
+  if ('test:integration' === base) return 2;
+  if (base.startsWith('test:')) return 1;
+  return 3;
+}
+
 export default function compareScriptNames(a, b) {
   if (isPreScriptFor(a, b)) return -1;
   if (isPreScriptFor(b, a)) return 1;
@@ -35,21 +43,8 @@ export default function compareScriptNames(a, b) {
   const aBase = getBaseScriptOf(a);
   const bBase = getBaseScriptOf(b);
 
-  if (aBase.startsWith('lint:') && bBase.startsWith('test:')) {
-    return -1;
-  }
-
-  if (bBase.startsWith('lint:') && aBase.startsWith('test:')) {
-    return 1;
-  }
-
-  if (aBase.startsWith('lint:') && !bBase.startsWith('lint:')) {
-    return -1;
-  }
-
-  if (bBase.startsWith('lint:') && !aBase.startsWith('lint:')) {
-    return 1;
-  }
+  const categoryDiff = getCategoryOrder(aBase) - getCategoryOrder(bBase);
+  if (0 !== categoryDiff) return 0 > categoryDiff ? -1 : 1;
 
   return a.localeCompare(b);
 }

src/package/scripts/script-comparator.test.js

@@ -66,4 +66,14 @@ describe('script name comparator', () => {
     expect(compareScriptNames(any.word(), `lint:${any.word()}`)).toEqual(A_AFTER_B);
     expect(compareScriptNames(`lint:${any.word()}`, any.word())).toEqual(A_BEFORE_B);
   });
+
+  it('should sort `test:unit` ahead of `test:integration`', async () => {
+    expect(compareScriptNames('test:unit', 'test:integration')).toEqual(A_BEFORE_B);
+    expect(compareScriptNames('test:integration', 'test:unit')).toEqual(A_AFTER_B);
+  });
+
+  it('should sort uncategorized scripts below `test:` scripts', async () => {
+    expect(compareScriptNames(any.word(), `test:${any.word()}`)).toEqual(A_AFTER_B);
+    expect(compareScriptNames(`test:${any.word()}`, any.word())).toEqual(A_BEFORE_B);
+  });
 });

test/integration/features/lift/script-ordering.feature

@@ -0,0 +1,9 @@
+Feature: Script Ordering
+
+  Scenario: ensure scripts are ordered correctly
+    Given an "npm" lockfile exists
+    And the project is versioned on GitHub
+    And the project is of type "Package"
+    And husky v5 is installed
+    When the scaffolder results are processed
+    Then the scripts are ordered correctly

test/integration/features/step_definitions/scripts-steps.js

@@ -4,7 +4,15 @@ import {assert} from 'chai';
 import {Before, Given, Then} from '@cucumber/cucumber';
 
 Before(function () {
-  this.existingScripts = {...any.simpleObject(), test: any.string()};
+  this.existingScripts = {
+    ...any.simpleObject(),
+    test: any.string(),
+    'lint:md': any.string(),
+    prepare: any.string(),
+    'test:unit': any.string(),
+    'prelint:publish': 'run-s build',
+    'test:integration': any.string()
+  };
 });
 
 Given('no additional scripts are included in the results', async function () {
@@ -63,3 +71,29 @@ Then('the updated test script includes build', async function () {
   assert.equal(pretest, 'run-s build');
   assert.notInclude(test, 'build');
 });
+
+Then('the scripts are ordered correctly', async function () {
+  const {scripts} = JSON.parse(await fs.readFile(`${process.cwd()}/package.json`, 'utf8'));
+  const {
+    test,
+    'test:unit': testUnit,
+    'test:integration': testIntegration,
+    'prelint:publish': prelintPublish,
+    'lint:md': lintMd,
+    ...otherExistingScripts
+  } = this.existingScripts;
+
+  assert.deepEqual(
+    Object.keys(scripts),
+    [
+      'test',
+      'lint:lockfile',
+      'lint:md',
+      'prelint:publish',
+      'lint:publish',
+      'test:unit',
+      'test:integration',
+      ...Object.keys(otherExistingScripts).sort((a, b) => a.localeCompare(b))
+    ]
+  );
+});