@pixpilot/scaffoldfy-configs 0.25.1 → 0.26.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @pixpilot/scaffoldfy-configs
 
+## 0.26.0
+
+### Minor Changes
+
+- add sorting task for root package.json
+
 ## 0.25.1
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/scaffoldfy-configs",
   "type": "module",
-  "version": "0.25.1",
+  "version": "0.26.0",
   "author": "PixPilot <m.doaie@hotmail.com>",
   "license": "MIT",
   "repository": {

package/test/update-root-package-json.test.ts

@@ -0,0 +1,68 @@
+import { execFileSync } from 'node:child_process';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { afterEach, describe, expect, it } from 'vitest';
+
+const scriptPath = path.join(
+  __dirname,
+  '..',
+  'update-root-package-json',
+  'scripts',
+  'sort-package-json.cjs',
+);
+const temporaryDirectories: string[] = [];
+
+afterEach(() => {
+  for (const directory of temporaryDirectories.splice(0)) {
+    fs.rmSync(directory, { force: true, recursive: true });
+  }
+});
+
+describe('sort-package-json', () => {
+  it('should place root package.json fields in the configured order', () => {
+    const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'scaffoldfy-configs-'));
+    temporaryDirectories.push(directory);
+    const packageJsonPath = path.join(directory, 'package.json');
+
+    fs.writeFileSync(
+      packageJsonPath,
+      JSON.stringify({
+        scripts: {},
+        engines: { node: '>=24.15.0', pnpm: '>=9.6.0' },
+        custom: true,
+        private: true,
+        name: 'pnpm-turbo-monorepo-template',
+        devDependencies: {},
+        repository: {
+          type: 'git',
+          url: 'https://github.com/pixpilot/pnpm-turbo-monorepo-template.git',
+        },
+        packageManager: 'pnpm@10.33.4',
+        prettier: '@internal/prettier-config',
+        author: 'Mo Doaie <m.doaie@hotmail.com>',
+        license: 'NONE',
+        homepage: 'https://github.com/pixpilot/pnpm-turbo-monorepo-template',
+        bugs: { url: 'https://github.com/pixpilot/pnpm-turbo-monorepo-template/issues' },
+      }),
+    );
+
+    execFileSync(process.execPath, [scriptPath, `--file=${packageJsonPath}`]);
+
+    expect(Object.keys(JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')))).toEqual([
+      'name',
+      'private',
+      'packageManager',
+      'prettier',
+      'author',
+      'license',
+      'homepage',
+      'repository',
+      'bugs',
+      'engines',
+      'scripts',
+      'devDependencies',
+      'custom',
+    ]);
+  });
+});

package/update-root-package-json/scaffoldfy.json

@@ -25,6 +25,18 @@
           "license": "{{licenseType}}"
         }
       }
+    },
+    {
+      "id": "sort-root-package",
+      "name": "Sort root package.json",
+      "description": "Sort root package.json fields into the standard project order",
+      "type": "exec-file",
+      "dependencies": ["update-root-package"],
+      "config": {
+        "file": "./scripts/sort-package-json.cjs",
+        "runtime": "node",
+        "args": ["--file=package.json"]
+      }
     }
   ]
 }

package/update-root-package-json/scripts/sort-package-json.cjs

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('node:fs');
+const process = require('node:process');
+
+const INDENT_SPACES = 2;
+const ROOT_PACKAGE_JSON_KEY_ORDER = [
+  'name',
+  'private',
+  'packageManager',
+  'prettier',
+  'author',
+  'license',
+  'homepage',
+  'repository',
+  'bugs',
+  'engines',
+  'scripts',
+  'devDependencies',
+];
+
+/** @param {string} prefix */
+function getArg(prefix) {
+  const arg = process.argv.find((value) => value.startsWith(prefix));
+  return arg?.slice(prefix.length);
+}
+
+const file = getArg('--file=');
+
+if (!file) {
+  console.error('Missing --file argument');
+  process.exit(1);
+}
+
+let packageJson;
+
+try {
+  packageJson = JSON.parse(fs.readFileSync(file, 'utf8'));
+} catch (error) {
+  console.error(`Failed to read package.json: ${error.message}`);
+  process.exit(1);
+}
+
+const orderedPackageJson = {};
+
+for (const key of ROOT_PACKAGE_JSON_KEY_ORDER) {
+  if (key in packageJson) {
+    orderedPackageJson[key] = packageJson[key];
+  }
+}
+
+for (const [key, value] of Object.entries(packageJson)) {
+  if (!(key in orderedPackageJson)) {
+    orderedPackageJson[key] = value;
+  }
+}
+
+fs.writeFileSync(file, `${JSON.stringify(orderedPackageJson, null, INDENT_SPACES)}\n`);