@dotcom-tool-kit/plugin - npm Package Compare versions

Comparing version 2.0.0-beta.0 to 2.0.0

CHANGELOG.md

+# Changelog
+
+## [2.0.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/plugin-v1.1.0...plugin-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))
+
+## [1.1.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/plugin-v1.0.0...plugin-v1.1.0) (2025-02-17)
+
+
+### Features
+
+* allow option schemas to be loaded from plugins ([58310c8](https://github.com/Financial-Times/dotcom-tool-kit/commit/58310c88077e332473b36dacf142881f20700c2a))
+* support special case of root plugin option schema ([b6b5edb](https://github.com/Financial-Times/dotcom-tool-kit/commit/b6b5edb2be5bd16b2b44d5f46288dc19c4b3e6a1))
+
+## 1.0.0 (2024-09-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* only load plugins if their toolkitrc version matches the current version
+* load hook installations from options.hooks
+* move plugin options to a sub key of toolkitrc options entries
+
+### Features
+
+* add support for a managesFiles entry in hook installs fields ([a89b167](https://github.com/Financial-Times/dotcom-tool-kit/commit/a89b167da9dae6edd6fcc9295a5f8f82e2e30023))
+* allow specifying command task options in a toolkitrc ([7b8bc00](https://github.com/Financial-Times/dotcom-tool-kit/commit/7b8bc000b8562eb0dbd00eb2f8f3fc5fab71a57b))
+* load hook installations from options.hooks ([aaf1160](https://github.com/Financial-Times/dotcom-tool-kit/commit/aaf1160a4724b07b9d174f9d237721368d2fa087))
+* load plugin rcfile task options into config ([3f1b1b1](https://github.com/Financial-Times/dotcom-tool-kit/commit/3f1b1b149e9e5c9c0d00b7f85697469b0ece472a))
+* move plugin options to a sub key of toolkitrc options entries ([4748eb1](https://github.com/Financial-Times/dotcom-tool-kit/commit/4748eb12d60bef31bd6da00d1447e35af1e0af1a))
+* only load plugins if their toolkitrc version matches the current version ([65b3403](https://github.com/Financial-Times/dotcom-tool-kit/commit/65b3403b8369aa09ec64b11d20ab44b06d468d86))
+* split remaining bits of types into config and plugins packages ([6cde9b9](https://github.com/Financial-Times/dotcom-tool-kit/commit/6cde9b90d4cd02383ae1b18ca38e0843e6c3d3ab))

lib/root-schema.d.ts

+import * as z from 'zod';
+export declare const RootSchema: z.ZodObject<{
+    allowNativeFetch: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    allowNativeFetch: boolean;
+}, {
+    allowNativeFetch?: boolean | undefined;
+}>;
+export type RootOptions = z.infer<typeof RootSchema>;
+//# sourceMappingURL=root-schema.d.ts.map

lib/root-schema.d.ts.map

+{"version":3,"file":"root-schema.d.ts","sourceRoot":"","sources":["../src/root-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,eAAO,MAAM,UAAU;;;;;;EAErB,CAAA;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA"}

lib/root-schema.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RootSchema = void 0;
+const tslib_1 = require("tslib");
+const z = tslib_1.__importStar(require("zod"));
+exports.RootSchema = z.object({
+    allowNativeFetch: z.boolean().default(false)
+});

src/root-schema.ts

+import * as z from 'zod'
+
+export const RootSchema = z.object({
+  allowNativeFetch: z.boolean().default(false)
+})
+export type RootOptions = z.infer<typeof RootSchema>

lib/index.d.ts

@@ -34,2 +34,3 @@ type TaskSpecWithOptions = Record<string, Record<string, unknown>>;
     };
+    optionsSchema?: string;
     init: string[];
@@ -36,0 +37,0 @@ };

lib/index.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAClE,KAAK,QAAQ,GAAG,MAAM,GAAG,mBAAmB,CAAA;AAC5C,KAAK,YAAY,GAAG;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,uBAAuB,IAAI,CAAA;AAExC,MAAM,MAAM,MAAM,GAAG;IACnB,OAAO,CAAC,EAAE,OAAO,uBAAuB,CAAA;IACxC,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAA;IACxC,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC/B,QAAQ,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAA;KAAE,CAAA;IACjD,KAAK,CAAC,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAA;KAAE,CAAA;IAC/C,OAAO,EAAE;QACP,OAAO,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAA;QAClD,KAAK,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAA;QAChD,KAAK,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,EAAE,CAAA;KACnD,CAAA;IACD,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,cAAc,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAClE,KAAK,QAAQ,GAAG,MAAM,GAAG,mBAAmB,CAAA;AAC5C,KAAK,YAAY,GAAG;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,uBAAuB,IAAI,CAAA;AAExC,MAAM,MAAM,MAAM,GAAG;IACnB,OAAO,CAAC,EAAE,OAAO,uBAAuB,CAAA;IACxC,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAA;IACxC,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC/B,QAAQ,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAA;KAAE,CAAA;IACjD,KAAK,CAAC,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAA;KAAE,CAAA;IAC/C,OAAO,EAAE;QACP,OAAO,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAA;QAClD,KAAK,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAA;QAChD,KAAK,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,EAAE,CAAA;KACnD,CAAA;IACD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,cAAc,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;CACnB"}

package.json

 {
   "name": "@dotcom-tool-kit/plugin",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0",
   "description": "",
@@ -12,3 +12,6 @@ "main": "lib",
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "engines": {
+    "node": ">=20.x"
+  }
 }

src/index.ts

@@ -22,2 +22,3 @@ type TaskSpecWithOptions = Record<string, Record<string, unknown>>
   }
+  optionsSchema?: string
   init: string[]
@@ -24,0 +25,0 @@ }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8271

69.94%

Number of package files

11

83.33%

Lines of code

144

20%

Number of low quality alerts

2

-33.33%

No dependency changes