@dotcom-tool-kit/package-json-hook 5.1.7 → 5.2.1

package/lib/package-json-helper.d.ts

@@ -1,8 +1,8 @@
 import type { z } from 'zod';
 import { Hook, HookInstallation } from '@dotcom-tool-kit/base';
 import type { Plugin } from '@dotcom-tool-kit/plugin';
-import { PackageJsonSchema } from '@dotcom-tool-kit/schemas/lib/hooks/package-json';
 import { Conflict } from '@dotcom-tool-kit/conflict';
+import { PackageJsonSchema } from './schema';
 interface PackageJsonContents {
     [field: string]: PackageJsonContents | string;
 }
@@ -14,6 +14,7 @@ interface PackageJsonStateValue {
 interface PackageJsonState {
     [path: string]: PackageJsonStateValue;
 }
+export { PackageJsonSchema as schema };
 export default class PackageJson extends Hook<{
     hook: typeof PackageJsonSchema;
 }, PackageJsonState> {
@@ -27,5 +28,4 @@ export default class PackageJson extends Hook<{
     install(state?: PackageJsonState): Promise<PackageJsonState>;
     commitInstall(state: PackageJsonState): Promise<void>;
 }
-export {};
 //# sourceMappingURL=package-json-helper.d.ts.map

package/lib/package-json-helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"package-json-helper.d.ts","sourceRoot":"","sources":["../src/package-json-helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AASrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iDAAiD,CAAA;AACnF,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAEhE,UAAU,mBAAmB;IAC3B,CAAC,KAAK,EAAE,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAA;CAC9C;AAED,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,EAAE,WAAW,CAAA;CACzB;AAED,UAAU,gBAAgB;IACxB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAA;CACtC;AAuED,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,IAAI,CAAC;IAAE,IAAI,EAAE,OAAO,iBAAiB,CAAA;CAAE,EAAE,gBAAgB,CAAC;IACjG,OAAO,CAAC,YAAY,CAAC,CAAqB;IAE1C,YAAY,SAAiB;IAE7B,QAAQ,SAA8C;IAEtD,MAAM,CAAC,uBAAuB,CAC5B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,CAChB,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GACpD,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CACjE,EAAE,GACF,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAexF,MAAM,CAAC,0BAA0B,CAC/B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,EACxE,kBAAkB,EAAE,CAChB,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GACpD,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CACjE,EAAE,GACF,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAsBlF,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAW9C,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAmC/B,OAAO,CAAC,KAAK,GAAE,gBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgChE,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAe5D"}
+{"version":3,"file":"package-json-helper.d.ts","sourceRoot":"","sources":["../src/package-json-helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AASrD,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAEhE,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,UAAU,mBAAmB;IAC3B,CAAC,KAAK,EAAE,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAA;CAC9C;AAED,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,EAAE,WAAW,CAAA;CACzB;AAED,UAAU,gBAAgB;IACxB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAA;CACtC;AAuED,OAAO,EAAE,iBAAiB,IAAI,MAAM,EAAE,CAAA;AAEtC,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,IAAI,CAAC;IAAE,IAAI,EAAE,OAAO,iBAAiB,CAAA;CAAE,EAAE,gBAAgB,CAAC;IACjG,OAAO,CAAC,YAAY,CAAC,CAAqB;IAE1C,YAAY,SAAiB;IAE7B,QAAQ,SAA8C;IAEtD,MAAM,CAAC,uBAAuB,CAC5B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,CAChB,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GACpD,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CACjE,EAAE,GACF,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAexF,MAAM,CAAC,0BAA0B,CAC/B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,EACxE,kBAAkB,EAAE,CAChB,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GACpD,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CACjE,EAAE,GACF,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAsBlF,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAW9C,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAmC/B,OAAO,CAAC,KAAK,GAAE,gBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgChE,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAe5D"}

package/lib/package-json-helper.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
 const tslib_1 = require("tslib");
 const base_1 = require("@dotcom-tool-kit/base");
 const fs_1 = tslib_1.__importDefault(require("fs"));
@@ -10,6 +11,8 @@ const update_1 = tslib_1.__importDefault(require("lodash/update"));
 const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const conflict_1 = require("@dotcom-tool-kit/conflict");
+const schema_1 = require("./schema");
+Object.defineProperty(exports, "schema", { enumerable: true, get: function () { return schema_1.PackageJsonSchema; } });
 function installationsOverlap(installation, other) {
     for (const [field, object] of Object.entries(installation.options)) {
         for (const key of Object.keys(object)) {

package/lib/schema.d.ts

@@ -0,0 +1,12 @@
+import * as z from 'zod';
+export declare const PackageJsonSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString]>, z.ZodObject<{
+    commands: z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString]>;
+    trailingString: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    commands: string | string[];
+    trailingString: string;
+}, {
+    commands: string | string[];
+    trailingString: string;
+}>]>>>;
+//# sourceMappingURL=schema.d.ts.map

package/lib/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAGxB,eAAO,MAAM,iBAAiB;;;;;;;;;MA4C5B,CAAA"}

package/lib/schema.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageJsonSchema = void 0;
+const tslib_1 = require("tslib");
+const z = tslib_1.__importStar(require("zod"));
+const CommandListSchema = z.union([z.array(z.string()), z.string()]);
+exports.PackageJsonSchema = z.record(z.record(z.union([
+    CommandListSchema,
+    z.object({
+        commands: CommandListSchema,
+        trailingString: z.string()
+    })
+])))
+    .describe(`This hook accepts a nested object with a structure that matches the generated output in \`package.json\`. The values are used as Tool Kit command names to run. You can provide a single command or an array; multiple commands are concatenated in order.
+
+For more complex use cases, you can provide an object instead of a command. The object must contain keys \`commands\` (as above), and \`trailingString\` (which will be appended to the resulting \`dotcom-tool-kit\` CLI invocation). This is useful for tasks that accept a list of files after a trailing \`--\`.
+
+Options provided in your repository's \`.toolkitrc.yml\` for this hook are merged with any Tool Kit plugin that also provides options for the hook.
+
+For example, configuring this hook with the following options:
+
+~~~yml
+options:
+  hooks:
+    - PackageJson:
+        scripts:
+          start: 'run:local'
+          customScript:
+            commands:
+              - custom:one
+              - custom:two
+            trailingString: '--'
+~~~
+
+will result in the following output in \`package.json\`:
+
+~~~json
+{
+  "scripts": {
+    "start": "dotcom-tool-kit run:local",
+    "customScript": "dotcom-tool-kit custom:one custom:two --"
+  }
+}
+~~~
+
+<!-- hide autogenerated schema docs -->
+`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/package-json-hook",
-  "version": "5.1.7",
+  "version": "5.2.1",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -10,12 +10,13 @@
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotcom-tool-kit/base": "^1.1.9",
-    "@dotcom-tool-kit/conflict": "^1.0.0",
-    "@dotcom-tool-kit/plugin": "^1.0.0",
+    "@dotcom-tool-kit/base": "^1.2.0",
+    "@dotcom-tool-kit/conflict": "^1.0.1",
+    "@dotcom-tool-kit/plugin": "^1.1.0",
     "@financial-times/package-json": "^3.0.0",
     "lodash": "^4.17.21",
-    "tslib": "^2.3.1"
+    "tslib": "^2.3.1",
+    "zod": "^3.22.4"
   },
   "repository": {
     "type": "git",
@@ -28,11 +29,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@dotcom-tool-kit/schemas": "^1.9.0",
     "@jest/globals": "^27.4.6",
     "@types/lodash": "^4.14.185",
-    "winston": "^3.5.1",
-    "zod": "^3.22.4"
+    "winston": "^3.5.1"
   },
   "files": [
     "/lib",

package/readme.md

@@ -15,7 +15,7 @@ Install `@dotcom-tool-kit/package-json-hook` as a `devDependency` in your app:
 npm install --save-dev @dotcom-tool-kit/package-json-hook
 ```
 
-Add the plugin to your [Tool Kit configuration](https://github.com/financial-times/dotcom-tool-kit/blob/main/readme.md#configuration):
+Add the plugin to your [Tool Kit configuration](https://github.com/financial-times/dotcom-tool-kit/blob/main/readme.md#configuring-tool-kit):
 
 ```yaml
 plugins: