feat: sort wireit (#402)

Author: jonahsnider

defaultRules.md

@@ -53,6 +53,7 @@ _Note: when a specific key order is used, any other keys will be sorted in the e
 | binary,               | Key order: `module_name`, `module_path`, `remote_path`, `package_name`, `host` |
 | scripts               | [Script sort](#scripts)                                                        |
 | betterScripts         | [Script sort](#scripts)                                                        |
+| wireit                | [Wireit sort](#wireit)                                                         |
 | contributes           | Key sort                                                                       |
 | activationEvents      | Unique items                                                                   |
 | husky                 | Sorts the `hooks` field using [git hook sort](#git-hooks)                      |
@@ -161,6 +162,18 @@ Item order:
 
 Keys are sorted alphabetically except for `overrides`, which is placed last. Keys are also sorted in `overrides` and `overrides.options` items.
 
+### Wireit
+
+Script names are sorted alphabetically. Each script's properties use the order from [wireit's own examples](https://github.com/google/wireit), with remaining properties sorted alphabetically:
+
+| Key          | Rules                                        |
+| ------------ | -------------------------------------------- |
+| command      |                                              |
+| dependencies | Key order (per item): `script`, `cascade`    |
+| files        |                                              |
+| output       |                                              |
+| _remaining_  | Alphabetical, with nested object key sorting |
+
 ### Scripts
 
 Keys are sorted alphabetically except for [pre/post scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts#pre--post-scripts). Those are placed before and after their corresponding base npm script.

index.js

@@ -252,6 +252,43 @@ const sortPrettierConfig = pipe([
 ])
 
 const sortVolta = sortObjectBy(['node', 'npm', 'yarn'])
+
+// https://github.com/google/wireit
+const wireitScriptProperties = ['command', 'dependencies', 'files', 'output']
+const sortWireitScript = pipe([
+  sortObjectBy(wireitScriptProperties),
+  overProperty(
+    'dependencies',
+    onArray((deps) => deps.map(sortObjectBy(['script', 'cascade']))),
+  ),
+  overProperty(
+    'env',
+    onObject((env) =>
+      sortObjectKeys(
+        Object.fromEntries(
+          Object.entries(env).map(([key, value]) => [
+            key,
+            sortObjectBy(['external', 'default'])(value),
+          ]),
+        ),
+      ),
+    ),
+  ),
+  overProperty(
+    'service',
+    pipe([sortObjectBy(['readyWhen']), overProperty('readyWhen', sortObject)]),
+  ),
+])
+const sortWireit = onObject((wireit) =>
+  sortObjectKeys(
+    Object.fromEntries(
+      Object.entries(wireit).map(([name, config]) => [
+        name,
+        sortWireitScript(config),
+      ]),
+    ),
+  ),
+)
 const sortDevEngines = overProperty(
   'packageManager',
   sortObjectBy(['name', 'version', 'onFail']),
@@ -479,6 +516,7 @@ const fields = [
   },
   { key: 'scripts', over: sortScripts },
   { key: 'betterScripts', over: sortScripts },
+  { key: 'wireit', over: sortWireit },
   /* vscode */ { key: 'l10n' },
   /* vscode */ { key: 'contributes', over: sortObject },
   /* vscode */ { key: 'activationEvents', over: uniq },

tests/fields.js

@@ -258,6 +258,54 @@ test('badges', (t) => {
   )
 })
 
+test('wireit', macro.sortObject, {
+  path: 'wireit',
+  value: {
+    test: {
+      dependencies: ['build'],
+      command: 'jest',
+    },
+    build: {
+      output: ['lib/**'],
+      env: {
+        NODE_ENV: 'production',
+        CI: { default: 'false', external: true },
+      },
+      files: ['src/**/*.ts'],
+      service: {
+        readyWhen: { lineMatches: 'server started', z: 'z', a: 'a' },
+      },
+      allowUsuallyExcludedPaths: false,
+      packageLocks: ['pnpm-lock.yaml'],
+      clean: true,
+      dependencies: [{ cascade: false, script: '../foo:build' }, 'lint'],
+      command: 'tsc',
+    },
+  },
+  expect: {
+    build: {
+      command: 'tsc',
+      dependencies: [{ script: '../foo:build', cascade: false }, 'lint'],
+      files: ['src/**/*.ts'],
+      output: ['lib/**'],
+      allowUsuallyExcludedPaths: false,
+      clean: true,
+      env: {
+        CI: { external: true, default: 'false' },
+        NODE_ENV: 'production',
+      },
+      packageLocks: ['pnpm-lock.yaml'],
+      service: {
+        readyWhen: { a: 'a', lineMatches: 'server started', z: 'z' },
+      },
+    },
+    test: {
+      command: 'jest',
+      dependencies: ['build'],
+    },
+  },
+})
+
 test('pnpm', macro.sortObject, {
   path: 'pnpm',
   value: {

tests/snapshots/main.js.md

@@ -118,6 +118,7 @@ Generated by [AVA](https://avajs.dev).
         "unpkg": "unpkg",␊
         "version": "version",␊
         "volta": "volta",␊
+        "wireit": "wireit",␊
         "workspaces": "workspaces",␊
         "xo": "xo"␊
       }`,
@@ -171,6 +172,7 @@ Generated by [AVA](https://avajs.dev).
         "binary": "binary",␊
         "scripts": "scripts",␊
         "betterScripts": "betterScripts",␊
+        "wireit": "wireit",␊
         "l10n": "l10n",␊
         "contributes": "contributes",␊
         "activationEvents": "activationEvents",␊