oclif 4.0.0-beta.2 → 4.0.0-beta.5

package/bin/dev.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env ts-node
-// eslint-disable-next-line node/shebang
+// eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
 (async () => {
   const oclif = await import('@oclif/core')
   await oclif.execute({development: true, dir: __dirname})

package/bin/run.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+// eslint-disable-next-line unicorn/prefer-top-level-await
 (async () => {
   const oclif = await import('@oclif/core')
   await oclif.execute({dir: __dirname})

package/lib/aws.js

@@ -25,7 +25,7 @@ const aws = {
     get s3() {
         try {
             cache.s3 =
-                cache.s3 ||
+                cache.s3 ??
                     new (require('aws-sdk/clients/s3'))({
                         ...this.creds,
                         endpoint: process.env.AWS_S3_ENDPOINT,

package/lib/commands/manifest.d.ts

@@ -7,8 +7,8 @@ export default class Manifest extends Command {
     static flags: {
         jit: Interfaces.BooleanFlag<boolean>;
     };
+    run(): Promise<void>;
     private executeCommand;
     private getTarballUrl;
     private getVersion;
-    run(): Promise<void>;
 }

package/lib/commands/manifest.js

@@ -31,40 +31,6 @@ class Manifest extends core_1.Command {
             summary: 'append commands from JIT plugins in manifest',
         }),
     };
-    async executeCommand(command, options) {
-        return new Promise((resolve) => {
-            (0, node_child_process_1.exec)(command, options, (error, stderr, stdout) => {
-                if (error)
-                    this.error(error);
-                const debugString = options?.cwd
-                    ? `executing command: ${command} in ${options.cwd}`
-                    : `executing command: ${command}`;
-                this.debug(debugString);
-                this.debug(stdout);
-                this.debug(stderr);
-                resolve({ stderr: stderr.toString(), stdout: stdout.toString() });
-            });
-        });
-    }
-    async getTarballUrl(plugin, version) {
-        const { stderr } = await this.executeCommand(`npm view ${plugin}@${version} --json`);
-        const { dist } = JSON.parse(stderr);
-        return dist.tarball;
-    }
-    async getVersion(plugin, version) {
-        if (version.startsWith('^') || version.startsWith('~')) {
-            // Grab latest from npm to get all the versions so we can find the max satisfying version.
-            // We explicitly ask for latest since this command is typically run inside of `npm prepack`,
-            // which sets the npm_config_tag env var, which is used as the default anytime a tag isn't
-            // provided to `npm view`. This can be problematic if you're building the `nightly` version
-            // of a CLI and all the JIT plugins don't have a `nightly` tag themselves.
-            // TL;DR - always ask for latest to avoid potentially requesting a non-existent tag.
-            const { stderr } = await this.executeCommand(`npm view ${plugin}@latest --json`);
-            const { versions } = JSON.parse(stderr);
-            return (0, semver_1.maxSatisfying)(versions, version) ?? version.replace('^', '').replace('~', '');
-        }
-        return version;
-    }
     async run() {
         const { flags } = await this.parse(Manifest);
         try {
@@ -123,5 +89,39 @@ class Manifest extends core_1.Command {
         (0, fs_extra_1.writeFileSync)(file, JSON.stringify(plugin.manifest, null, 2));
         this.log(`wrote manifest to ${file}`);
     }
+    async executeCommand(command, options) {
+        return new Promise((resolve) => {
+            (0, node_child_process_1.exec)(command, options, (error, stderr, stdout) => {
+                if (error)
+                    this.error(error);
+                const debugString = options?.cwd
+                    ? `executing command: ${command} in ${options.cwd}`
+                    : `executing command: ${command}`;
+                this.debug(debugString);
+                this.debug(stdout);
+                this.debug(stderr);
+                resolve({ stderr: stderr.toString(), stdout: stdout.toString() });
+            });
+        });
+    }
+    async getTarballUrl(plugin, version) {
+        const { stderr } = await this.executeCommand(`npm view ${plugin}@${version} --json`);
+        const { dist } = JSON.parse(stderr);
+        return dist.tarball;
+    }
+    async getVersion(plugin, version) {
+        if (version.startsWith('^') || version.startsWith('~')) {
+            // Grab latest from npm to get all the versions so we can find the max satisfying version.
+            // We explicitly ask for latest since this command is typically run inside of `npm prepack`,
+            // which sets the npm_config_tag env var, which is used as the default anytime a tag isn't
+            // provided to `npm view`. This can be problematic if you're building the `nightly` version
+            // of a CLI and all the JIT plugins don't have a `nightly` tag themselves.
+            // TL;DR - always ask for latest to avoid potentially requesting a non-existent tag.
+            const { stderr } = await this.executeCommand(`npm view ${plugin}@latest --json`);
+            const { versions } = JSON.parse(stderr);
+            return (0, semver_1.maxSatisfying)(versions, version) ?? version.replace('^', '').replace('~', '');
+        }
+        return version;
+    }
 }
 exports.default = Manifest;

package/lib/commands/pack/win.d.ts

@@ -7,6 +7,6 @@ export default class PackWin extends Command {
         tarball: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
         targets: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };
-    private checkForNSIS;
     run(): Promise<void>;
+    private checkForNSIS;
 }

package/lib/commands/pack/win.js

@@ -226,19 +226,6 @@ the CLI should already exist in a directory named after the CLI that is the root
             description: 'comma-separated targets to pack (e.g.: win32-x64,win32-x86)',
         }),
     };
-    async checkForNSIS() {
-        try {
-            await exec('makensis');
-        }
-        catch (error) {
-            if (error.code === 1)
-                return;
-            if (error.code === 127)
-                this.error('install makensis');
-            else
-                throw error;
-        }
-    }
     async run() {
         await this.checkForNSIS();
         const { flags } = await this.parse(PackWin);
@@ -290,6 +277,19 @@ the CLI should already exist in a directory named after the CLI that is the root
             this.log(`built ${o}`);
         }));
     }
+    async checkForNSIS() {
+        try {
+            await exec('makensis');
+        }
+        catch (error) {
+            if (error.code === 1)
+                return;
+            if (error.code === 127)
+                this.error('install makensis');
+            else
+                throw error;
+        }
+    }
 }
 exports.default = PackWin;
 async function signWindows(o, arch, config, windows) {

package/lib/commands/readme.d.ts

@@ -8,14 +8,8 @@ export default class Readme extends Command {
         'repository-prefix': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
         version: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };
-    private HelpClass;
     private flags;
-    /**
-     * fetches the path to a command
-     */
-    private commandPath;
-    private commandUsage;
-    private repo;
+    private HelpClass;
     commandCode(config: Interfaces.Config, c: Command.Cached): string | undefined;
     commands(config: Interfaces.Config, commands: Command.Cached[]): string;
     createTopicFile(file: string, config: Interfaces.Config, topic: Interfaces.Topic, commands: Command.Cached[]): void;
@@ -25,4 +19,10 @@ export default class Readme extends Command {
     run(): Promise<void>;
     toc(__: Interfaces.Config, readme: string): string;
     usage(config: Interfaces.Config): string;
+    /**
+     * fetches the path to a command
+     */
+    private commandPath;
+    private commandUsage;
+    private repo;
 }

package/lib/commands/readme.js

@@ -31,78 +31,8 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
             description: 'version to use in readme links. defaults to the version in package.json',
         }),
     };
-    HelpClass;
     flags;
-    /**
-     * fetches the path to a command
-     */
-    commandPath(plugin, c) {
-        const commandsDir = plugin.pjson.oclif.commands;
-        if (!commandsDir)
-            return;
-        const hasTypescript = plugin.pjson.devDependencies?.typescript || plugin.pjson.dependencies?.typescript;
-        let p = path.join(plugin.root, commandsDir, ...c.id.split(':'));
-        const outDir = path.dirname(commandsDir.replace(`.${path.sep}`, ''));
-        const outDirRegex = new RegExp('^' + outDir + (path.sep === '\\' ? '\\\\' : path.sep));
-        if (fs.pathExistsSync(path.join(p, 'index.js'))) {
-            p = path.join(p, 'index.js');
-        }
-        else if (fs.pathExistsSync(p + '.js')) {
-            p += '.js';
-        }
-        else if (hasTypescript) {
-            // check if non-compiled scripts are available
-            const base = p.replace(plugin.root + path.sep, '');
-            p = path.join(plugin.root, base.replace(outDirRegex, 'src' + path.sep));
-            if (fs.pathExistsSync(path.join(p, 'index.ts'))) {
-                p = path.join(p, 'index.ts');
-            }
-            else if (fs.pathExistsSync(p + '.ts')) {
-                p += '.ts';
-            }
-            else
-                return;
-        }
-        else
-            return;
-        p = p.replace(plugin.root + path.sep, '');
-        if (hasTypescript) {
-            p = p.replace(outDirRegex, 'src' + path.sep).replace(/\.js$/, '.ts');
-        }
-        p = p.replaceAll('\\', '/'); // Replace windows '\' by '/'
-        return p;
-    }
-    commandUsage(config, command) {
-        const arg = (arg) => {
-            const name = arg.name.toUpperCase();
-            if (arg.required)
-                return `${name}`;
-            return `[${name}]`;
-        };
-        const id = (0, core_1.toConfiguredId)(command.id, config);
-        const defaultUsage = () => (0, util_1.compact)([
-            id,
-            Object.values(command.args)
-                .filter((a) => !a.hidden)
-                .map((a) => arg(a))
-                .join(' '),
-        ]).join(' ');
-        const usages = (0, util_1.castArray)(command.usage);
-        return (0, util_1.template)({ command, config })(usages.length === 0 ? defaultUsage() : usages[0]);
-    }
-    repo(plugin) {
-        const pjson = { ...plugin.pjson };
-        normalize(pjson);
-        const repo = pjson.repository && pjson.repository.url;
-        if (!repo)
-            return;
-        const url = new node_url_1.URL(repo);
-        if (!['github.com', 'gitlab.com'].includes(url.hostname) &&
-            !pjson.oclif.repositoryPrefix &&
-            !this.flags['repository-prefix'])
-            return;
-        return `https://${url.hostname}${url.pathname.replace(/\.git$/, '')}`;
-    }
+    HelpClass;
     commandCode(config, c) {
         const pluginName = c.pluginName;
         if (!pluginName)
@@ -178,7 +108,7 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
     }
     renderCommand(config, c) {
         this.debug('rendering command', c.id);
-        const title = (0, util_1.template)({ command: c, config })(c.summary || c.description || '')
+        const title = (0, util_1.template)({ command: c, config })(c.summary ?? c.description ?? '')
             .trim()
             .split('\n')[0];
         const help = new this.HelpClass(config, { maxWidth: columns, stripAnsi: true });
@@ -274,5 +204,75 @@ USAGE
             .join('\n')
             .trim();
     }
+    /**
+     * fetches the path to a command
+     */
+    commandPath(plugin, c) {
+        const commandsDir = plugin.pjson.oclif.commands;
+        if (!commandsDir)
+            return;
+        const hasTypescript = plugin.pjson.devDependencies?.typescript || plugin.pjson.dependencies?.typescript;
+        let p = path.join(plugin.root, commandsDir, ...c.id.split(':'));
+        const outDir = path.dirname(commandsDir.replace(`.${path.sep}`, ''));
+        const outDirRegex = new RegExp('^' + outDir + (path.sep === '\\' ? '\\\\' : path.sep));
+        if (fs.pathExistsSync(path.join(p, 'index.js'))) {
+            p = path.join(p, 'index.js');
+        }
+        else if (fs.pathExistsSync(p + '.js')) {
+            p += '.js';
+        }
+        else if (hasTypescript) {
+            // check if non-compiled scripts are available
+            const base = p.replace(plugin.root + path.sep, '');
+            p = path.join(plugin.root, base.replace(outDirRegex, 'src' + path.sep));
+            if (fs.pathExistsSync(path.join(p, 'index.ts'))) {
+                p = path.join(p, 'index.ts');
+            }
+            else if (fs.pathExistsSync(p + '.ts')) {
+                p += '.ts';
+            }
+            else
+                return;
+        }
+        else
+            return;
+        p = p.replace(plugin.root + path.sep, '');
+        if (hasTypescript) {
+            p = p.replace(outDirRegex, 'src' + path.sep).replace(/\.js$/, '.ts');
+        }
+        p = p.replaceAll('\\', '/'); // Replace windows '\' by '/'
+        return p;
+    }
+    commandUsage(config, command) {
+        const arg = (arg) => {
+            const name = arg.name.toUpperCase();
+            if (arg.required)
+                return `${name}`;
+            return `[${name}]`;
+        };
+        const id = (0, core_1.toConfiguredId)(command.id, config);
+        const defaultUsage = () => (0, util_1.compact)([
+            id,
+            Object.values(command.args)
+                .filter((a) => !a.hidden)
+                .map((a) => arg(a))
+                .join(' '),
+        ]).join(' ');
+        const usages = (0, util_1.castArray)(command.usage);
+        return (0, util_1.template)({ command, config })(usages.length === 0 ? defaultUsage() : usages[0]);
+    }
+    repo(plugin) {
+        const pjson = { ...plugin.pjson };
+        normalize(pjson);
+        const repo = pjson.repository && pjson.repository.url;
+        if (!repo)
+            return;
+        const url = new node_url_1.URL(repo);
+        if (!['github.com', 'gitlab.com'].includes(url.hostname) &&
+            !pjson.oclif.repositoryPrefix &&
+            !this.flags['repository-prefix'])
+            return;
+        return `https://${url.hostname}${url.pathname.replace(/\.git$/, '')}`;
+    }
 }
 exports.default = Readme;

package/lib/generators/cli.d.ts

@@ -33,8 +33,8 @@ export default class CLI extends Generator {
     repository?: string;
     yarn: boolean;
     constructor(args: string | string[], opts: Generator.GeneratorOptions);
-    private _gitignore;
     end(): void;
     prompting(): Promise<void>;
     writing(): void;
+    private _gitignore;
 }

package/lib/generators/cli.js

@@ -30,23 +30,6 @@ class CLI extends Generator {
             yarn: hasYarn,
         };
     }
-    _gitignore() {
-        const existing = this.fs.exists(this.destinationPath('.gitignore'))
-            ? this.fs.read(this.destinationPath('.gitignore')).split('\n')
-            : [];
-        return ((0, util_1.uniq)((0, util_1.compact)([
-            '*-debug.log',
-            '*-error.log',
-            'node_modules',
-            '/tmp',
-            '/dist',
-            this.yarn ? '/package-lock.json' : '/yarn.lock',
-            '/lib',
-            ...existing,
-        ]))
-            .sort()
-            .join('\n') + '\n');
-    }
     end() {
         this.spawnCommandSync(this.env.options.nodePackageManager, ['run', 'build'], { cwd: this.env.cwd });
         this.spawnCommandSync(path.join(this.env.cwd, 'node_modules', '.bin', 'oclif'), ['readme'], {
@@ -231,5 +214,22 @@ class CLI extends Generator {
         this.fs.write(this.destinationPath('.gitignore'), this._gitignore());
         this.fs.delete(this.destinationPath('LICENSE'));
     }
+    _gitignore() {
+        const existing = this.fs.exists(this.destinationPath('.gitignore'))
+            ? this.fs.read(this.destinationPath('.gitignore')).split('\n')
+            : [];
+        return ((0, util_1.uniq)((0, util_1.compact)([
+            '*-debug.log',
+            '*-error.log',
+            'node_modules',
+            '/tmp',
+            '/dist',
+            this.yarn ? '/package-lock.json' : '/yarn.lock',
+            '/lib',
+            ...existing,
+        ]))
+            .sort()
+            .join('\n') + '\n');
+    }
 }
 exports.default = CLI;

package/lib/generators/command.d.ts

@@ -5,7 +5,7 @@ export default class Command extends Generator {
     options: GeneratorOptions;
     pjson: Interfaces.PJSON;
     constructor(args: string | string[], opts: GeneratorOptions);
-    private hasMocha;
     prompting(): Promise<void>;
     writing(): void;
+    private hasMocha;
 }

package/lib/generators/command.js

@@ -15,9 +15,6 @@ class Command extends Generator {
             name: opts.name,
         };
     }
-    hasMocha() {
-        return Boolean(this.pjson.devDependencies?.mocha);
-    }
     async prompting() {
         this.pjson = this.fs.readJSON('package.json');
         if (!this.pjson)
@@ -46,5 +43,8 @@ class Command extends Generator {
             this.fs.copyTpl(this.templatePath('test/command.test.ts.ejs'), this.destinationPath(`test/commands/${cmdPath}.test.ts`), opts);
         }
     }
+    hasMocha() {
+        return Boolean(this.pjson.devDependencies?.mocha);
+    }
 }
 exports.default = Command;

package/lib/generators/hook.d.ts

@@ -8,7 +8,7 @@ export default class Hook extends Generator {
     options: Options;
     pjson: Interfaces.PJSON;
     constructor(args: string | string[], options: Options);
-    private hasMocha;
     prompting(): Promise<void>;
     writing(): void;
+    private hasMocha;
 }

package/lib/generators/hook.js

@@ -11,9 +11,6 @@ class Hook extends Generator {
         super(args, options);
         this.options = options;
     }
-    hasMocha() {
-        return Boolean(this.pjson.devDependencies?.mocha);
-    }
     async prompting() {
         this.pjson = this.fs.readJSON('package.json');
         this.pjson.oclif = this.pjson.oclif || {};
@@ -40,5 +37,8 @@ class Hook extends Generator {
         }
         this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson);
     }
+    hasMocha() {
+        return Boolean(this.pjson.devDependencies?.mocha);
+    }
 }
 exports.default = Hook;