@oclif/core 4.0.0-beta.3 → 4.0.0-beta.5

package/lib/config/plugin.js

@@ -15,6 +15,7 @@ const symbols_1 = require("../symbols");
 const cache_command_1 = require("../util/cache-command");
 const find_root_1 = require("../util/find-root");
 const fs_1 = require("../util/fs");
+const read_pjson_1 = require("../util/read-pjson");
 const util_1 = require("../util/util");
 const ts_path_1 = require("./ts-path");
 const util_2 = require("./util");
@@ -182,7 +183,7 @@ class Plugin {
             throw new errors_1.CLIError(`could not find package.json with ${(0, node_util_1.inspect)(this.options)}`);
         this.root = root;
         this._debug(`loading ${this.type} plugin from ${root}`);
-        this.pjson = this.options.pjson ?? (await (0, fs_1.readJson)((0, node_path_1.join)(root, 'package.json')));
+        this.pjson = this.options.pjson ?? (await (0, read_pjson_1.readPjson)(root));
         this.flexibleTaxonomy = this.options?.flexibleTaxonomy || this.pjson.oclif?.flexibleTaxonomy || false;
         this.moduleType = this.pjson.type === 'module' ? 'module' : 'commonjs';
         this.name = this.pjson.name;

package/lib/util/fs.js

@@ -43,17 +43,29 @@ const fileExists = async (input) => {
     return input;
 };
 exports.fileExists = fileExists;
+const cache = new Map();
 async function readJson(path) {
+    if (cache.has(path)) {
+        return JSON.parse(cache.get(path));
+    }
     const contents = await (0, promises_1.readFile)(path, 'utf8');
+    cache.set(path, contents);
     return JSON.parse(contents);
 }
 exports.readJson = readJson;
 function readJsonSync(path, parse = true) {
+    if (cache.has(path)) {
+        return JSON.parse(cache.get(path));
+    }
     const contents = (0, node_fs_1.readFileSync)(path, 'utf8');
+    cache.set(path, contents);
     return parse ? JSON.parse(contents) : contents;
 }
 exports.readJsonSync = readJsonSync;
 async function safeReadJson(path) {
+    if (cache.has(path)) {
+        return JSON.parse(cache.get(path));
+    }
     try {
         return await readJson(path);
     }

package/lib/util/read-pjson.d.ts

@@ -0,0 +1,7 @@
+import { PJSON } from '../interfaces';
+/**
+ * Read the package.json file from a given path and add the oclif config (found by cosmiconfig) if it exists.
+ *
+ * We can assume that the package.json file exists because the plugin root has already been loaded at this point.
+ */
+export declare function readPjson(path: string): Promise<PJSON.Plugin>;

package/lib/util/read-pjson.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readPjson = void 0;
+const cosmiconfig_1 = require("cosmiconfig");
+const node_path_1 = require("node:path");
+const logger_1 = require("../logger");
+const fs_1 = require("./fs");
+const debug = (0, logger_1.makeDebug)('read-pjson');
+/**
+ * Read the package.json file from a given path and add the oclif config (found by cosmiconfig) if it exists.
+ *
+ * We can assume that the package.json file exists because the plugin root has already been loaded at this point.
+ */
+async function readPjson(path) {
+    const pjsonPath = (0, node_path_1.join)(path, 'package.json');
+    if (process.env.OCLIF_DISABLE_RC) {
+        debug('OCLIF_DISABLE_RC is set, skipping rc search');
+        return (0, fs_1.readJson)(pjsonPath);
+    }
+    const pjson = await (0, fs_1.readJson)(pjsonPath);
+    // don't bother with cosmiconfig if the plugin's package.json already has an oclif config
+    if (pjson.oclif) {
+        debug(`found oclif config in ${pjsonPath}`);
+        return pjson;
+    }
+    debug(`searching for oclif config in ${path}`);
+    const explorer = (0, cosmiconfig_1.cosmiconfig)('oclif', {
+        /**
+         * Remove the following from the defaults:
+         * - package.json
+         * - any files under .config/
+         */
+        searchPlaces: [
+            '.oclifrc',
+            '.oclifrc.json',
+            '.oclifrc.yaml',
+            '.oclifrc.yml',
+            '.oclifrc.js',
+            '.oclifrc.ts',
+            '.oclifrc.mjs',
+            '.oclifrc.cjs',
+            'oclif.config.js',
+            'oclif.config.ts',
+            'oclif.config.mjs',
+            'oclif.config.cjs',
+        ],
+        searchStrategy: 'none',
+    });
+    const result = await explorer.search(path);
+    if (!result?.config) {
+        debug(`no oclif config found in ${path}`);
+        return pjson;
+    }
+    debug(`found oclif config for ${path}: %O`, result);
+    return {
+        ...pjson,
+        oclif: result?.config ?? {},
+    };
+}
+exports.readPjson = readPjson;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.5",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -9,6 +9,7 @@
     "ansis": "^3.0.1",
     "clean-stack": "^3.0.1",
     "cli-spinners": "^2.9.2",
+    "cosmiconfig": "^9.0.0",
     "debug": "^4.3.4",
     "ejs": "^3.1.10",
     "get-package-type": "^0.1.0",