dotcom-tool-kit 2.3.2 → 2.3.4

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,CAyD5B;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,CA4D5B;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAsI9F"}

package/lib/plugin.js

@@ -80,11 +80,12 @@ async function loadPlugin(id, config, logger, parent) {
     if (id in config.plugins) {
         return config.plugins[id];
     }
+    const isAppRoot = id === 'app root';
     // load plugin relative to the parent plugin
     const root = parent ? parent.root : process.cwd();
     let pluginRoot;
     try {
-        pluginRoot = id === 'app root' ? root : (0, resolve_from_1.default)(root, id);
+        pluginRoot = isAppRoot ? root : (0, resolve_from_1.default)(root, id);
     }
     catch (e) {
         return { valid: false, reasons: [`could not find path for name ${logger_1.styles.filepath(id)}`] };
@@ -99,9 +100,11 @@ async function loadPlugin(id, config, logger, parent) {
     };
     config.plugins[id] = plugin;
     // start loading rc file in the background
-    const rcFilePromise = (0, rc_file_1.loadToolKitRC)(pluginRoot);
+    const rcFilePromise = (0, rc_file_1.loadToolKitRC)(logger, pluginRoot, isAppRoot);
     // start loading module in the background
-    const pluginModulePromise = id === 'app root' ? Promise.resolve({ valid: true, value: undefined }) : importPlugin(pluginRoot);
+    const pluginModulePromise = isAppRoot
+        ? Promise.resolve({ valid: true, value: undefined })
+        : importPlugin(pluginRoot);
     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)));

package/lib/rc-file.d.ts

@@ -1,4 +1,5 @@
 import { RCFile } from '@dotcom-tool-kit/types/src';
+import type { Logger } from 'winston';
 export declare const explorer: {
     readonly search: (searchFrom?: string | undefined) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
     readonly load: (filepath: string) => Promise<import("cosmiconfig/dist/types").CosmiconfigResult>;
@@ -6,5 +7,5 @@ export declare const explorer: {
     readonly clearSearchCache: () => void;
     readonly clearCaches: () => void;
 };
-export declare function loadToolKitRC(root: string): Promise<RCFile>;
+export declare function loadToolKitRC(logger: Logger, root: string, isAppRoot: boolean): Promise<RCFile>;
 //# sourceMappingURL=rc-file.d.ts.map

package/lib/rc-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rc-file.d.ts","sourceRoot":"","sources":["../src/rc-file.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAEnD,eAAO,MAAM,QAAQ;;;;;;CAA6D,CAAA;AAMlF,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CASjE"}
+{"version":3,"file":"rc-file.d.ts","sourceRoot":"","sources":["../src/rc-file.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAGnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,eAAO,MAAM,QAAQ;;;;;;CAA6D,CAAA;AAQlF,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CA0BrG"}

package/lib/rc-file.js

@@ -1,17 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadToolKitRC = exports.explorer = void 0;
+const tslib_1 = require("tslib");
+const logger_1 = require("@dotcom-tool-kit/logger");
 const cosmiconfig_1 = require("cosmiconfig");
+const path = (0, tslib_1.__importStar)(require("path"));
 exports.explorer = (0, cosmiconfig_1.cosmiconfig)('toolkit', { ignoreEmptySearchPlaces: false });
-async function loadToolKitRC(root) {
+const emptyConfig = { plugins: [], hooks: {}, options: {} };
+let rootConfig;
+async function loadToolKitRC(logger, root, isAppRoot) {
     var _a, _b, _c;
-    const result = (await exports.explorer.search(root));
-    if (!result || !result.config)
-        return { plugins: [], hooks: {}, options: {} };
+    const result = await exports.explorer.search(root);
+    if (!(result === null || result === void 0 ? void 0 : result.config)) {
+        return emptyConfig;
+    }
+    if (isAppRoot) {
+        rootConfig = result.filepath;
+    }
+    else if (result.filepath === rootConfig) {
+        // Make sure that custom plugins which don't have a config file won't cause
+        // the resolver to use the root config instead and start an infinite loop
+        // of config resolution.
+        logger.warn(`plugin at ${logger_1.styles.filepath(path.dirname(root))} has no config file. please add an empty ${logger_1.styles.filepath('.toolkitrc')} file to avoid potential config resolution issues.`);
+        return emptyConfig;
+    }
+    const config = result.config;
     return {
-        plugins: (_a = result.config.plugins) !== null && _a !== void 0 ? _a : [],
-        hooks: (_b = result.config.hooks) !== null && _b !== void 0 ? _b : {},
-        options: (_c = result.config.options) !== null && _c !== void 0 ? _c : {}
+        plugins: (_a = config.plugins) !== null && _a !== void 0 ? _a : [],
+        hooks: (_b = config.hooks) !== null && _b !== void 0 ? _b : {},
+        options: (_c = config.options) !== null && _c !== void 0 ? _c : {}
     };
 }
 exports.loadToolKitRC = loadToolKitRC;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -23,17 +23,17 @@
     "@jest/globals": "^27.4.6",
     "@types/lodash.merge": "^4.6.6",
     "@types/node": "^12.20.24",
-    "@dotcom-tool-kit/backend-app": "^2.0.8",
-    "@dotcom-tool-kit/heroku": "^2.0.7",
-    "@dotcom-tool-kit/webpack": "^2.1.5",
-    "@dotcom-tool-kit/babel": "^2.0.6",
-    "@dotcom-tool-kit/circleci": "^2.1.4",
-    "@dotcom-tool-kit/npm": "^2.0.7",
-    "@dotcom-tool-kit/circleci-heroku": "^2.0.8",
-    "@dotcom-tool-kit/frontend-app": "^2.1.6",
-    "@dotcom-tool-kit/eslint": "^2.1.5",
-    "@dotcom-tool-kit/mocha": "^2.1.3",
-    "@dotcom-tool-kit/n-test": "^2.1.1",
+    "@dotcom-tool-kit/backend-app": "^2.0.10",
+    "@dotcom-tool-kit/heroku": "^2.0.9",
+    "@dotcom-tool-kit/webpack": "^2.1.6",
+    "@dotcom-tool-kit/babel": "^2.0.7",
+    "@dotcom-tool-kit/circleci": "^2.1.5",
+    "@dotcom-tool-kit/npm": "^2.0.8",
+    "@dotcom-tool-kit/circleci-heroku": "^2.0.10",
+    "@dotcom-tool-kit/frontend-app": "^2.1.8",
+    "@dotcom-tool-kit/eslint": "^2.2.0",
+    "@dotcom-tool-kit/mocha": "^2.1.4",
+    "@dotcom-tool-kit/n-test": "^2.1.2",
     "chai": "^4.3.4",
     "globby": "^10.0.2",
     "ts-node": "^8.10.2",
@@ -42,8 +42,8 @@
   "dependencies": {
     "@dotcom-tool-kit/error": "^2.0.0",
     "@dotcom-tool-kit/logger": "^2.1.1",
-    "@dotcom-tool-kit/options": "^2.0.6",
-    "@dotcom-tool-kit/types": "^2.5.1",
+    "@dotcom-tool-kit/options": "^2.0.7",
+    "@dotcom-tool-kit/types": "^2.6.0",
     "@dotcom-tool-kit/wait-for-ok": "^2.0.0",
     "cosmiconfig": "^7.0.0",
     "lodash.merge": "^4.6.2",