@dotcom-tool-kit/base 4.0.0-beta.0 → 4.0.0-beta.2

package/CHANGELOG.md

@@ -0,0 +1,220 @@
+# Changelog
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.3 to ^1.0.4
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/validated bumped from ^1.0.1 to ^1.0.2
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.4 to ^1.0.5
+    * @dotcom-tool-kit/logger bumped from ^4.0.1 to ^4.1.0
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.5 to ^1.0.6
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.6 to ^1.0.7
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.8 to ^1.0.9
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.9 to ^1.0.10
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.10 to ^1.0.11
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.11 to ^1.0.12
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/conflict bumped from ^1.0.0 to ^1.0.1
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.12 to ^1.1.0
+    * @dotcom-tool-kit/plugin bumped from ^1.0.0 to ^1.1.0
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/logger bumped from ^4.1.1 to ^4.2.0
+
+## [2.0.1](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v2.0.0...base-v2.0.1) (2026-01-09)
+
+
+### Bug Fixes
+
+* it's not a conflict if there's only one child installation lol ([afa7863](https://github.com/Financial-Times/dotcom-tool-kit/commit/afa7863554744a65887507e9fea52b203fbb8cbb))
+
+## [2.0.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.3.1...base-v2.0.0) (2025-10-28)
+
+
+### ⚠ BREAKING CHANGES
+
+* declare Node engines in all libraries
+
+### Features
+
+* declare Node engines in all libraries ([648d4d0](https://github.com/Financial-Times/dotcom-tool-kit/commit/648d4d0267d329655056ad38614b6659c80f5409))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/conflict bumped from ^1.0.1 to ^2.0.0
+    * @dotcom-tool-kit/logger bumped from ^4.2.2 to ^5.0.0
+    * @dotcom-tool-kit/validated bumped from ^1.0.3 to ^2.0.0
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.1.1 to ^2.0.0
+    * @dotcom-tool-kit/plugin bumped from ^1.1.0 to ^2.0.0
+
+## [1.3.1](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.3.0...base-v1.3.1) (2025-10-09)
+
+
+### Bug Fixes
+
+* bump semver from 7.7.2 to 7.7.3 ([f37e915](https://github.com/Financial-Times/dotcom-tool-kit/commit/f37e915f184786c24dfe6095d3a54267c0738e5b))
+
+## [1.3.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.2.3...base-v1.3.0) (2025-08-12)
+
+
+### Features
+
+* add a Task.stop method and stop parallel tasks on error ([9d33d02](https://github.com/Financial-Times/dotcom-tool-kit/commit/9d33d02e734c04886d7e491e47bdac9f839ed509))
+
+## [1.2.3](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.2.2...base-v1.2.3) (2025-05-20)
+
+
+### Bug Fixes
+
+* bump semver from 7.7.1 to 7.7.2 ([9f82a24](https://github.com/Financial-Times/dotcom-tool-kit/commit/9f82a24fca533d05ec0fad171ca2b72dc3d0fb96))
+* bump winston from 3.14.2 to 3.17.0 ([c0bc4c7](https://github.com/Financial-Times/dotcom-tool-kit/commit/c0bc4c71af06ac26323c826f24896e735591ac1a))
+* bump zod from 3.24.3 to 3.24.4 ([2059a64](https://github.com/Financial-Times/dotcom-tool-kit/commit/2059a64ff9ab1b246f5b4e6b5b66f465be596b9e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/logger bumped from ^4.2.1 to ^4.2.2
+
+## [1.2.2](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.2.1...base-v1.2.2) (2025-05-06)
+
+
+### Bug Fixes
+
+* bump zod from 3.24.2 to 3.24.3 ([21ecd2c](https://github.com/Financial-Times/dotcom-tool-kit/commit/21ecd2ccaf42f11a78e0b6f06f5ef2352aa91703))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/logger bumped from ^4.2.0 to ^4.2.1
+    * @dotcom-tool-kit/validated bumped from ^1.0.2 to ^1.0.3
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.1.0 to ^1.1.1
+
+## [1.2.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.1.10...base-v1.2.0) (2025-03-03)
+
+
+### Features
+
+* **base:** pass cwd into init method ([b6cc028](https://github.com/Financial-Times/dotcom-tool-kit/commit/b6cc028129138869866f88860d544f5056668080))
+
+## [1.1.5](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.1.4...base-v1.1.5) (2025-01-14)
+
+
+### Bug Fixes
+
+* **base:** move logger dependency to prod ([c1c8a57](https://github.com/Financial-Times/dotcom-tool-kit/commit/c1c8a57e2e459e13b37efd519a80ff60835bde72))
+* **cli:** try to always log ToolKitError details if present ([0d4f2b4](https://github.com/Financial-Times/dotcom-tool-kit/commit/0d4f2b4cf7de12a290b19c13ad7be27b41197896))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/logger bumped from ^4.1.0 to ^4.1.1
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.7 to ^1.0.8
+
+## [1.1.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/base-v1.0.0...base-v1.1.0) (2024-12-09)
+
+
+### Features
+
+* pass config into taskruncontext ([435ffbc](https://github.com/Financial-Times/dotcom-tool-kit/commit/435ffbc74a81bdd159d4ea01943c6614ed1d3471))
+* pass current command into task run context ([e4cf21c](https://github.com/Financial-Times/dotcom-tool-kit/commit/e4cf21c8c4e502b02918736b8b127097dba27572))
+* pass task cwd through via TaskRunContext ([b12fe30](https://github.com/Financial-Times/dotcom-tool-kit/commit/b12fe30916e99e157e131a99fca6c59960b89f3a))
+
+
+### Bug Fixes
+
+* freeze the config before passing it into tasks ([a0283b9](https://github.com/Financial-Times/dotcom-tool-kit/commit/a0283b9b5a48314a26ce04ce4c176ab5f4aacc07))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @dotcom-tool-kit/validated bumped from ^1.0.0 to ^1.0.1
+  * devDependencies
+    * @dotcom-tool-kit/config bumped from ^1.0.2 to ^1.0.3
+    * @dotcom-tool-kit/logger bumped from ^4.0.0 to ^4.0.1
+
+## 1.0.0 (2024-09-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* pass task files in as part of a run context object
+* rename Task#options to pluginOptions
+* move base classes into their own package
+
+### Features
+
+* allow tasks to receive a task options object and parse task schema when initialising ([1dce6bd](https://github.com/Financial-Times/dotcom-tool-kit/commit/1dce6bd5e8436bf521e94eb812aa847ca7dd1e4d))
+* move base classes into their own package ([be1681b](https://github.com/Financial-Times/dotcom-tool-kit/commit/be1681b033609a9e332ab072681b6de8d05befb2))
+* split remaining bits of types into config and plugins packages ([6cde9b9](https://github.com/Financial-Times/dotcom-tool-kit/commit/6cde9b90d4cd02383ae1b18ca38e0843e6c3d3ab))
+
+
+### Code Refactoring
+
+* pass task files in as part of a run context object ([5aa7327](https://github.com/Financial-Times/dotcom-tool-kit/commit/5aa7327018c0a87c8c9feef36ef9e3735a4f5e6d))
+* rename Task#options to pluginOptions ([e73dcae](https://github.com/Financial-Times/dotcom-tool-kit/commit/e73dcae5ff48693545aa20e5c572269c3adf486b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @dotcom-tool-kit/logger bumped from ^3.3.0 to ^4.0.0

package/lib/base.js

@@ -12,9 +12,8 @@ const packageJsonPath = path_1.default.resolve(__dirname, '../package.json');
 const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, 'utf8'));
 const version = packageJson.version;
 class Base {
-    constructor() {
-        this.version = version;
-    }
+    static version = version;
+    version = version;
     static get [symbols_1.typeSymbol]() {
         return symbols_1.baseSymbol;
     }
@@ -49,4 +48,3 @@ class Base {
     }
 }
 exports.Base = Base;
-Base.version = version;

package/lib/hook.d.ts

@@ -4,28 +4,36 @@ import { typeSymbol } from './symbols';
 import type { z } from 'zod';
 import type { Plugin } from '@dotcom-tool-kit/plugin';
 import { Conflict } from '@dotcom-tool-kit/conflict';
+import type { Default } from './type-utils';
 export interface HookInstallation<Options = Record<string, unknown>> {
     options: Options;
     plugin: Plugin;
     forHook: string;
     hookConstructor: HookConstructor;
 }
-export declare abstract class Hook<Options extends z.ZodTypeAny = z.ZodTypeAny, State = void> extends Base {
+export declare abstract class Hook<Options extends {
+    hook?: z.ZodTypeAny;
+    plugin?: z.ZodTypeAny;
+} = Record<never, never>, State = unknown> extends Base {
     id: string;
-    options: z.output<Options>;
+    options: z.output<Default<Options['hook'], z.ZodObject<Record<string, never>>>>;
+    pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>;
     logger: Logger;
     installGroup?: string;
     static get [typeSymbol](): symbol;
     get [typeSymbol](): symbol;
     static mergeChildInstallations(plugin: Plugin, childInstallations: (HookInstallation | Conflict<HookInstallation>)[]): (HookInstallation | Conflict<HookInstallation>)[];
     static overrideChildInstallations(plugin: Plugin, parentInstallation: HookInstallation, _childInstallations: (HookInstallation | Conflict<HookInstallation>)[]): (HookInstallation | Conflict<HookInstallation>)[];
-    constructor(logger: Logger, id: string, options: z.output<Options>);
+    constructor(logger: Logger, id: string, options: z.output<Default<Options['hook'], z.ZodObject<Record<string, never>>>>, pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>);
     abstract isInstalled(): Promise<boolean>;
     abstract install(state?: State): Promise<State>;
     commitInstall(_state: State): Promise<void>;
 }
 export type HookConstructor = {
-    new (logger: Logger, id: string, options: z.output<z.ZodTypeAny>): Hook<z.ZodTypeAny, unknown>;
+    new <O extends {
+        plugin: z.ZodTypeAny;
+        hook: z.ZodTypeAny;
+    }>(logger: Logger, id: string, options: z.infer<O['hook']>, pluginOptions: z.infer<O['plugin']>): Hook<O, unknown>;
 };
 export type HookClass = HookConstructor & typeof Hook;
 //# sourceMappingURL=hook.d.ts.map

package/lib/hook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../src/hook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAc,UAAU,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAEhE,MAAM,WAAW,gBAAgB,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjE,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,eAAe,CAAA;CACjC;AAED,8BAAsB,IAAI,CAAC,OAAO,SAAS,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,GAAG,IAAI,CAAE,SAAQ,IAAI;IAsC7D,EAAE,EAAE,MAAM;IAAS,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IArChF,MAAM,EAAE,MAAM,CAAA;IAKd,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,MAAM,CAEhC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAEzB;IAED,MAAM,CAAC,uBAAuB,CAC5B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,GACpE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAWpD,MAAM,CAAC,0BAA0B,CAC/B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,gBAAgB,EACpC,mBAAmB,EAAE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,GACrE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;gBAIxC,MAAM,EAAE,MAAM,EAAS,EAAE,EAAE,MAAM,EAAS,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IAKhF,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IACxC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IACzC,aAAa,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlD;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;CAC/F,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,IAAI,CAAA"}
+{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../src/hook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAc,UAAU,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,gBAAgB,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjE,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,eAAe,CAAA;CACjC;AAED,8BAAsB,IAAI,CACxB,OAAO,SAAS;IACd,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;IACnB,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;CACtB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EACxB,KAAK,GAAG,OAAO,CACf,SAAQ,IAAI;IA4CH,EAAE,EAAE,MAAM;IACV,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/E,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IA7ChG,MAAM,EAAE,MAAM,CAAA;IAKd,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,MAAM,CAEhC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAEzB;IAED,MAAM,CAAC,uBAAuB,CAC5B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,GACpE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAepD,MAAM,CAAC,0BAA0B,CAC/B,MAAM,EAAE,MAAM,EACd,kBAAkB,EAAE,gBAAgB,EACpC,mBAAmB,EAAE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,GACrE,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE;gBAKlD,MAAM,EAAE,MAAM,EACP,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/E,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAMhG,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IACxC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IACzC,aAAa,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlD;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,SAAS;QAAE,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC;QAAC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAA;KAAE,EACzD,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAC3B,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAClC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,IAAI,CAAA"}

package/lib/hook.js

@@ -5,6 +5,15 @@ const base_1 = require("./base");
 const symbols_1 = require("./symbols");
 const conflict_1 = require("@dotcom-tool-kit/conflict");
 class Hook extends base_1.Base {
+    id;
+    options;
+    pluginOptions;
+    logger;
+    // This field is used to collect hooks that share state when running their
+    // install methods. All hooks in the same group will run their install method
+    // one after the other, and then their commitInstall method will be run with
+    // the collected state.
+    installGroup;
     static get [symbols_1.typeSymbol]() {
         return symbols_1.hookSymbol;
     }
@@ -12,6 +21,9 @@ class Hook extends base_1.Base {
         return symbols_1.hookSymbol;
     }
     static mergeChildInstallations(plugin, childInstallations) {
+        if (childInstallations.length === 1) {
+            return childInstallations;
+        }
         return [
             {
                 plugin,
@@ -22,10 +34,11 @@ class Hook extends base_1.Base {
     static overrideChildInstallations(plugin, parentInstallation, _childInstallations) {
         return [parentInstallation];
     }
-    constructor(logger, id, options) {
+    constructor(logger, id, options, pluginOptions) {
         super();
         this.id = id;
         this.options = options;
+        this.pluginOptions = pluginOptions;
         this.logger = logger.child({ hook: this.constructor.name });
     }
     async commitInstall(_state) {

package/lib/init.d.ts

@@ -1,12 +1,15 @@
 import type { Logger } from 'winston';
 import { typeSymbol } from './symbols';
 import { Base } from './base';
+export type InitContext = {
+    cwd: string;
+};
 export declare abstract class Init extends Base {
     logger: Logger;
     constructor(logger: Logger);
     static get [typeSymbol](): symbol;
     get [typeSymbol](): symbol;
-    abstract init(): Promise<void>;
+    abstract init(context: InitContext): Promise<void>;
 }
 export type InitConstructor = {
     new (logger: Logger): Init;

package/lib/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAc,UAAU,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,8BAAsB,IAAK,SAAQ,IAAI;IACrC,MAAM,EAAE,MAAM,CAAA;gBAEF,MAAM,EAAE,MAAM;IAK1B,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,MAAM,CAEhC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAEzB;IAED,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,IAAI,CAAA"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAc,UAAU,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,8BAAsB,IAAK,SAAQ,IAAI;IACrC,MAAM,EAAE,MAAM,CAAA;gBAEF,MAAM,EAAE,MAAM;IAK1B,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,MAAM,CAEhC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAEzB;IAED,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CACnD;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,IAAI,CAAA"}

package/lib/init.js

@@ -4,6 +4,7 @@ exports.Init = void 0;
 const symbols_1 = require("./symbols");
 const base_1 = require("./base");
 class Init extends base_1.Base {
+    logger;
     constructor(logger) {
         super();
         this.logger = logger.child({ hook: this.constructor.name });

package/lib/task.d.ts

@@ -2,7 +2,16 @@ import type { z } from 'zod';
 import { Base } from './base';
 import { typeSymbol } from './symbols';
 import type { Logger } from 'winston';
-type Default<T, D> = T extends undefined ? D : T;
+import type { ValidConfig } from '@dotcom-tool-kit/config';
+import { Plugin } from '@dotcom-tool-kit/plugin';
+import type { Default } from './type-utils';
+import type { ReadonlyDeep } from 'type-fest';
+export type TaskRunContext = {
+    files?: string[];
+    command: string;
+    cwd: string;
+    config: ReadonlyDeep<ValidConfig>;
+};
 export declare abstract class Task<Options extends {
     plugin?: z.ZodTypeAny;
     task?: z.ZodTypeAny;
@@ -10,18 +19,19 @@ export declare abstract class Task<Options extends {
     id: string;
     pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>;
     options: z.output<Default<Options['task'], z.ZodObject<Record<string, never>>>>;
+    plugin: Plugin;
     static get [typeSymbol](): symbol;
     get [typeSymbol](): symbol;
     logger: Logger;
-    constructor(logger: Logger, id: string, pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>, options: z.output<Default<Options['task'], z.ZodObject<Record<string, never>>>>);
-    abstract run(files?: string[]): Promise<void>;
+    constructor(logger: Logger, id: string, pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>, options: z.output<Default<Options['task'], z.ZodObject<Record<string, never>>>>, plugin: Plugin);
+    abstract run(runContext: TaskRunContext): Promise<void>;
+    stop(): Promise<void>;
 }
 export type TaskConstructor = {
     new <O extends {
         plugin: z.ZodTypeAny;
         task: z.ZodTypeAny;
-    }>(logger: Logger, id: string, pluginOptions: Partial<z.infer<O['plugin']>>, options: Partial<z.infer<O['task']>>): Task<O>;
+    }>(logger: Logger, id: string, pluginOptions: Partial<z.infer<O['plugin']>>, options: Partial<z.infer<O['task']>>, plugin: Plugin): Task<O>;
 };
 export type TaskClass = TaskConstructor & typeof Task;
-export {};
 //# sourceMappingURL=task.d.ts.map

package/lib/task.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../src/task.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAc,UAAU,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,CAAC,GAAG,CAAC,CAAA;AAEhD,8BAAsB,IAAI,CACxB,OAAO,SAAS;IACd,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;IACrB,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;CACpB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CACxB,SAAQ,IAAI;IAaH,EAAE,EAAE,MAAM;IACV,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACvF,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAdxF,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,MAAM,CAEhC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAEzB;IAED,MAAM,EAAE,MAAM,CAAA;gBAGZ,MAAM,EAAE,MAAM,EACP,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EACvF,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAMxF,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAC9C;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,SAAS;QAAE,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC;QAAC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAA;KAAE,EACzD,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAC5C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GACnC,IAAI,CAAC,CAAC,CAAC,CAAA;CACX,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,IAAI,CAAA"}
+{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../src/task.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAc,UAAU,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE7C,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;CAClC,CAAA;AAED,8BAAsB,IAAI,CACxB,OAAO,SAAS;IACd,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;IACrB,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;CACpB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CACxB,SAAQ,IAAI;IAaH,EAAE,EAAE,MAAM;IACV,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACvF,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/E,MAAM,EAAE,MAAM;IAfvB,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,MAAM,CAEhC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAEzB;IAED,MAAM,EAAE,MAAM,CAAA;gBAGZ,MAAM,EAAE,MAAM,EACP,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EACvF,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/E,MAAM,EAAE,MAAM;IAMvB,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,SAAS;QAAE,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC;QAAC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAA;KAAE,EACzD,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAC5C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EACpC,MAAM,EAAE,MAAM,GACb,IAAI,CAAC,CAAC,CAAC,CAAA;CACX,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,OAAO,IAAI,CAAA"}

package/lib/task.js

@@ -4,18 +4,27 @@ exports.Task = void 0;
 const base_1 = require("./base");
 const symbols_1 = require("./symbols");
 class Task extends base_1.Base {
+    id;
+    pluginOptions;
+    options;
+    plugin;
     static get [symbols_1.typeSymbol]() {
         return symbols_1.taskSymbol;
     }
     get [symbols_1.typeSymbol]() {
         return symbols_1.taskSymbol;
     }
-    constructor(logger, id, pluginOptions, options) {
+    logger;
+    constructor(logger, id, pluginOptions, options, plugin) {
         super();
         this.id = id;
         this.pluginOptions = pluginOptions;
         this.options = options;
+        this.plugin = plugin;
         this.logger = logger.child({ task: id });
     }
+    // not abstract for default behaviour of doing nothing
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async stop() { }
 }
 exports.Task = Task;

package/lib/type-utils.d.ts

@@ -0,0 +1,2 @@
+export type Default<T, D> = T extends undefined ? D : T;
+//# sourceMappingURL=type-utils.d.ts.map

package/lib/type-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-utils.d.ts","sourceRoot":"","sources":["../src/type-utils.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,CAAC,GAAG,CAAC,CAAA"}

package/lib/type-utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/base",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.2",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -10,18 +10,23 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@dotcom-tool-kit/conflict": "2.0.0-beta.0",
-    "@dotcom-tool-kit/validated": "2.0.0-beta.0",
-    "semver": "^7.5.4",
-    "winston": "^3.11.0"
+    "@dotcom-tool-kit/conflict": "^2.0.0",
+    "@dotcom-tool-kit/logger": "^5.0.0",
+    "@dotcom-tool-kit/validated": "^2.0.0",
+    "semver": "^7.7.3",
+    "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@dotcom-tool-kit/logger": "4.0.0-beta.0",
-    "@dotcom-tool-kit/plugin": "2.0.0-beta.0",
-    "winston": "^3.11.0",
-    "zod": "^3.22.4"
+    "@dotcom-tool-kit/config": "^2.0.0",
+    "@dotcom-tool-kit/plugin": "^2.0.0",
+    "type-fest": "^4.41.0",
+    "winston": "^3.17.0",
+    "zod": "^3.24.4"
   },
   "peerDependencies": {
-    "zod": "^3.22.4"
+    "zod": "^3.24.4"
+  },
+  "engines": {
+    "node": ">=20.x"
   }
-}
+}

package/src/hook.ts

@@ -4,6 +4,7 @@ import { hookSymbol, typeSymbol } from './symbols'
 import type { z } from 'zod'
 import type { Plugin } from '@dotcom-tool-kit/plugin'
 import { Conflict, isConflict } from '@dotcom-tool-kit/conflict'
+import type { Default } from './type-utils'
 
 export interface HookInstallation<Options = Record<string, unknown>> {
   options: Options
@@ -12,7 +13,13 @@ export interface HookInstallation<Options = Record<string, unknown>> {
   hookConstructor: HookConstructor
 }
 
-export abstract class Hook<Options extends z.ZodTypeAny = z.ZodTypeAny, State = void> extends Base {
+export abstract class Hook<
+  Options extends {
+    hook?: z.ZodTypeAny
+    plugin?: z.ZodTypeAny
+  } = Record<never, never>,
+  State = unknown
+> extends Base {
   logger: Logger
   // This field is used to collect hooks that share state when running their
   // install methods. All hooks in the same group will run their install method
@@ -32,6 +39,10 @@ export abstract class Hook<Options extends z.ZodTypeAny = z.ZodTypeAny, State =
     plugin: Plugin,
     childInstallations: (HookInstallation | Conflict<HookInstallation>)[]
   ): (HookInstallation | Conflict<HookInstallation>)[] {
+    if (childInstallations.length === 1) {
+      return childInstallations
+    }
+
     return [
       {
         plugin,
@@ -50,7 +61,12 @@ export abstract class Hook<Options extends z.ZodTypeAny = z.ZodTypeAny, State =
     return [parentInstallation]
   }
 
-  constructor(logger: Logger, public id: string, public options: z.output<Options>) {
+  constructor(
+    logger: Logger,
+    public id: string,
+    public options: z.output<Default<Options['hook'], z.ZodObject<Record<string, never>>>>,
+    public pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>
+  ) {
     super()
     this.logger = logger.child({ hook: this.constructor.name })
   }
@@ -63,7 +79,12 @@ export abstract class Hook<Options extends z.ZodTypeAny = z.ZodTypeAny, State =
 }
 
 export type HookConstructor = {
-  new (logger: Logger, id: string, options: z.output<z.ZodTypeAny>): Hook<z.ZodTypeAny, unknown>
+  new <O extends { plugin: z.ZodTypeAny; hook: z.ZodTypeAny }>(
+    logger: Logger,
+    id: string,
+    options: z.infer<O['hook']>,
+    pluginOptions: z.infer<O['plugin']>
+  ): Hook<O, unknown>
 }
 
 export type HookClass = HookConstructor & typeof Hook

package/src/init.ts

@@ -2,6 +2,10 @@ import type { Logger } from 'winston'
 import { initSymbol, typeSymbol } from './symbols'
 import { Base } from './base'
 
+export type InitContext = {
+  cwd: string
+}
+
 export abstract class Init extends Base {
   logger: Logger
 
@@ -18,7 +22,7 @@ export abstract class Init extends Base {
     return initSymbol
   }
 
-  abstract init(): Promise<void>
+  abstract init(context: InitContext): Promise<void>
 }
 
 export type InitConstructor = {

package/src/task.ts

@@ -2,8 +2,17 @@ import type { z } from 'zod'
 import { Base } from './base'
 import { taskSymbol, typeSymbol } from './symbols'
 import type { Logger } from 'winston'
-
-type Default<T, D> = T extends undefined ? D : T
+import type { ValidConfig } from '@dotcom-tool-kit/config'
+import { Plugin } from '@dotcom-tool-kit/plugin'
+import type { Default } from './type-utils'
+import type { ReadonlyDeep } from 'type-fest'
+
+export type TaskRunContext = {
+  files?: string[]
+  command: string
+  cwd: string
+  config: ReadonlyDeep<ValidConfig>
+}
 
 export abstract class Task<
   Options extends {
@@ -25,13 +34,18 @@ export abstract class Task<
     logger: Logger,
     public id: string,
     public pluginOptions: z.output<Default<Options['plugin'], z.ZodObject<Record<string, never>>>>,
-    public options: z.output<Default<Options['task'], z.ZodObject<Record<string, never>>>>
+    public options: z.output<Default<Options['task'], z.ZodObject<Record<string, never>>>>,
+    public plugin: Plugin
   ) {
     super()
     this.logger = logger.child({ task: id })
   }
 
-  abstract run(files?: string[]): Promise<void>
+  abstract run(runContext: TaskRunContext): Promise<void>
+
+  // not abstract for default behaviour of doing nothing
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  async stop(): Promise<void> {}
 }
 
 export type TaskConstructor = {
@@ -39,7 +53,8 @@ export type TaskConstructor = {
     logger: Logger,
     id: string,
     pluginOptions: Partial<z.infer<O['plugin']>>,
-    options: Partial<z.infer<O['task']>>
+    options: Partial<z.infer<O['task']>>,
+    plugin: Plugin
   ): Task<O>
 }
 

package/src/type-utils.ts

@@ -0,0 +1 @@
+export type Default<T, D> = T extends undefined ? D : T

package/tsconfig.json

@@ -12,6 +12,9 @@
     },
     {
       "path": "../validated"
+    },
+    {
+      "path": "../config"
     }
   ],
   "compilerOptions": {