fix(scripts): properly sort pre scripts before base scripts beyond categorized scripts

Author: travi

src/package/scripts/script-comparator.js

@@ -10,13 +10,14 @@ function isPostScriptFor(a, b) {
   return isRelatedScript(a, b, 'post');
 }
 
-function getBaseScriptOf(script) {
+function stripPrefix(script) {
   if (script.startsWith('pre')) return script.slice(3);
   if (script.startsWith('post')) return script.slice(4);
   return script;
 }
 
-function getCategoryOrder(base) {
+function getCategoryOrder(script) {
+  const base = stripPrefix(script);
   if ('test' === base) return 0;
   if (base.startsWith('lint:')) return 1;
   if (base.startsWith('test:unit')) return 2;
@@ -32,14 +33,14 @@ export default function compareScriptNames(a, b) {
   if (isPostScriptFor(a, b)) return 1;
   if (isPostScriptFor(b, a)) return -1;
 
-  const aBase = getBaseScriptOf(a);
-  const bBase = getBaseScriptOf(b);
-
-  const categoryDiff = getCategoryOrder(aBase) - getCategoryOrder(bBase);
+  const categoryDiff = getCategoryOrder(a) - getCategoryOrder(b);
   if (0 !== categoryDiff) return 0 > categoryDiff ? -1 : 1;
 
-  const aKey = bBase === aBase || b === aBase || aBase.startsWith(`${b}:`) ? aBase : a;
-  const bKey = aBase === bBase || a === bBase || bBase.startsWith(`${a}:`) ? bBase : b;
+  const aStripped = stripPrefix(a);
+  const bStripped = stripPrefix(b);
+
+  const aKey = aStripped.startsWith(`${b}:`) ? aStripped : a;
+  const bKey = bStripped.startsWith(`${a}:`) ? bStripped : b;
 
   return aKey.localeCompare(bKey);
 }

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

@@ -89,6 +89,9 @@ describe('script name comparator', () => {
   it('should sort `test:unit` sub-scripts after `test:unit`', async () => {
     expect(compareScriptNames('test:unit', 'test:unit:base')).toEqual(A_BEFORE_B);
     expect(compareScriptNames('test:unit:base', 'test:unit')).toEqual(A_AFTER_B);
+
+    expect(compareScriptNames('test:unit', 'pretest:unit:base')).toEqual(A_BEFORE_B);
+    expect(compareScriptNames('pretest:unit:base', 'test:unit')).toEqual(A_AFTER_B);
   });
 
   it('should sort `test:integration` sub-scripts after `test:integration`', async () => {

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

@@ -5,7 +5,8 @@ import {Before, Given, Then} from '@cucumber/cucumber';
 
 Before(function () {
   this.existingScripts = {
-    ...any.simpleObject(),
+    aaa: any.string(),
+    zzz: any.string(),
     test: any.string(),
     'lint:md': any.string(),
     prepare: any.string(),
@@ -14,8 +15,10 @@ Before(function () {
     'test:integration:base': any.string(),
     'test:integration:debug': any.string(),
     'test:integration:focus': any.string(),
+    build: any.string(),
     'test:integration:focus:debug': any.string(),
     'test:integration:wip': any.string(),
+    prebuild: any.string(),
     'test:integration:wip:debug': any.string(),
     'test:unit': any.string(),
     pretest: any.string(),
@@ -83,23 +86,6 @@ Then('the updated test script includes build', async function () {
 
 Then('the scripts are ordered correctly', async function () {
   const {scripts} = JSON.parse(await fs.readFile(`${process.cwd()}/package.json`, 'utf8'));
-  const {
-    pretest,
-    test,
-    'test:unit': testUnit,
-    'test:integration': testIntegration,
-    'pretest:integration:base': pretestIntegrationBase,
-    'test:integration:base': testIntegrationBase,
-    'test:integration:debug': testIntegrationDebug,
-    'test:integration:focus': testIntegrationFocus,
-    'test:unit:base': testUnitBase,
-    'test:integration:focus:debug': testIntegrationFocusDebug,
-    'test:integration:wip': testIntegrationWip,
-    'test:integration:wip:debug': testIntegrationWipDebug,
-    'prelint:publish': prelintPublish,
-    'lint:md': lintMd,
-    ...otherExistingScripts
-  } = this.existingScripts;
 
   assert.deepEqual(
     Object.keys(scripts),
@@ -120,7 +106,11 @@ Then('the scripts are ordered correctly', async function () {
       'test:integration:focus:debug',
       'test:integration:wip',
       'test:integration:wip:debug',
-      ...Object.keys(otherExistingScripts).sort((a, b) => a.localeCompare(b))
+      'aaa',
+      'prebuild',
+      'build',
+      'prepare',
+      'zzz'
     ]
   );
 });