oclif 3.7.2 → 3.8.0

package/.oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.7.2",
+  "version": "3.8.0",
   "commands": {
     "generate": {
       "id": "generate",

package/README.md

@@ -6,7 +6,6 @@ oclif: Node.JS Open CLI Framework
 =================================
 
 [![Version](https://img.shields.io/npm/v/oclif.svg)](https://npmjs.org/package/oclif)
-[![CircleCI](https://circleci.com/gh/oclif/oclif/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/oclif/tree/main)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/command.svg)](https://npmjs.org/package/@oclif/core)
 [![License](https://img.shields.io/npm/l/oclif.svg)](https://github.com/oclif/oclif/blob/main/package.json)
 

package/lib/commands/manifest.js

@@ -54,7 +54,7 @@ class Manifest extends core_1.Command {
         let plugin = new core_1.Plugin({ root, type: 'core', ignoreManifest: true, errorOnManifestCreate: true });
         if (!plugin)
             throw new Error('plugin not found');
-        await plugin.load();
+        await plugin.load(true);
         if (!plugin.valid) {
             const p = require.resolve('@oclif/plugin-legacy', { paths: [process.cwd()] });
             const { PluginLegacy } = require(p);

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

@@ -1,5 +1,4 @@
-import { Command } from '@oclif/core';
-import { Interfaces } from '@oclif/core';
+import { Command, Interfaces } from '@oclif/core';
 export default class PackDeb extends Command {
     static description: string;
     static flags: {

package/lib/commands/pack/deb.js

@@ -31,14 +31,18 @@ export ${config.scopedEnvVarKey('UPDATE_INSTRUCTIONS')}="update with \\"sudo apt
 \$DIR/node \$DIR/run "\$@"
 `,
     /* eslint-enable no-useless-escape */
-    control: (config, arch) => `Package: ${config.config.bin}
+    control: (config, arch) => {
+        var _a;
+        return `Package: ${config.config.bin}
 Version: ${(0, upload_util_1.debVersion)(config)}
 Section: main
 Priority: standard
 Architecture: ${arch}
 Maintainer: ${config.config.scopedEnvVar('AUTHOR') || config.config.pjson.author}
 Description: ${config.config.pjson.description}
-`,
+Aliases: ${(_a = config.config.binAliases) === null || _a === void 0 ? void 0 : _a.join(', ')}
+`;
+    },
     ftparchive: (config) => `
 APT::FTPArchive::Release {
   Origin "${config.scopedEnvVar('AUTHOR') || config.pjson.author}";
@@ -56,6 +60,7 @@ class PackDeb extends core_1.Command {
         const dist = buildConfig.dist('deb');
         await fs.emptyDir(dist);
         const build = async (arch) => {
+            var _a;
             this.log(`building debian / ${arch}`);
             const target = { platform: 'linux', arch };
             const versionedDebBase = (0, upload_util_1.templateShortKey)('deb', { bin: config.bin, versionShaRevision: (0, upload_util_1.debVersion)(buildConfig), arch: (0, upload_util_1.debArch)(arch) });
@@ -73,6 +78,7 @@ class PackDeb extends core_1.Command {
             ]);
             // symlink usr/bin/oclif points to usr/lib/oclif/bin/oclif
             await exec(`ln -s "${path.join('..', 'lib', config.dirname, 'bin', config.bin)}" "${config.bin}"`, { cwd: path.join(workspace, 'usr', 'bin') });
+            (_a = config.binAliases) === null || _a === void 0 ? void 0 : _a.map(alias => exec(`ln -sf "${path.join('..', 'lib', config.dirname, 'bin', config.bin)}" "${alias}"`, { cwd: path.join(workspace, 'usr', 'bin') }));
             await exec(`sudo chown -R root "${workspace}"`);
             await exec(`sudo chgrp -R root "${workspace}"`);
             await exec(`dpkg --build "${workspace}" "${path.join(dist, versionedDebBase)}"`);

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

@@ -1,5 +1,4 @@
-import { Command } from '@oclif/core';
-import { Interfaces } from '@oclif/core';
+import { Command, Interfaces } from '@oclif/core';
 export default class PackWin extends Command {
     static description: string;
     static flags: {

package/lib/commands/pack/win.js

@@ -213,7 +213,11 @@ class PackWin extends core_1.Command {
                 fs.writeFile(path.join(installerBase, 'bin', `${config.bin}.cmd`), scripts.cmd(config)),
                 fs.writeFile(path.join(installerBase, 'bin', `${config.bin}`), scripts.sh(config)),
                 fs.writeFile(path.join(installerBase, `${config.bin}.nsi`), scripts.nsis(config, arch)),
-            ].concat(flags['additional-cli'] ? [
+            ].concat(config.binAliases ? config.binAliases.flatMap(alias => 
+            // write duplicate files for windows aliases
+            // this avoids mklink which can require admin privileges which not everyone has
+            [fs.writeFile(path.join(installerBase, 'bin', `${alias}.cmd`), scripts.cmd(config)), fs.writeFile(path.join(installerBase, 'bin', `${alias}`), scripts.sh(config))]) : [])
+                .concat(flags['additional-cli'] ? [
                 fs.writeFile(path.join(installerBase, 'bin', `${flags['additional-cli']}.cmd`), scripts.cmd(config, flags['additional-cli'])),
                 fs.writeFile(path.join(installerBase, 'bin', `${flags['additional-cli']}`), scripts.sh({ bin: flags['additional-cli'] })),
             ] : []));

package/lib/tarballs/bin.js

@@ -3,13 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeBinScripts = void 0;
 const fs = require("fs");
 const path = require("path");
+const node_child_process_1 = require("node:child_process");
+const node_util_1 = require("node:util");
+const exec = (0, node_util_1.promisify)(node_child_process_1.exec);
 async function writeBinScripts({ config, baseWorkspace, nodeVersion }) {
+    var _a, _b;
     const binPathEnvVar = config.scopedEnvVarKey('BINPATH');
     const redirectedEnvVar = config.scopedEnvVarKey('REDIRECTED');
     const clientHomeEnvVar = config.scopedEnvVarKey('OCLIF_CLIENT_HOME');
-    const writeWin32 = async () => {
-        const { bin } = config;
-        await fs.promises.writeFile(path.join(baseWorkspace, 'bin', `${config.bin}.cmd`), `@echo off
+    const writeWin32 = async (bin) => {
+        await fs.promises.writeFile(path.join(baseWorkspace, 'bin', `${bin}.cmd`), `@echo off
 setlocal enableextensions
 
 if not "%${redirectedEnvVar}%"=="1" if exist "%LOCALAPPDATA%\\${bin}\\client\\bin\\${bin}.cmd" (
@@ -27,12 +30,6 @@ if exist "%~dp0..\\bin\\node.exe" (
   node "%~dp0..\\bin\\run" %*
 )
 `);
-        // await qq.write([output, 'bin', config.bin], `#!/bin/sh
-        // basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
-        // "$basedir/../client/bin/${config.bin}.cmd" "$@"
-        // ret=$?
-        // exit $ret
-        // `)
     };
     const writeUnix = async () => {
         const bin = path.join(baseWorkspace, 'bin', config.bin);
@@ -83,6 +80,12 @@ else
 fi
 `, { mode: 0o755 });
     };
-    await Promise.all([writeWin32(), writeUnix()]);
+    await Promise.all([
+        writeWin32(config.bin),
+        writeUnix(),
+        ...(_b = (_a = config.binAliases) === null || _a === void 0 ? void 0 : _a.map(alias => process.platform === 'win32' ?
+            writeWin32(alias) :
+            exec(`ln -sf ${config.bin} ${alias}`, { cwd: path.join(baseWorkspace, 'bin') }))) !== null && _b !== void 0 ? _b : [],
+    ]);
 }
 exports.writeBinScripts = writeBinScripts;

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "3.7.2",
+  "version": "3.8.0",
   "author": "Salesforce",
   "bin": {
-    "oclif": "bin/run"
+    "oclif": "bin/run",
+    "oclif2": "bin/run"
   },
   "bugs": "https://github.com/oclif/oclif/issues",
   "dependencies": {
-    "@oclif/core": "^2.7.1",
+    "@oclif/core": "^2.8.0",
     "@oclif/plugin-help": "^5.1.19",
     "@oclif/plugin-not-found": "^2.3.7",
     "@oclif/plugin-warn-if-update-available": "^2.0.14",
@@ -91,6 +92,9 @@
       "@oclif/plugin-not-found"
     ],
     "bin": "oclif",
+    "binAliases": [
+      "oclif2"
+    ],
     "dirname": "oclif",
     "topicSeparator": " ",
     "macos": {