@dotcom-tool-kit/package-json-hook 2.1.1 → 4.0.0

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

@@ -1,12 +1,27 @@
 import { Hook } from '@dotcom-tool-kit/types';
-import type { PackageJson } from '@financial-times/package-json';
-export declare abstract class PackageJsonHelper extends Hook {
-    _packageJson?: PackageJson;
-    abstract field: string;
+interface PackageJson {
+    [field: string]: PackageJson | string;
+}
+interface PackageJsonStateValue {
+    hooks: string[];
+    trailingString: string;
+}
+interface PackageJsonState {
+    [field: string]: PackageJsonState | PackageJsonStateValue;
+}
+export declare abstract class PackageJsonHelper extends Hook<PackageJsonState> {
+    private _packageJson?;
+    abstract field: string | string[];
     abstract key: string;
     abstract hook: string;
-    get packageJson(): PackageJson;
+    trailingString?: string;
+    installGroup: string;
+    filepath: string;
+    getPackageJson(): Promise<PackageJson>;
+    private get hookPath();
     check(): Promise<boolean>;
-    abstract install(): Promise<void>;
+    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,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAQhE,8BAAsB,iBAAkB,SAAQ,IAAI;IACnD,YAAY,CAAC,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,IAAI,WAAW,IAAI,WAAW,CAO7B;IAEK,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAK/B,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAChC"}
+{"version":3,"file":"package-json-helper.d.ts","sourceRoot":"","sources":["../src/package-json-helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAQ7C,UAAU,WAAW;IACnB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAAA;CACtC;AAED,UAAU,qBAAqB;IAC7B,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,UAAU,gBAAgB;IACxB,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,qBAAqB,CAAA;CAC1D;AAED,8BAAsB,iBAAkB,SAAQ,IAAI,CAAC,gBAAgB,CAAC;IACpE,OAAO,CAAC,YAAY,CAAC,CAAa;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAIrB,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB,YAAY,SAAiB;IAE7B,QAAQ,SAA8C;IAEhD,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAW5C,OAAO,KAAK,QAAQ,GAEnB;IAEK,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAKzB,OAAO,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAU5D,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAa5D"}

package/lib/package-json-helper.js

@@ -3,20 +3,53 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PackageJsonHelper = void 0;
 const tslib_1 = require("tslib");
 const types_1 = require("@dotcom-tool-kit/types");
-const package_json_1 = (0, tslib_1.__importDefault)(require("@financial-times/package-json"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const get_1 = tslib_1.__importDefault(require("lodash/get"));
+const mapValues_1 = tslib_1.__importDefault(require("lodash/mapValues"));
+const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
+const update_1 = tslib_1.__importDefault(require("lodash/update"));
+const path_1 = tslib_1.__importDefault(require("path"));
 class PackageJsonHelper extends types_1.Hook {
-    get packageJson() {
+    constructor() {
+        super(...arguments);
+        this.installGroup = 'package-json';
+        this.filepath = path_1.default.resolve(process.cwd(), 'package.json');
+    }
+    async getPackageJson() {
         if (!this._packageJson) {
-            const filepath = path_1.default.resolve(process.cwd(), 'package.json');
-            this._packageJson = (0, package_json_1.default)({ filepath });
+            const rawPackageJson = await fs_1.default.promises.readFile(this.filepath, 'utf8');
+            const packageJson = JSON.parse(rawPackageJson);
+            this._packageJson = packageJson;
+            return packageJson;
         }
         return this._packageJson;
     }
+    get hookPath() {
+        return Array.isArray(this.field) ? [...this.field, this.key] : [this.field, this.key];
+    }
     async check() {
         var _a;
-        const commands = this.packageJson.getField(this.field);
-        return (_a = commands === null || commands === void 0 ? void 0 : commands[this.key]) === null || _a === void 0 ? void 0 : _a.includes(this.hook);
+        const packageJson = await this.getPackageJson();
+        return (_a = (0, get_1.default)(packageJson, this.hookPath)) === null || _a === void 0 ? void 0 : _a.includes(this.hook);
+    }
+    async install(state) {
+        state !== null && state !== void 0 ? state : (state = {});
+        // prepend each hook to maintain the same order as previous implementations
+        (0, update_1.default)(state, this.hookPath, (hookState) => {
+            var _a;
+            return ({
+                hooks: [this.hook, ...((_a = hookState === null || hookState === void 0 ? void 0 : hookState.hooks) !== null && _a !== void 0 ? _a : [])],
+                trailingString: this.trailingString
+            });
+        });
+        return state;
+    }
+    async commitInstall(state) {
+        const reduceHooks = (state) => (0, mapValues_1.default)(state, (field) => Array.isArray(field === null || field === void 0 ? void 0 : field.hooks)
+            ? `dotcom-tool-kit ${field.hooks.join(' ')}${field.trailingString ? ' ' + field.trailingString : ''}`
+            : reduceHooks(field));
+        const newPackageJson = (0, merge_1.default)(await this.getPackageJson(), reduceHooks(state));
+        await fs_1.default.promises.writeFile(this.filepath, JSON.stringify(newPackageJson, null, 2) + '\n');
     }
 }
 exports.PackageJsonHelper = PackageJsonHelper;

package/lib/script-hook.d.ts

@@ -1,6 +1,5 @@
 import { PackageJsonHelper } from './package-json-helper';
 export declare abstract class PackageJsonScriptHook extends PackageJsonHelper {
     field: string;
-    install(): Promise<void>;
 }
 //# sourceMappingURL=script-hook.d.ts.map

package/lib/script-hook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"script-hook.d.ts","sourceRoot":"","sources":["../src/script-hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAMzD,8BAAsB,qBAAsB,SAAQ,iBAAiB;IACnE,KAAK,SAAY;IAEX,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAa/B"}
+{"version":3,"file":"script-hook.d.ts","sourceRoot":"","sources":["../src/script-hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAEzD,8BAAsB,qBAAsB,SAAQ,iBAAiB;IACnE,KAAK,SAAY;CAClB"}

package/lib/script-hook.js

@@ -7,17 +7,5 @@ class PackageJsonScriptHook extends package_json_helper_1.PackageJsonHelper {
         super(...arguments);
         this.field = 'scripts';
     }
-    async install() {
-        let command = `dotcom-tool-kit ${this.hook}`;
-        const existingCommand = this.packageJson.getField(this.field)[this.key];
-        if (existingCommand && existingCommand.startsWith('dotcom-tool-kit ')) {
-            command = command.concat(existingCommand.replace('dotcom-tool-kit', ''));
-        }
-        this.packageJson.requireScript({
-            stage: this.key,
-            command
-        });
-        this.packageJson.writeChanges();
-    }
 }
 exports.PackageJsonScriptHook = PackageJsonScriptHook;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/package-json-hook",
-  "version": "2.1.1",
+  "version": "4.0.0",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -11,6 +11,7 @@
   "license": "ISC",
   "dependencies": {
     "@financial-times/package-json": "^3.0.0",
+    "lodash": "^4.17.21",
     "tslib": "^2.3.1"
   },
   "repository": {
@@ -22,6 +23,7 @@
   "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/lib/package-json-hook",
   "devDependencies": {
     "@jest/globals": "^27.4.6",
+    "@types/lodash": "^4.14.185",
     "winston": "^3.5.1"
   },
   "files": [