dotcom-tool-kit 3.1.7 → 3.2.1

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 import type { Logger } from 'winston';
+export declare const shouldDisableNativeFetch: () => boolean;
 export declare function runTasks(logger: Logger, hooks: string[], files?: string[]): Promise<void>;
 export declare function listPlugins(logger: Logger): Promise<void>;
 export { default as showHelp } from './help';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AASrC,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA+E/F;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAWrC,eAAO,MAAM,wBAAwB,QAAO,OAY3C,CAAA;AAED,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAmF/F;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,WAAW,CAAA"}

package/lib/index.js

@@ -3,12 +3,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installHooks = exports.showHelp = exports.listPlugins = exports.runTasks = void 0;
+exports.installHooks = exports.showHelp = exports.listPlugins = exports.runTasks = exports.shouldDisableNativeFetch = void 0;
 const error_1 = require("@dotcom-tool-kit/error");
 const config_1 = require("./config");
 const options_1 = require("@dotcom-tool-kit/options");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const messages_1 = require("./messages");
+// function that plugins can check if they need to implement their own logic to
+// disable Node 18's native fetch
+const shouldDisableNativeFetch = () => {
+    // disable Node 18's native fetch if the Node runtime supports it (older
+    // runtimes don't support the flag, implying they also don't use native
+    // fetch) and the user hasn't opted out of the behaviour
+    return (
+    /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion --
+     * the root plugin has default options and it always exists so is always
+     * defined
+     **/
+    !(0, options_1.getOptions)('app root').allowNativeFetch &&
+        process.allowedNodeEnvironmentFlags.has('--no-experimental-fetch'));
+};
+exports.shouldDisableNativeFetch = shouldDisableNativeFetch;
 async function runTasks(logger, hooks, files) {
     const config = await (0, config_1.loadConfig)(logger);
     const availableHooks = Object.keys(config.hooks)
@@ -30,6 +45,9 @@ ${availableHooks}`;
         }
     }
     await (0, config_1.checkInstall)(config);
+    if ((0, exports.shouldDisableNativeFetch)()) {
+        process.execArgv.push('--no-experimental-fetch');
+    }
     for (const hook of hooks) {
         const errors = [];
         if (!config.hookTasks[hook]) {

package/lib/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,MAAM,EACN,YAAY,EAIZ,SAAS,EACV,MAAM,wBAAwB,CAAA;AAG/B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAiB,SAAS,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAmBvE,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,CAgDvE;AAoBD,wBAAsB,UAAU,CAC9B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CA4D5B;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAsI9F"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,MAAM,EACN,YAAY,EAIZ,SAAS,EACV,MAAM,wBAAwB,CAAA;AAG/B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAiB,SAAS,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAmBvE,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,CAgDvE;AAoBD,wBAAsB,UAAU,CAC9B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CA8D5B;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAyI9F"}

package/lib/plugin.js

@@ -105,6 +105,8 @@ async function loadPlugin(id, config, logger, parent) {
     const pluginModulePromise = isAppRoot
         ? Promise.resolve({ valid: true, value: undefined })
         : importPlugin(pluginRoot);
+    // ESlint disable explanation: erroring due to a possible race condition but is a false positive since the plugin variable isn't from another scope and can't be written to concurrently.
+    // eslint-disable-next-line require-atomic-updates
     plugin.value.rcFile = await rcFilePromise;
     // start loading child plugins in the background
     const childrenPromise = Promise.all(plugin.value.rcFile.plugins.map((child) => loadPlugin(child, config, logger, plugin.value)));
@@ -212,11 +214,14 @@ function resolvePlugin(plugin, config, logger) {
         // merge options from this plugin's config with any options we've collected already
         // TODO this is almost the exact same code as for hooks, refactor
         for (const [id, configOptions] of Object.entries(plugin.rcFile.options)) {
-            const existingOptions = config.options[id];
+            // users can specify root options with the dotcom-tool-kit key to mirror
+            // the name of the root npm package
+            const pluginId = id === 'dotcom-tool-kit' ? 'app root' : id;
+            const existingOptions = config.options[pluginId];
             const pluginOptions = {
                 options: configOptions,
                 plugin,
-                forPlugin: config.plugins[id]
+                forPlugin: config.plugins[pluginId]
             };
             if (existingOptions) {
                 const existingFromDescendent = isDescendent(plugin, existingOptions.plugin);
@@ -229,17 +234,17 @@ function resolvePlugin(plugin, config, logger) {
                         plugin,
                         conflicting: conflicting.concat(pluginOptions)
                     };
-                    config.options[id] = conflict;
+                    config.options[pluginId] = conflict;
                 }
                 else {
                     // if we're here, any existing options are from a child plugin,
                     // so merge in overrides from the parent
-                    config.options[id] = { ...existingOptions, ...pluginOptions };
+                    config.options[pluginId] = { ...existingOptions, ...pluginOptions };
                 }
             }
             else {
                 // this options key might not have been set yet, in which case use the new one
-                config.options[id] = pluginOptions;
+                config.options[pluginId] = pluginOptions;
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "3.1.7",
+  "version": "3.2.1",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -20,17 +20,17 @@
     "test": "cd ../../ ; npx jest --silent --projects core/cli"
   },
   "devDependencies": {
-    "@dotcom-tool-kit/babel": "^3.1.1",
-    "@dotcom-tool-kit/backend-heroku-app": "^2.1.6",
-    "@dotcom-tool-kit/circleci": "^5.3.3",
-    "@dotcom-tool-kit/circleci-deploy": "^3.2.3",
-    "@dotcom-tool-kit/eslint": "^3.1.1",
-    "@dotcom-tool-kit/frontend-app": "^3.1.7",
-    "@dotcom-tool-kit/heroku": "^3.2.1",
-    "@dotcom-tool-kit/mocha": "^3.1.1",
-    "@dotcom-tool-kit/n-test": "^3.2.1",
-    "@dotcom-tool-kit/npm": "^3.1.1",
-    "@dotcom-tool-kit/webpack": "^3.1.2",
+    "@dotcom-tool-kit/babel": "^3.1.3",
+    "@dotcom-tool-kit/backend-heroku-app": "^2.1.8",
+    "@dotcom-tool-kit/circleci": "^5.3.5",
+    "@dotcom-tool-kit/circleci-deploy": "^3.2.5",
+    "@dotcom-tool-kit/eslint": "^3.1.3",
+    "@dotcom-tool-kit/frontend-app": "^3.1.9",
+    "@dotcom-tool-kit/heroku": "^3.2.3",
+    "@dotcom-tool-kit/mocha": "^3.1.3",
+    "@dotcom-tool-kit/n-test": "^3.2.3",
+    "@dotcom-tool-kit/npm": "^3.1.3",
+    "@dotcom-tool-kit/webpack": "^3.1.4",
     "@jest/globals": "^27.4.6",
     "@types/lodash": "^4.14.185",
     "@types/node": "^16.18.23",
@@ -41,9 +41,9 @@
   },
   "dependencies": {
     "@dotcom-tool-kit/error": "^3.1.0",
-    "@dotcom-tool-kit/logger": "^3.1.0",
-    "@dotcom-tool-kit/options": "^3.1.1",
-    "@dotcom-tool-kit/types": "^3.2.0",
+    "@dotcom-tool-kit/logger": "^3.1.1",
+    "@dotcom-tool-kit/options": "^3.1.3",
+    "@dotcom-tool-kit/types": "^3.3.1",
     "@dotcom-tool-kit/wait-for-ok": "^3.1.0",
     "cosmiconfig": "^7.0.0",
     "lodash": "^4.17.21",

package/readme.md

@@ -0,0 +1,13 @@
+# dotcom-tool-kit
+
+_(This README is for the core `dotcom-tool-kit` package that must be installed to use Tool Kit. You can find the documentation for the Tool Kit project itself at https://github.com/Financial-Times/dotcom-tool-kit/blob/main/readme.md.)_
+
+The primary Tool Kit binary that will be invoked to handle all your hooks and tasks.
+
+## Options
+
+There are some global options available that will affect all plugins. All are optional but you can override them with the `dotcom-tool-kit` key.
+
+| Key | Description | Default value |
+|-|-|-|
+| `allowNativeFetch` | use Node's native fetch if supported | `false` |