@oclif/core 1.19.1 → 1.20.0

package/lib/command.d.ts

@@ -28,6 +28,10 @@ export default abstract class Command {
     /** Mark the command as a given state (e.g. beta or deprecated) in help */
     static state?: 'beta' | 'deprecated' | string;
     static deprecationOptions?: Deprecation;
+    /**
+     * Emit deprecation warning when a command alias is used
+     */
+    static deprecateAliases?: boolean;
     /**
      * An override string (or strings) for the default usage documentation.
      */

package/lib/command.js

@@ -134,9 +134,23 @@ class Command {
             if (deprecated) {
                 this.warn((0, util_2.formatFlagDeprecationWarning)(flag, deprecated));
             }
+            const deprecateAliases = this.ctor.flags[flag]?.deprecateAliases;
+            const aliases = (this.ctor.flags[flag]?.aliases ?? []).map(a => a.length === 1 ? `-${a}` : `--${a}`);
+            if (deprecateAliases && aliases.length > 0) {
+                const foundAliases = this.argv.filter(a => aliases.includes(a));
+                for (const alias of foundAliases) {
+                    this.warn((0, util_2.formatFlagDeprecationWarning)(alias, { to: this.ctor.flags[flag]?.name }));
+                }
+            }
         }
     }
     warnIfCommandDeprecated() {
+        const [id] = (0, util_2.normalizeArgv)(this.config);
+        if (this.ctor.deprecateAliases && this.ctor.aliases.includes(id)) {
+            const cmdName = (0, index_1.toConfiguredId)(this.ctor.id, this.config);
+            const aliasName = (0, index_1.toConfiguredId)(id, this.config);
+            this.warn((0, util_2.formatCommandDeprecationWarning)(aliasName, { to: cmdName }));
+        }
         if (this.ctor.state === 'deprecated') {
             const cmdName = (0, index_1.toConfiguredId)(this.ctor.id, this.config);
             this.warn((0, util_2.formatCommandDeprecationWarning)(cmdName, this.ctor.deprecationOptions));

package/lib/config/config.js

@@ -642,8 +642,10 @@ async function toCached(c, plugin) {
                 helpGroup: flag.helpGroup,
                 allowNo: flag.allowNo,
                 dependsOn: flag.dependsOn,
+                relationships: flag.relationships,
                 exclusive: flag.exclusive,
                 deprecated: flag.deprecated,
+                deprecateAliases: c.deprecateAliases,
                 aliases: flag.aliases,
             };
         }
@@ -666,6 +668,7 @@ async function toCached(c, plugin) {
                 exclusive: flag.exclusive,
                 default: await defaultToCached(flag),
                 deprecated: flag.deprecated,
+                deprecateAliases: c.deprecateAliases,
                 aliases: flag.aliases,
             };
             // a command-level placeholder in the manifest so that oclif knows it should regenerate the command during help-time
@@ -697,11 +700,12 @@ async function toCached(c, plugin) {
         aliases: c.aliases || [],
         examples: c.examples || c.example,
         deprecationOptions: c.deprecationOptions,
+        deprecateAliases: c.deprecateAliases,
         flags,
         args,
     };
     // do not include these properties in manifest
-    const ignoreCommandProperties = ['plugin', '_flags'];
+    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_globalFlags'];
     const stdKeys = Object.keys(stdProperties);
     const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property));
     const additionalProperties = {};

package/lib/flags.js

@@ -42,7 +42,7 @@ const help = (opts = {}) => {
         description: 'Show CLI help.',
         ...opts,
         parse: async (_, cmd) => {
-            new help_1.Help(cmd.config).showHelp(cmd.argv);
+            new help_1.Help(cmd.config).showHelp(cmd.id ? [cmd.id, ...cmd.argv] : cmd.argv);
             cmd.exit(0);
         },
     });

package/lib/help/index.d.ts

@@ -2,7 +2,7 @@ import * as Interfaces from '../interfaces';
 import CommandHelp from './command';
 import { HelpFormatter } from './formatter';
 export { CommandHelp } from './command';
-export { standardizeIDFromArgv, loadHelpClass, getHelpFlagAdditions } from './util';
+export { standardizeIDFromArgv, loadHelpClass, getHelpFlagAdditions, normalizeArgv } from './util';
 export declare abstract class HelpBase extends HelpFormatter {
     constructor(config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>);
     /**

package/lib/help/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Help = exports.HelpBase = exports.getHelpFlagAdditions = exports.loadHelpClass = exports.standardizeIDFromArgv = exports.CommandHelp = void 0;
+exports.Help = exports.HelpBase = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.loadHelpClass = exports.standardizeIDFromArgv = exports.CommandHelp = void 0;
 const stripAnsi = require("strip-ansi");
 const errors_1 = require("../errors");
 const command_1 = require("./command");
@@ -15,6 +15,7 @@ var util_3 = require("./util");
 Object.defineProperty(exports, "standardizeIDFromArgv", { enumerable: true, get: function () { return util_3.standardizeIDFromArgv; } });
 Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return util_3.loadHelpClass; } });
 Object.defineProperty(exports, "getHelpFlagAdditions", { enumerable: true, get: function () { return util_3.getHelpFlagAdditions; } });
+Object.defineProperty(exports, "normalizeArgv", { enumerable: true, get: function () { return util_3.normalizeArgv; } });
 function getHelpSubject(args, config) {
     // for each help flag that starts with '--' create a new flag with same name sans '--'
     const mergedHelpFlags = (0, util_2.getHelpFlagAdditions)(config);

package/lib/help/util.d.ts

@@ -12,4 +12,5 @@ export declare function standardizeIDFromArgv(argv: string[], config: IConfig):
 export declare function getHelpFlagAdditions(config: IConfig): string[];
 export declare function formatFlagDeprecationWarning(flag: string, opts: true | Deprecation): string;
 export declare function formatCommandDeprecationWarning(command: string, opts?: Deprecation): string;
+export declare function normalizeArgv(config: IConfig, argv?: string[]): string[];
 export {};

package/lib/help/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatCommandDeprecationWarning = exports.formatFlagDeprecationWarning = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.toConfiguredId = exports.toStandardizedId = exports.template = exports.loadHelpClass = void 0;
+exports.normalizeArgv = exports.formatCommandDeprecationWarning = exports.formatFlagDeprecationWarning = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.toConfiguredId = exports.toStandardizedId = exports.template = exports.loadHelpClass = void 0;
 const ejs = require("ejs");
 const _1 = require(".");
 const module_loader_1 = require("../module-loader");
@@ -100,7 +100,7 @@ function formatFlagDeprecationWarning(flag, opts) {
     if (opts.version) {
         message += ` and will be removed in version ${opts.version}`;
     }
-    message += opts.to ? `. Use "${opts.to}" instead.` : '.';
+    message += opts.to ? `. Use "--${opts.to}" instead.` : '.';
     return message;
 }
 exports.formatFlagDeprecationWarning = formatFlagDeprecationWarning;
@@ -117,3 +117,9 @@ function formatCommandDeprecationWarning(command, opts) {
     return message;
 }
 exports.formatCommandDeprecationWarning = formatCommandDeprecationWarning;
+function normalizeArgv(config, argv = process.argv.slice(2)) {
+    if (config.topicSeparator !== ':' && !argv[0]?.includes(':'))
+        argv = standardizeIDFromArgv(argv, config);
+    return argv;
+}
+exports.normalizeArgv = normalizeArgv;

package/lib/interfaces/command.d.ts

@@ -16,6 +16,10 @@ export interface CommandProps {
      * Provide details to the deprecation warning if state === 'deprecated'
      */
     deprecationOptions?: Deprecation;
+    /**
+     * Emit a deprecation warning when a command alias is used.
+     */
+    deprecateAliases?: boolean;
     /** An array of aliases for this command. */
     aliases: string[];
     /**

package/lib/interfaces/parser.d.ts

@@ -156,6 +156,10 @@ export declare type FlagProps = {
      * Alternate names that can be used for this flag.
      */
     aliases?: string[];
+    /**
+     * Emit deprecation warning when a flag alias is provided
+     */
+    deprecateAliases?: boolean;
 };
 export declare type BooleanFlagProps = FlagProps & {
     type: 'boolean';

package/lib/main.js

@@ -40,9 +40,7 @@ async function run(argv = process.argv.slice(2), options) {
     }
     // return Main.run(argv, options)
     const config = await config_1.Config.load(options || (module.parent && module.parent.parent && module.parent.parent.filename) || __dirname);
-    if (config.topicSeparator !== ':' && !argv[0]?.includes(':'))
-        argv = (0, help_1.standardizeIDFromArgv)(argv, config);
-    let [id, ...argvSlice] = argv;
+    let [id, ...argvSlice] = (0, help_1.normalizeArgv)(config, argv);
     // run init hook
     await config.runHook('init', { id, argv: argvSlice });
     // display version if applicable

package/lib/parser/parse.js

@@ -59,8 +59,11 @@ class Parser {
                     return flag.name;
             }
         };
-        const findShortFlag = (arg) => {
-            return Object.keys(this.input.flags).find(k => this.input.flags[k].char === arg[1]);
+        const findShortFlag = ([_, char]) => {
+            if (this.flagAliases[char]) {
+                return this.flagAliases[char].name;
+            }
+            return Object.keys(this.input.flags).find(k => this.input.flags[k].char === char);
         };
         const parseFlag = (arg) => {
             const long = arg.startsWith('--');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "1.19.1",
+  "version": "1.20.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {