@dotcom-tool-kit/config 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 1.0.0 (2024-09-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* rename SchemaOptions to PluginOptions
+
+### Features
+
+* **cli:** add support for tags in config that resolve based on options ([8df97b9](https://github.com/Financial-Times/dotcom-tool-kit/commit/8df97b9e6d595740d4b94f34fe5a3f0dccef0994))
+* collect and store the hook-managed files in config ([190afc5](https://github.com/Financial-Times/dotcom-tool-kit/commit/190afc50bdbded129d3e090ebb0e041ba8443b27))
+* load plugin rcfile task options into config ([3f1b1b1](https://github.com/Financial-Times/dotcom-tool-kit/commit/3f1b1b149e9e5c9c0d00b7f85697469b0ece472a))
+* split remaining bits of types into config and plugins packages ([6cde9b9](https://github.com/Financial-Times/dotcom-tool-kit/commit/6cde9b90d4cd02383ae1b18ca38e0843e6c3d3ab))
+
+
+### Bug Fixes
+
+* **cli:** avoid hook installation conflicts between niblings ([1d70759](https://github.com/Financial-Times/dotcom-tool-kit/commit/1d70759a8139dca5c4d45f6833828914a47e96f0))
+* remove conflicts from task options in valid config type ([5c8a1e0](https://github.com/Financial-Times/dotcom-tool-kit/commit/5c8a1e0845eac058d76512d86702bf9805572f55))
+
+
+### Code Refactoring
+
+* rename SchemaOptions to PluginOptions ([0ce24db](https://github.com/Financial-Times/dotcom-tool-kit/commit/0ce24db808d077a0e4647d3bef9eaf55223a1cdf))

package/lib/index.d.ts

@@ -0,0 +1,60 @@
+import type { Validated } from '@dotcom-tool-kit/validated';
+import type { CommandTask, EntryPoint, Plugin, OptionsForPlugin, OptionsForTask } from '@dotcom-tool-kit/plugin';
+import type { PluginOptions } from '@dotcom-tool-kit/schemas';
+import type { Conflict } from '@dotcom-tool-kit/conflict';
+export interface RawConfig {
+    root: string;
+    plugins: {
+        [id: string]: Validated<Plugin>;
+    };
+    resolutionTrackers: {
+        resolvedPluginOptions: Set<string>;
+        substitutedPlugins: Set<string>;
+        resolvedPlugins: Set<string>;
+        reducedInstallationPlugins: Set<string>;
+    };
+    tasks: {
+        [id: string]: EntryPoint | Conflict<EntryPoint>;
+    };
+    commandTasks: {
+        [id: string]: CommandTask | Conflict<CommandTask>;
+    };
+    pluginOptions: {
+        [id: string]: OptionsForPlugin | Conflict<OptionsForPlugin> | undefined;
+    };
+    taskOptions: {
+        [id: string]: OptionsForTask | Conflict<OptionsForTask> | undefined;
+    };
+    hooks: {
+        [id: string]: EntryPoint | Conflict<EntryPoint>;
+    };
+    inits: EntryPoint[];
+    hookManagedFiles: Set<string>;
+}
+export type ValidPluginsConfig = Omit<RawConfig, 'plugins'> & {
+    plugins: {
+        [id: string]: Plugin;
+    };
+};
+export type ValidOptionsForPlugin<Id extends keyof PluginOptions> = Omit<OptionsForPlugin, 'options'> & {
+    options: PluginOptions[Id];
+};
+export type ValidPluginOptions = {
+    [Id in keyof PluginOptions]: ValidOptionsForPlugin<Id>;
+};
+export type ValidConfig = Omit<ValidPluginsConfig, 'tasks' | 'commandTasks' | 'pluginOptions' | 'taskOptions' | 'hooks'> & {
+    tasks: {
+        [id: string]: EntryPoint;
+    };
+    commandTasks: {
+        [id: string]: CommandTask;
+    };
+    pluginOptions: ValidPluginOptions;
+    taskOptions: {
+        [id: string]: OptionsForTask;
+    };
+    hooks: {
+        [id: string]: EntryPoint;
+    };
+};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,cAAc,EACf,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAEzD,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;KAAE,CAAA;IAC5C,kBAAkB,EAAE;QAClB,qBAAqB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAClC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC/B,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC5B,0BAA0B,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;KACxC,CAAA;IACD,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAA;KAAE,CAAA;IAC1D,YAAY,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;KAAE,CAAA;IACnE,aAAa,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAA;KAAE,CAAA;IAC1F,WAAW,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAAG,SAAS,CAAA;KAAE,CAAA;IACpF,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAA;KAAE,CAAA;IAC1D,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG;IAC5D,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,MAAM,aAAa,IAAI,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;IACtG,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;KAC9B,EAAE,IAAI,MAAM,aAAa,GAAG,qBAAqB,CAAC,EAAE,CAAC;CACvD,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,IAAI,CAC5B,kBAAkB,EAClB,OAAO,GAAG,cAAc,GAAG,eAAe,GAAG,aAAa,GAAG,OAAO,CACrE,GAAG;IACF,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAA;IACnC,YAAY,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,CAAA;IAC3C,aAAa,EAAE,kBAAkB,CAAA;IACjC,WAAW,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAA;IAC7C,KAAK,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAA;CACpC,CAAA"}

package/lib/index.js

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

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@dotcom-tool-kit/config",
+  "version": "1.0.0",
+  "description": "",
+  "main": "lib",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@dotcom-tool-kit/conflict": "^1.0.0",
+    "@dotcom-tool-kit/plugin": "^1.0.0",
+    "@dotcom-tool-kit/schemas": "^1.0.0",
+    "@dotcom-tool-kit/validated": "^1.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,51 @@
+import type { Validated } from '@dotcom-tool-kit/validated'
+import type {
+  CommandTask,
+  EntryPoint,
+  Plugin,
+  OptionsForPlugin,
+  OptionsForTask
+} from '@dotcom-tool-kit/plugin'
+import type { PluginOptions } from '@dotcom-tool-kit/schemas'
+import type { Conflict } from '@dotcom-tool-kit/conflict'
+
+export interface RawConfig {
+  root: string
+  plugins: { [id: string]: Validated<Plugin> }
+  resolutionTrackers: {
+    resolvedPluginOptions: Set<string>
+    substitutedPlugins: Set<string>
+    resolvedPlugins: Set<string>
+    reducedInstallationPlugins: Set<string>
+  }
+  tasks: { [id: string]: EntryPoint | Conflict<EntryPoint> }
+  commandTasks: { [id: string]: CommandTask | Conflict<CommandTask> }
+  pluginOptions: { [id: string]: OptionsForPlugin | Conflict<OptionsForPlugin> | undefined }
+  taskOptions: { [id: string]: OptionsForTask | Conflict<OptionsForTask> | undefined }
+  hooks: { [id: string]: EntryPoint | Conflict<EntryPoint> }
+  inits: EntryPoint[]
+  hookManagedFiles: Set<string>
+}
+
+export type ValidPluginsConfig = Omit<RawConfig, 'plugins'> & {
+  plugins: { [id: string]: Plugin }
+}
+
+export type ValidOptionsForPlugin<Id extends keyof PluginOptions> = Omit<OptionsForPlugin, 'options'> & {
+  options: PluginOptions[Id]
+}
+
+export type ValidPluginOptions = {
+  [Id in keyof PluginOptions]: ValidOptionsForPlugin<Id>
+}
+
+export type ValidConfig = Omit<
+  ValidPluginsConfig,
+  'tasks' | 'commandTasks' | 'pluginOptions' | 'taskOptions' | 'hooks'
+> & {
+  tasks: { [id: string]: EntryPoint }
+  commandTasks: { [id: string]: CommandTask }
+  pluginOptions: ValidPluginOptions
+  taskOptions: { [id: string]: OptionsForTask }
+  hooks: { [id: string]: EntryPoint }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.settings.json",
+  "references": [
+    {
+      "path": "../plugin"
+    },
+    {
+      "path": "../schemas"
+    }
+  ],
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  }
+}