fix(prettier-plugin-pkg): group default lifecycle script hooks together (#503)

Author: porada

.changeset/witty-lions-decide.md

@@ -0,0 +1,5 @@
+---
+"prettier-plugin-pkg": patch
+---
+
+Fixed an omission in script sorting where default `pre`/`post` lifecycle scripts were treated as unrelated hooks and not sorted together.

packages/pkg/src/utils.ts

@@ -1,5 +1,23 @@
 import type { ObjectProperty, StringLiteral } from './types.js'
 
+/**
+ * The list of default lifecycle scripts defined by `npm`.
+ * @see https://docs.npmjs.com/cli/v11/using-npm/scripts
+ */
+const DEFAULT_LIFECYCLE_SCRIPTS = new Set([
+  'dependencies',
+  'install',
+  'pack',
+  'prepare',
+  'publish',
+  'restart',
+  'shrinkwrap',
+  'start',
+  'stop',
+  'test',
+  'version',
+])
+
 export function alphabetSort(a: number, b: number): number
 export function alphabetSort(a: string, b: string): number
 export function alphabetSort(a: number | string, b: number | string) {
@@ -17,15 +35,17 @@ const getScriptSortProps = (
   scriptName: string,
   allScriptNames: Set<string>,
 ) => {
-  // 1. Ensuring that `prepare` doesn’t get treated as `pare`
-  if (
-    scriptName.length > 3 &&
-    scriptName.startsWith('pre') &&
-    scriptName !== 'prepare' /* 1 */
-  ) {
+  if (DEFAULT_LIFECYCLE_SCRIPTS.has(scriptName)) {
+    return {
+      base: scriptName,
+      order: 0,
+    }
+  }
+
+  if (scriptName.length > 3 && scriptName.startsWith('pre')) {
     const base = scriptName.slice(3)
 
-    if (allScriptNames.has(base)) {
+    if (allScriptNames.has(base) || DEFAULT_LIFECYCLE_SCRIPTS.has(base)) {
       return {
         base,
         order: -1,
@@ -38,7 +58,7 @@ const getScriptSortProps = (
     // eslint-disable-next-line @typescript-eslint/no-magic-numbers
     const base = scriptName.slice(4)
 
-    if (allScriptNames.has(base)) {
+    if (allScriptNames.has(base) || DEFAULT_LIFECYCLE_SCRIPTS.has(base)) {
       return {
         base,
         order: 1,

packages/pkg/test/utils.spec.ts

@@ -4,78 +4,148 @@ describe('sortScriptNames', () => {
   test('sorts pre/post hooks around base script names', () => {
     expect(
       sortScriptNames([
-        /* prettier-ignore */
         'format',
         'postformat',
         'posttest',
         'preformat',
         'pretest',
         'test',
+        'watch', // control
+        'patch', // control
+        'migrate', // control
+        'ignore', // control
+        'build', // control
       ]),
     ).toEqual([
-      /* prettier-ignore */
+      'build', // control
       'preformat',
       'format',
       'postformat',
+      'ignore', // control
+      'migrate', // control
+      'patch', // control
       'pretest',
       'test',
       'posttest',
+      'watch', // control
     ])
   })
 
   test('ignores unmatched pre/post hooks', () => {
     expect(
       sortScriptNames([
-        /* prettier-ignore */
-        'postformat',
+        'postformat', // (unmatched)
         'posttest',
-        'prelint',
+        'prelint', // (unmatched)
         'pretest',
         'test',
+        'watch', // control
+        'patch', // control
+        'migrate', // control
+        'ignore', // control
+        'build', // control
       ]),
     ).toEqual([
-      /* prettier-ignore */
-      'postformat',
-      'prelint',
+      'build', // control
+      'ignore', // control
+      'migrate', // control
+      'patch', // control
+      'postformat', // (unmatched)
+      'prelint', // (unmatched)
       'pretest',
       'test',
       'posttest',
+      'watch', // control
     ])
 
     expect(
       sortScriptNames([
-        /* prettier-ignore */
         'test',
         'pre',
         'post',
+        'watch', // control
+        'patch', // control
+        'migrate', // control
+        'ignore', // control
+        'build', // control
       ]),
     ).toEqual([
-      /* prettier-ignore */
+      'build', // control
+      'ignore', // control
+      'migrate', // control
+      'patch', // control
       'post',
       'pre',
       'test',
+      'watch', // control
     ])
   })
 
   test('respects default lifecycle scripts', () => {
+    // `pare` isn’t grouped with `prepare`
     expect(
       sortScriptNames([
-        /* prettier-ignore */
         'postprepare',
         'prepare',
         'preprepare',
         'test',
         'postpare',
         'pare',
+        'watch', // control
+        'patch', // control
+        'migrate', // control
+        'ignore', // control
+        'build', // control
       ]),
     ).toEqual([
-      /* prettier-ignore */
+      'build', // control
+      'ignore', // control
+      'migrate', // control
       'pare',
       'postpare',
+      'patch', // control
       'preprepare',
       'prepare',
       'postprepare',
       'test',
+      'watch', // control
+    ])
+
+    // DLS hooks are grouped together even though their base is missing
+    expect(
+      sortScriptNames([
+        'test',
+        'postversion', // (single DLS hook)
+        'postinstall',
+        'postmerge', // (not a DLS)
+        'postpack',
+        'posttest',
+        'preinstall',
+        'premerge', // (not a DLS)
+        'prepack',
+        'pretest',
+        'watch', // control
+        'patch', // control
+        'migrate', // control
+        'ignore', // control
+        'build', // control
+      ]),
+    ).toEqual([
+      'build', // control
+      'ignore', // control
+      'preinstall',
+      'postinstall',
+      'migrate', // control
+      'prepack',
+      'postpack',
+      'patch', // control
+      'postmerge', // (not a DLS)
+      'premerge', // (not a DLS)
+      'pretest',
+      'test',
+      'posttest',
+      'postversion', // (single DLS hook)
+      'watch', // control
     ])
   })
 })