@oclif/core 4.0.5 → 4.0.7

package/lib/config/plugin-loader.js

@@ -169,7 +169,8 @@ class PluginLoader {
             try {
                 const userPJSONPath = (0, node_path_1.join)(opts.dataDir, 'package.json');
                 debug('reading user plugins pjson %s', userPJSONPath);
-                const pjson = await (0, fs_1.readJson)(userPJSONPath);
+                // ignore cache because the file might have changed within the same process (e.g. during a JIT plugin install)
+                const pjson = await (0, fs_1.readJson)(userPJSONPath, false);
                 if (!pjson.oclif)
                     pjson.oclif = { schema: 1 };
                 if (!pjson.oclif.plugins)

package/lib/help/index.js

@@ -195,6 +195,9 @@ class Help extends HelpBase {
             if (this.config.isSingleCommandCLI) {
                 const rootCmd = this.config.findCommand(symbols_1.SINGLE_COMMAND_CLI_SYMBOL);
                 if (rootCmd) {
+                    // set the command id to an empty string to prevent the
+                    // SINGLE_COMMAND_CLI_SYMBOL from being displayed in the help output
+                    rootCmd.id = '';
                     await this.showCommandHelp(rootCmd);
                     return;
                 }

package/lib/util/fs.d.ts

@@ -12,8 +12,24 @@ export declare const dirExists: (input: string) => Promise<string>;
  * @returns Promise<string>
  */
 export declare const fileExists: (input: string) => Promise<string>;
-export declare function readJson<T = unknown>(path: string): Promise<T>;
-export declare function readJsonSync(path: string, parse: false): string;
-export declare function readJsonSync<T = unknown>(path: string, parse?: true): T;
-export declare function safeReadJson<T>(path: string): Promise<T | undefined>;
+/**
+ * Read a file from disk and cache its contents if in production environment.
+ *
+ * Will throw an error if the file does not exist.
+ *
+ * @param path file path of JSON file
+ * @param useCache if false, ignore cache and read file from disk
+ * @returns <T>
+ */
+export declare function readJson<T = unknown>(path: string, useCache?: boolean): Promise<T>;
+/**
+ * Safely read a file from disk and cache its contents if in production environment.
+ *
+ * Will return undefined if the file does not exist.
+ *
+ * @param path file path of JSON file
+ * @param useCache if false, ignore cache and read file from disk
+ * @returns <T> or undefined
+ */
+export declare function safeReadJson<T>(path: string, useCache?: boolean): Promise<T | undefined>;
 export declare function existsSync(path: string): boolean;

package/lib/util/fs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.existsSync = exports.safeReadJson = exports.readJsonSync = exports.readJson = exports.fileExists = exports.dirExists = void 0;
+exports.existsSync = exports.safeReadJson = exports.readJson = exports.fileExists = exports.dirExists = void 0;
 const node_fs_1 = require("node:fs");
 const promises_1 = require("node:fs/promises");
 const util_1 = require("./util");
@@ -53,8 +53,17 @@ class ProdOnlyCache extends Map {
     }
 }
 const cache = new ProdOnlyCache();
-async function readJson(path) {
-    if (cache.has(path)) {
+/**
+ * Read a file from disk and cache its contents if in production environment.
+ *
+ * Will throw an error if the file does not exist.
+ *
+ * @param path file path of JSON file
+ * @param useCache if false, ignore cache and read file from disk
+ * @returns <T>
+ */
+async function readJson(path, useCache = true) {
+    if (useCache && cache.has(path)) {
         return JSON.parse(cache.get(path));
     }
     const contents = await (0, promises_1.readFile)(path, 'utf8');
@@ -62,21 +71,18 @@ async function readJson(path) {
     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));
-    }
+/**
+ * Safely read a file from disk and cache its contents if in production environment.
+ *
+ * Will return undefined if the file does not exist.
+ *
+ * @param path file path of JSON file
+ * @param useCache if false, ignore cache and read file from disk
+ * @returns <T> or undefined
+ */
+async function safeReadJson(path, useCache = true) {
     try {
-        return await readJson(path);
+        return await readJson(path, useCache);
     }
     catch { }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.0.5",
+  "version": "4.0.7",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -50,18 +50,18 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
     "eslint-config-oclif": "^5.2.0",
-    "eslint-config-oclif-typescript": "^3.1.7",
+    "eslint-config-oclif-typescript": "^3.1.8",
     "eslint-config-prettier": "^9.1.0",
     "husky": "^9",
     "lint-staged": "^15",
     "madge": "^6.1.0",
     "mocha": "^10.4.0",
     "nyc": "^15.1.0",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.2",
     "shx": "^0.3.4",
     "sinon": "^18",
     "ts-node": "^10.9.2",
-    "tsd": "^0.31.0",
+    "tsd": "^0.31.1",
     "typescript": "^5"
   },
   "engines": {