@oclif/core 3.17.0 → 3.18.1

package/lib/config/ts-node.d.ts

@@ -1,5 +1,5 @@
 import { Plugin, TSConfig } from '../interfaces';
-export declare const TS_CONFIGS: Record<string, TSConfig>;
+export declare const TS_CONFIGS: Record<string, TSConfig | undefined>;
 /**
  * Convert a path from the compiled ./lib files to the ./src typescript source
  * this is for developing typescript plugins/CLIs

package/lib/config/ts-node.js

@@ -9,6 +9,7 @@ const cache_1 = __importDefault(require("../cache"));
 const errors_1 = require("../errors");
 const settings_1 = require("../settings");
 const fs_1 = require("../util/fs");
+const read_tsconfig_1 = require("../util/read-tsconfig");
 const util_1 = require("../util/util");
 const util_2 = require("./util");
 // eslint-disable-next-line new-cap
@@ -22,7 +23,7 @@ async function loadTSConfig(root) {
     try {
         if (exports.TS_CONFIGS[root])
             return exports.TS_CONFIGS[root];
-        exports.TS_CONFIGS[root] = await (0, fs_1.readTSConfig)((0, node_path_1.join)(root, 'tsconfig.json'));
+        exports.TS_CONFIGS[root] = await (0, read_tsconfig_1.readTSConfig)(root);
         return exports.TS_CONFIGS[root];
     }
     catch (error) {

package/lib/flags.d.ts

@@ -2,6 +2,23 @@
 import { URL } from 'node:url';
 import { BooleanFlag, CustomOptions, FlagDefinition, OptionFlag } from './interfaces';
 type NotArray<T> = T extends Array<any> ? never : T;
+/**
+ * Create a custom flag.
+ *
+ * @example
+ * type Id = string
+ * type IdOpts = { startsWith: string; length: number }
+ *
+ * export const myFlag = custom<Id, IdOpts>({
+ *   parse: async (input, opts) => {
+ *     if (input.startsWith(opts.startsWith) && input.length === opts.length) {
+ *       return input
+ *     }
+ *
+ *     throw new Error('Invalid id')
+ *   },
+ * })
+ */
 export declare function custom<T = string, P extends CustomOptions = CustomOptions>(defaults: Partial<OptionFlag<T[], P>> & {
     multiple: true;
 } & ({
@@ -42,7 +59,18 @@ export declare function custom<T = string, P extends CustomOptions = CustomOptio
     multiple: false;
     requiredOrDefaulted: false;
 }>;
+/**
+ * A boolean flag. Defaults to `false` unless default is set to `true`.
+ *
+ * - `allowNo` option allows `--no-` prefix to negate boolean flag.
+ */
 export declare function boolean<T = boolean>(options?: Partial<BooleanFlag<T>>): BooleanFlag<T>;
+/**
+ * An integer flag. Throws an error if the provided value is not a valid integer.
+ *
+ * - `min` option allows to set a minimum value.
+ * - `max` option allows to set a maximum value.
+ */
 export declare const integer: FlagDefinition<number, {
     max?: number | undefined;
     min?: number | undefined;
@@ -50,12 +78,22 @@ export declare const integer: FlagDefinition<number, {
     multiple: false;
     requiredOrDefaulted: false;
 }>;
+/**
+ * A directory flag.
+ *
+ * - `exists` option allows you to throw an error if the directory does not exist.
+ */
 export declare const directory: FlagDefinition<string, {
     exists?: boolean | undefined;
 }, {
     multiple: false;
     requiredOrDefaulted: false;
 }>;
+/**
+ * A file flag.
+ *
+ * - `exists` option allows you to throw an error if the file does not exist.
+ */
 export declare const file: FlagDefinition<string, {
     exists?: boolean | undefined;
 }, {
@@ -63,20 +101,44 @@ export declare const file: FlagDefinition<string, {
     requiredOrDefaulted: false;
 }>;
 /**
- * Initializes a string as a URL. Throws an error
- * if the string is not a valid URL.
+ * A URL flag that converts the provided value is a string.
+ *
+ * Throws an error if the string is not a valid URL.
  */
 export declare const url: FlagDefinition<URL, CustomOptions, {
     multiple: false;
     requiredOrDefaulted: false;
 }>;
+/**
+ * A string flag.
+ */
 export declare const string: FlagDefinition<string, CustomOptions, {
     multiple: false;
     requiredOrDefaulted: false;
 }>;
+/**
+ * Version flag that will print the CLI version and exit.
+ */
 export declare const version: (opts?: Partial<BooleanFlag<boolean>>) => BooleanFlag<void>;
+/**
+ * A help flag that will print the CLI help and exit.
+ */
 export declare const help: (opts?: Partial<BooleanFlag<boolean>>) => BooleanFlag<void>;
 type ReadonlyElementOf<T extends ReadonlyArray<unknown>> = T[number];
+/**
+ * Create a custom flag that infers the flag type from the provided options.
+ *
+ * The provided `options` must be a readonly array in order for type inference to work.
+ *
+ * @example
+ * export default class MyCommand extends Command {
+ *   static flags = {
+ *     name: Flags.option({
+ *       options: ['foo', 'bar'] as const,
+ *     })(),
+ *   }
+ * }
+ */
 export declare function option<T extends readonly string[], P extends CustomOptions>(defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {
     multiple: true;
     options: T;

package/lib/flags.js

@@ -5,23 +5,6 @@ const node_url_1 = require("node:url");
 const errors_1 = require("./errors");
 const help_1 = require("./help");
 const fs_1 = require("./util/fs");
-/**
- * Create a custom flag.
- *
- * @example
- * type Id = string
- * type IdOpts = { startsWith: string; length: number };
- *
- * export const myFlag = custom<Id, IdOpts>({
- *   parse: async (input, opts) => {
- *     if (input.startsWith(opts.startsWith) && input.length === opts.length) {
- *       return input
- *     }
- *
- *     throw new Error('Invalid id')
- *   },
- * })
- */
 function custom(defaults) {
     return (options = {}) => ({
         parse: async (input, _ctx, _opts) => input,
@@ -33,6 +16,11 @@ function custom(defaults) {
     });
 }
 exports.custom = custom;
+/**
+ * A boolean flag. Defaults to `false` unless default is set to `true`.
+ *
+ * - `allowNo` option allows `--no-` prefix to negate boolean flag.
+ */
 function boolean(options = {}) {
     return {
         parse: async (b, _) => b,
@@ -42,6 +30,12 @@ function boolean(options = {}) {
     };
 }
 exports.boolean = boolean;
+/**
+ * An integer flag. Throws an error if the provided value is not a valid integer.
+ *
+ * - `min` option allows to set a minimum value.
+ * - `max` option allows to set a maximum value.
+ */
 exports.integer = custom({
     async parse(input, _, opts) {
         if (!/^-?\d+$/.test(input))
@@ -54,6 +48,11 @@ exports.integer = custom({
         return num;
     },
 });
+/**
+ * A directory flag.
+ *
+ * - `exists` option allows you to throw an error if the directory does not exist.
+ */
 exports.directory = custom({
     async parse(input, _, opts) {
         if (opts.exists)
@@ -61,6 +60,11 @@ exports.directory = custom({
         return input;
     },
 });
+/**
+ * A file flag.
+ *
+ * - `exists` option allows you to throw an error if the file does not exist.
+ */
 exports.file = custom({
     async parse(input, _, opts) {
         if (opts.exists)
@@ -69,8 +73,9 @@ exports.file = custom({
     },
 });
 /**
- * Initializes a string as a URL. Throws an error
- * if the string is not a valid URL.
+ * A URL flag that converts the provided value is a string.
+ *
+ * Throws an error if the string is not a valid URL.
  */
 exports.url = custom({
     async parse(input) {
@@ -82,7 +87,13 @@ exports.url = custom({
         }
     },
 });
+/**
+ * A string flag.
+ */
 exports.string = custom();
+/**
+ * Version flag that will print the CLI version and exit.
+ */
 const version = (opts = {}) => boolean({
     description: 'Show CLI version.',
     ...opts,
@@ -92,6 +103,9 @@ const version = (opts = {}) => boolean({
     },
 });
 exports.version = version;
+/**
+ * A help flag that will print the CLI help and exit.
+ */
 const help = (opts = {}) => boolean({
     description: 'Show CLI help.',
     ...opts,
@@ -102,18 +116,6 @@ const help = (opts = {}) => boolean({
     },
 });
 exports.help = help;
-/**
- * Create a custom flag that infers the flag type from the provided options.
- *
- * @example
- * export default class MyCommand extends Command {
- *   static flags = {
- *     name: Flags.option({
- *       options: ['foo', 'bar'] as const,
- *     })(),
- *   }
- * }
- */
 function option(defaults) {
     return (options = {}) => ({
         parse: async (input, _ctx, _opts) => input,

package/lib/util/fs.d.ts

@@ -18,4 +18,3 @@ 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>;
 export declare function existsSync(path: string): boolean;
-export declare function readTSConfig(path: string): Promise<any>;

package/lib/util/fs.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readTSConfig = exports.existsSync = exports.safeReadJson = exports.readJsonSync = exports.readJson = exports.fileExists = exports.dirExists = exports.requireJson = void 0;
+exports.existsSync = exports.safeReadJson = exports.readJsonSync = exports.readJson = exports.fileExists = exports.dirExists = exports.requireJson = void 0;
 const node_fs_1 = require("node:fs");
 const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
-const util_1 = require("./util");
 function requireJson(...pathParts) {
     return JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(...pathParts), 'utf8'));
 }
@@ -70,10 +69,3 @@ function existsSync(path) {
     return (0, node_fs_1.existsSync)(path);
 }
 exports.existsSync = existsSync;
-async function readTSConfig(path) {
-    const { parse } = await import('tsconfck');
-    const result = await parse(path);
-    const tsNodeOpts = (0, util_1.mergeNestedObjects)(result.extended ?? [result], 'tsconfig.ts-node');
-    return { ...result.tsconfig, 'ts-node': tsNodeOpts };
-}
-exports.readTSConfig = readTSConfig;

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

@@ -0,0 +1,2 @@
+import { TSConfig } from '../interfaces';
+export declare function readTSConfig(root: string, tsconfigName?: string): Promise<TSConfig | undefined>;

package/lib/util/read-tsconfig.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readTSConfig = void 0;
+const debug_1 = __importDefault(require("debug"));
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+const errors_1 = require("../errors");
+const util_1 = require("./util");
+const debug = (0, debug_1.default)('read-tsconfig');
+function resolve(root, name) {
+    try {
+        return require.resolve(name, { paths: [root] });
+    }
+    catch {
+        // return undefined
+    }
+}
+async function upUntil(path, test) {
+    let result;
+    try {
+        result = await test(path);
+    }
+    catch {
+        result = false;
+    }
+    if (result)
+        return path;
+    const parent = (0, node_path_1.dirname)(path);
+    if (parent === path)
+        return;
+    return upUntil(parent, test);
+}
+async function readTSConfig(root, tsconfigName = 'tsconfig.json') {
+    const found = [];
+    let typescript;
+    try {
+        typescript = require('typescript');
+    }
+    catch {
+        try {
+            typescript = require(root + '/node_modules/typescript');
+        }
+        catch { }
+    }
+    if (!typescript) {
+        (0, errors_1.memoizedWarn)('Could not find typescript. Please ensure that typescript is a devDependency. Falling back to compiled source.');
+        return;
+    }
+    const read = async (path) => {
+        const localRoot = await upUntil(path, async (p) => 
+        // eslint-disable-next-line unicorn/no-await-expression-member
+        (await (0, promises_1.readdir)(p)).includes('package.json'));
+        if (!localRoot)
+            return;
+        try {
+            const contents = await (0, promises_1.readFile)(path, 'utf8');
+            const parsed = typescript?.parseConfigFileTextToJson(path, contents).config;
+            found.push(parsed);
+            if (parsed.extends) {
+                if (parsed.extends.startsWith('.')) {
+                    const nextPath = resolve(localRoot, parsed.extends);
+                    return nextPath ? read(nextPath) : undefined;
+                }
+                const resolved = resolve(localRoot, parsed.extends);
+                if (resolved)
+                    return read(resolved);
+            }
+            return parsed;
+        }
+        catch (error) {
+            debug(error);
+        }
+    };
+    await read((0, node_path_1.join)(root, tsconfigName));
+    return {
+        compilerOptions: (0, util_1.mergeNestedObjects)(found, 'compilerOptions'),
+        'ts-node': (0, util_1.mergeNestedObjects)(found, 'ts-node'),
+    };
+}
+exports.readTSConfig = readTSConfig;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.17.0",
+  "version": "3.18.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
+    "@types/cli-progress": "^3.11.5",
     "ansi-escapes": "^4.3.2",
     "ansi-styles": "^4.3.0",
     "cardinal": "^2.1.1",
@@ -28,7 +29,6 @@
     "strip-ansi": "^6.0.1",
     "supports-color": "^8.1.1",
     "supports-hyperlinks": "^2.2.0",
-    "tsconfck": "^3.0.0",
     "widest-line": "^3.1.0",
     "wordwrap": "^1.0.0",
     "wrap-ansi": "^7.0.0"
@@ -44,7 +44,6 @@
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/clean-stack": "^2.1.1",
-    "@types/cli-progress": "^3.11.5",
     "@types/color": "^3.0.5",
     "@types/debug": "^4.1.10",
     "@types/ejs": "^3.1.5",
@@ -66,7 +65,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.50.0",
     "eslint-config-oclif": "^5.0.0",
-    "eslint-config-oclif-typescript": "^3.0.1",
+    "eslint-config-oclif-typescript": "^3.0.35",
     "eslint-config-prettier": "^9.0.0",
     "fancy-test": "^3.0.1",
     "globby": "^11.1.0",
@@ -121,8 +120,8 @@
     "pretest": "yarn build && tsc -p test --noEmit --skipLibCheck",
     "test:circular-deps": "madge lib/ -c",
     "test:debug": "nyc mocha --debug-brk --inspect \"test/**/*.test.ts\"",
-    "test:e2e": "mocha --forbid-only \"test/**/*.e2e.ts\" --parallel --timeout 1200000",
-    "test:esm-cjs": "cross-env DEBUG=e2e:* ts-node test/integration/esm-cjs.ts",
+    "test:integration": "mocha --forbid-only \"test/**/*.integration.ts\" --parallel --timeout 1200000",
+    "test:esm-cjs": "cross-env DEBUG=integration:* ts-node test/integration/esm-cjs.ts",
     "test:perf": "ts-node test/perf/parser.perf.ts",
     "test:dev": "nyc mocha \"test/**/*.test.ts\"",
     "test": "nyc mocha --forbid-only \"test/**/*.test.ts\""