igniteui-cli 15.0.0 → 15.1.0-beta.0

package/README.md

@@ -66,7 +66,7 @@ ig new <project name> --framework=<framework> --type=<proj-type> --theme=<theme>
 ```
 This will create the project and will install the needed dependencies.
 
-Parameters besides name are optional. Framework default to "jquery", project type defaults to the first available in the framework and theme to the first available for the project. For more information visit [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New) Wiki page.
+Parameters besides name are optional. Framework defaults to "angular", project type defaults to the first available in the framework and theme to the first available for the project. For more information visit [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New) Wiki page.
 
 #### Generate Ignite UI for Angular project
 
@@ -103,6 +103,12 @@ For full list of supported templates in the current project you can simply run [
 ig list
 ```
 
+When run outside of a generated project and without a `--framework` argument, `ig list` prints every supported framework along with its project types and available project templates — a handy overview before running `ig new`:
+```bash
+ig list
+```
+Pass `-f <framework> [-t <projectType>]` to list component templates for a specific framework/project type instead.
+
 ### Build and run
 ```bash
 ig build

package/lib/cli.js

@@ -39,22 +39,41 @@ function run() {
         commands_1.generate.templateManager = templateManager;
         commands_1.list.templateManager = templateManager;
         commands_1.upgrade.templateManager = templateManager;
+        const registeredCommands = [
+            commands_1.newCommand, commands_1.add, commands_1.build, commands_1.start, commands_1.generate, commands_1.config, commands_1.doc, commands_1.test, commands_1.list, commands_1.upgrade, commands_1.mcp, commands_1.aiConfig
+        ];
         const yargsModule = args ? (0, yargs_1.default)(args) : yargs_1.default;
-        yield yargsModule
-            .scriptName("") // prevent the addition of the name of the executing script in the usage output
-            .usage("") // do not show any usage instructions before the commands list
-            .command(commands_1.newCommand)
-            .command(commands_1.add)
-            .command(commands_1.build)
-            .command(commands_1.start)
-            .command(commands_1.generate)
-            .command(commands_1.config)
-            .command(commands_1.doc)
-            .command(commands_1.test)
-            .command(commands_1.list)
-            .command(commands_1.upgrade)
-            .command(commands_1.mcp)
-            .command(commands_1.aiConfig)
+        let chain = yargsModule
+            .scriptName("ig")
+            .usage("Usage: $0 [command] [options]\n\nRun without a command to start the interactive step-by-step project setup.")
+            .example("$0", "Launch the interactive step-by-step project setup")
+            .example("$0 new my-app --framework angular", "Scaffold a new Ignite UI for Angular project")
+            .example("$0 add grid main-grid", "Add a Grid component to the current project")
+            .example("$0 list", "Show all frameworks and their project templates");
+        for (const cmd of registeredCommands) {
+            chain = chain.command(cmd);
+        }
+        yield chain
+            .command({
+            command: "$0",
+            describe: false,
+            handler: (argv) => __awaiter(this, void 0, void 0, function* () {
+                if (argv.version)
+                    return; // version handled in the parseAsync callback
+                const unknown = argv._[0];
+                if (unknown) {
+                    process.exitCode = 1;
+                    cli_core_1.Util.error(`Unknown command: "${unknown}"`, "red");
+                    cli_core_1.Util.log(yield yargsModule.getHelp());
+                }
+                else {
+                    cli_core_1.Util.log("Starting Step by step mode.", "green");
+                    cli_core_1.Util.log("For available commands, stop this execution and use --help.", "green");
+                    const prompts = new PromptSession_1.PromptSession(templateManager);
+                    prompts.start();
+                }
+            })
+        })
             .version(false) // disable built-in `yargs.version` to override it with our custom option
             .options({
             version: {
@@ -71,16 +90,6 @@ function run() {
                 hidden: true
             }
         })
-            .middleware((argv) => {
-            // invoked after parsing and before the `yargsModule.parseAsync` callback
-            const command = argv._[0];
-            if (command === commands_1.ADD_COMMAND_NAME && !commands_1.add.check(argv)) {
-                argv.skipExecution = true;
-                yargsModule.showHelp();
-            }
-        }, false // setting this to `true` is supposed to exec the middleware after parsing and before arg validation
-        // but in reality it also does not trigger the command's handler (╯°□°）╯︵ ┻━┻
-        )
             .fail((msg, err, yargs) => {
             var _a;
             const message = (_a = err === null || err === void 0 ? void 0 : err.message) !== null && _a !== void 0 ? _a : msg;
@@ -90,6 +99,7 @@ function run() {
                 process.exitCode = 1;
             }
         })
+            .wrap(yargs_1.default.terminalWidth())
             .help().alias("help", "h")
             .parseAsync(args, // the args to parse to argv
         {}, // docs say context to pass in to handlers, but nuh-uh, it's just garbage
@@ -104,8 +114,7 @@ function run() {
                 }
                 process.exit(1);
             }
-            const helpRequest = argv.h || argv.help;
-            if (helpRequest) {
+            if (argv.h || argv.help) {
                 logHelp();
             }
             // since we are providing a custom callback to `yargsModule.parseAsync`, we need to handle the output as well
@@ -120,19 +129,6 @@ function run() {
             // internal testing only
             /* istanbul ignore next */
             cli_core_1.App.testMode = !!argv.testMode;
-            if (!helpRequest && !commands_1.ALL_COMMANDS.has(command === null || command === void 0 ? void 0 : command.toString())) {
-                if (command) {
-                    process.exitCode = 1;
-                    cli_core_1.Util.error(`Unknown command: "${command}"`, "red");
-                    cli_core_1.Util.log(yield yargsModule.getHelp());
-                }
-                else {
-                    cli_core_1.Util.log("Starting Step by step mode.", "green");
-                    cli_core_1.Util.log("For available commands, stop this execution and use --help.", "green");
-                    const prompts = new PromptSession_1.PromptSession(templateManager);
-                    prompts.start();
-                }
-            }
         }));
     });
 }

package/lib/commands/add.js

@@ -11,35 +11,48 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_core_1 = require("@igniteui/cli-core");
 const PromptSession_1 = require("./../PromptSession");
+let yargsContext;
 const command = {
     command: "add [template] [name]",
-    describe: "adds template by its ID",
+    describe: "Adds a component or view template to the current project",
     templateManager: null,
-    builder: {
-        "template": {
+    builder: (yargs) => {
+        yargsContext = yargs;
+        return yargs
+            .positional("template", {
+            describe: `Template ID (e.g. "grid", "combo"); same as --template/-t`,
+            type: "string"
+        })
+            .positional("name", {
+            describe: "File name (same as --name/-n)",
+            type: "string"
+        })
+            .option("template", {
             alias: "t",
-            description: `Template ID, such as "grid", "combo", etc.`,
+            describe: `Template ID (e.g. "grid", "combo")`,
             type: "string",
             global: true
-        },
-        "name": {
+        })
+            .option("name", {
             alias: "n",
-            description: "File name.",
+            describe: "File name",
             type: "string",
             global: true
-        },
-        "module": {
+        })
+            .option("module", {
             alias: "m",
-            description: "The module to which the template is to be added",
+            describe: "Module to which the template is to be added",
             type: "string",
             global: true
-        },
-        "skip-route": {
+        })
+            .option("skip-route", {
             alias: "skr",
-            describe: "Don't auto-generate an app navigation route for the new component",
+            describe: "Do not auto-generate an app navigation route for the new component",
             type: "boolean",
             global: true
-        }
+        })
+            .example("$0 add", "Launch guided component picker")
+            .example("$0 add grid main-grid", "Add a Grid component named main-grid");
     },
     check: (argv) => {
         if ((!argv.name && argv.template) || (argv.name && !argv.template)) {
@@ -49,7 +62,8 @@ const command = {
     },
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (argv.skipExecution) {
+            if (!command.check(argv)) {
+                yargsContext === null || yargsContext === void 0 ? void 0 : yargsContext.showHelp();
                 return;
             }
             cli_core_1.GoogleAnalytics.post({

package/lib/commands/ai-config.js

@@ -46,8 +46,8 @@ function configure(skills = true) {
 }
 const command = {
     command: "ai-config",
-    describe: "Configure Ignite UI AI tooling (MCP servers and AI coding skills)",
-    builder: (yargs) => yargs.usage(""),
+    describe: "Configures Ignite UI AI tooling (MCP servers and AI coding skills)",
+    builder: (yargs) => yargs,
     handler(_argv) {
         return __awaiter(this, void 0, void 0, function* () {
             cli_core_1.GoogleAnalytics.post({

package/lib/commands/build.js

@@ -37,10 +37,8 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const command = {
     command: "build",
-    describe: "builds the project",
-    builder: (yargs) => {
-        return yargs.usage(""); // do not show any usage instructions before the commands
-    },
+    describe: "Builds the project",
+    builder: (yargs) => yargs,
     templateManager: null,
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -56,7 +54,7 @@ const command = {
             cli_core_1.Util.log("Build started.");
             yield cli_core_1.PackageManager.ensureIgniteUISource(true, command.templateManager);
             if (!cli_core_1.ProjectConfig.hasLocalConfig()) {
-                cli_core_1.Util.error("Add command is supported only on existing project created with igniteui-cli", "red");
+                cli_core_1.Util.error("Build command is supported only on existing project created with igniteui-cli", "red");
                 return;
             }
             const config = cli_core_1.ProjectConfig.getConfig();

package/lib/commands/config.js

@@ -3,18 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_core_1 = require("@igniteui/cli-core");
 const command = {
     command: "config",
-    describe: "gets, sets or adds a configuration property",
+    describe: "Gets, sets or adds a configuration property (see subcommands)",
     builder: (yargs) => {
         return yargs
             .command({
             command: "get <property>",
             describe: "Gets a configuration property",
             builder: (yargs) => {
-                return yargs.option("property", {
+                return yargs.positional("property", {
                     describe: "Config property to get",
                     type: "string"
-                })
-                    .usage(""); // do not show any usage instructions before the commands list
+                });
             },
             handler: command.getHandler
         })
@@ -22,15 +21,14 @@ const command = {
             command: "set <property> <value>",
             describe: "Sets a configuration property",
             builder: (yargs) => {
-                return yargs.option("property", {
+                return yargs.positional("property", {
                     describe: "Config property to set",
                     type: "string"
                 })
-                    .option("value", {
+                    .positional("value", {
                     describe: "New value for the property",
                     type: "string"
-                })
-                    .usage(""); // do not show any usage instructions before the commands list
+                });
             },
             handler: command.setHandler
         })
@@ -38,15 +36,14 @@ const command = {
             command: "add <property> <value>",
             describe: "Adds a value to an existing configuration array",
             builder: (yargs) => {
-                return yargs.option("property", {
+                return yargs.positional("property", {
                     describe: "Config property to add to",
                     type: "string"
                 })
-                    .option("value", {
+                    .positional("value", {
                     describe: "New value to add",
                     type: "string"
-                })
-                    .usage(""); // do not show any usage instructions before the commands list
+                });
             },
             handler: command.addHandler
         })
@@ -54,9 +51,8 @@ const command = {
             alias: "g",
             type: "boolean",
             global: true,
-            describe: "Specify if the global configuration should be used"
+            describe: "Use the global configuration"
         })
-            .usage("") // do not show any usage instructions before the commands list
             // at least one command is required
             .demandCommand(1, "Please select command");
     },

package/lib/commands/doc.js

@@ -36,14 +36,13 @@ const cli_core_1 = require("@igniteui/cli-core");
 const PromptSession_1 = require("../PromptSession");
 const doc = {
     command: "doc [term]",
-    describe: "opens the Infragistics search for the given term",
+    describe: "Opens the Infragistics search for the given term",
     builder: (yargs) => {
         return yargs
-            .option("term", {
-            describe: "The term you would like to search for",
+            .positional("term", {
+            describe: "Term to search for",
             type: "string"
-        })
-            .usage(""); // do not show any usage instructions before the commands list
+        });
     },
     open: (target) => __awaiter(void 0, void 0, void 0, function* () {
         const open = yield Promise.resolve().then(() => __importStar(require("open")));

package/lib/commands/generate.js

@@ -100,20 +100,20 @@ function handler(argv) {
 const command = {
     aliases: ["g"],
     command: "generate",
-    describe: "generates custom template",
+    describe: "Generates custom templates (see subcommands)",
     templateManager: null,
     builder: yargs => {
         yargs
             .command({
             aliases: ["t"],
             command: "template [name]",
-            describe: "generates custom template",
+            describe: "Generates a custom template scaffold",
             builder: (yargs) => {
                 return yargs
                     .option("framework", {
                     alias: "f",
                     default: "jquery",
-                    describe: "Framework to generate template for",
+                    describe: "Framework to generate the template for",
                     type: "string"
                 })
                     .option("name", {
@@ -125,19 +125,17 @@ const command = {
                     .option("skip-config", {
                     alias: "s",
                     default: false,
-                    describe: "Runs generate command without updating the cli config",
+                    describe: "Run without updating the CLI config",
                     type: "boolean"
                 })
                     .option("type", {
                     alias: "t",
                     describe: "Project type (depends on framework)",
                     type: "string"
-                })
-                    .usage(""); // do not show any usage instructions before the commands list
+                });
             },
             handler
         })
-            .usage("") // do not show any usage instructions before the commands list
             // at least one command is required
             .demandCommand(1, "Please select command");
         return yargs;

package/lib/commands/list.js

@@ -5,19 +5,21 @@ const command = {
     command: "list",
     // use aliases here, instead of alias. With single alias yargs does not build correctly argv
     aliases: ["l"],
-    describe: "list all templates",
-    builder: {
-        framework: {
+    describe: "Lists frameworks, project templates and component templates",
+    builder: (yargs) => {
+        return yargs
+            .option("framework", {
             alias: "f",
-            default: "jquery",
             describe: "Framework to list templates for",
             type: "string"
-        },
-        type: {
+        })
+            .option("type", {
             alias: "t",
             describe: "Project type (depends on framework)",
             type: "string"
-        }
+        })
+            .example("$0 list", "Show all frameworks and their project templates")
+            .example("$0 list -f angular", "List component templates for Angular");
     },
     templateManager: null,
     handler(argv) {
@@ -33,6 +35,12 @@ const command = {
             argv.type = config.project.projectType;
             inProject = true;
         }
+        if (!inProject && !argv.framework) {
+            if (argv.type) {
+                return cli_core_1.Util.error("'--type' requires '--framework'", "red");
+            }
+            return listAllFrameworks();
+        }
         const templatesByGroup = [];
         const controlGroups = [];
         const framework = command.templateManager.getFrameworkById(argv.framework);
@@ -93,4 +101,35 @@ const command = {
         }
     }
 };
+function listAllFrameworks() {
+    const frameworkIds = command.templateManager.getFrameworkIds();
+    const frameworks = frameworkIds
+        .map(id => command.templateManager.getFrameworkById(id))
+        .filter(f => !!f);
+    cli_core_1.GoogleAnalytics.post({
+        t: "event",
+        ec: "$ig list",
+        ea: "all frameworks"
+    });
+    cli_core_1.Util.log("Available frameworks and project templates:");
+    for (const framework of frameworks) {
+        cli_core_1.Util.log("");
+        cli_core_1.Util.log(`${framework.name} (${framework.id})`);
+        for (const lib of framework.projectLibraries) {
+            cli_core_1.Util.log(`\t${lib.name} (${lib.projectType})`);
+            const visibleProjects = lib.projects.filter(p => !p.isHidden);
+            if (visibleProjects.length === 0) {
+                cli_core_1.Util.log("\t\t(no project templates)");
+                continue;
+            }
+            const formattedItems = cli_core_1.Util.formatChoices(visibleProjects.map(p => ({ name: p.id, description: p.description })));
+            for (const item of formattedItems) {
+                cli_core_1.Util.log("\t\t" + item.name);
+            }
+        }
+    }
+    cli_core_1.Util.log("");
+    cli_core_1.Util.log("Run 'ig new <name> --framework <framework> --type <projectType>' to scaffold a project.");
+    cli_core_1.Util.log("Run 'ig list -f <framework> [-t <projectType>]' to list component templates.");
+}
 exports.default = command;

package/lib/commands/mcp.js

@@ -50,8 +50,7 @@ const command = {
             describe: "Enable debug logging to mcp-server.log",
             type: "boolean",
             default: false
-        })
-            .usage("");
+        });
     },
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/commands/new.js

@@ -39,16 +39,20 @@ const TemplateManager_1 = require("../TemplateManager");
 // explicit typing because `type: "string"` will be inferred as `type: string` which yargs will not like
 const _framework = {
     alias: "f",
-    default: "jquery",
-    describe: "Framework to setup project for",
+    default: "angular",
+    describe: "Framework to scaffold the project for.",
     type: "string",
     choices: []
 };
 const command = {
     command: "new [name]",
-    describe: "creates a project",
+    describe: "Creates a project",
     builder: (yargs) => {
         return yargs
+            .positional("name", {
+            describe: "Project name (same as --name/-n)",
+            type: "string"
+        })
             .option("name", {
             alias: "n",
             describe: "Project name",
@@ -67,19 +71,20 @@ const command = {
         })
             .option("skip-git", {
             alias: "sg",
-            describe: "Do not automatically initialize repository for the project with Git",
+            describe: "Do not initialize a git repository for the project",
             type: "boolean"
         })
             .option("skip-install", {
             alias: "si",
-            describe: "Do not automatically install packages",
+            describe: "Do not install packages after scaffolding",
             type: "boolean"
         })
             .option("template", {
             describe: "Project template",
             type: "string"
         })
-            .usage(""); // do not show any usage instructions before the commands list
+            .example("$0 new my-app", "Scaffold a new project interactively")
+            .example("$0 new my-app -f angular -t igx-ts", "Scaffold an Ignite UI for Angular project");
     },
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/commands/start.js

@@ -53,16 +53,15 @@ const execSyncNpmStart = (port, options) => {
 };
 const command = {
     command: "start",
-    describe: "starts the project",
+    describe: "Starts the project",
     templateManager: null,
     builder: (yargs) => {
         return yargs
             .option("port", {
             alias: "p",
-            describe: "serve app port",
+            describe: "Port to serve the app on",
             type: "number"
-        })
-            .usage(""); // do not show any usage instructions before the commands
+        });
     },
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/commands/test.js

@@ -12,14 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_core_1 = require("@igniteui/cli-core");
 const command = {
     command: "test",
-    describe: "executes project tests",
+    describe: "Executes project tests",
     builder: (yargs) => {
         return yargs
             .option("e2e", {
-            describe: "Executes end-to-end tests",
+            describe: "Execute end-to-end tests",
             type: "boolean"
-        })
-            .usage(""); // do not show any usage instructions before the commands list
+        });
     },
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/commands/types.d.ts

@@ -1,19 +1,6 @@
 import { ArgumentsCamelCase, CommandModule } from "yargs";
 import { TemplateManager } from "../TemplateManager";
 import { AddTemplateArgs, Template } from "@igniteui/cli-core";
-export declare const ADD_COMMAND_NAME = "add";
-export declare const NEW_COMMAND_NAME = "new";
-export declare const BUILD_COMMAND_NAME = "build";
-export declare const START_COMMAND_NAME = "start";
-export declare const GENERATE_COMMAND_NAME = "generate";
-export declare const CONFIG_COMMAND_NAME = "config";
-export declare const DOC_COMMAND_NAME = "doc";
-export declare const TEST_COMMAND_NAME = "test";
-export declare const LIST_COMMAND_NAME = "list";
-export declare const UPGRADE_COMMAND_NAME = "upgrade-packages";
-export declare const MCP_COMMAND_NAME = "mcp";
-export declare const AI_CONFIG_COMMAND_NAME = "ai-config";
-export declare const ALL_COMMANDS: Set<string>;
 export interface PositionalArgs {
     /** The framework that the project will target. */
     framework?: string;
@@ -26,8 +13,6 @@ export interface PositionalArgs {
     template?: string;
     module?: string;
     skipRoute?: boolean;
-    /** Prevents the execution of a commands handler. For internal use only. */
-    skipExecution?: boolean;
     /** Port to run the generated app on. */
     port?: number;
     skipConfig?: boolean;

package/lib/commands/types.js

@@ -1,29 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALL_COMMANDS = exports.AI_CONFIG_COMMAND_NAME = exports.MCP_COMMAND_NAME = exports.UPGRADE_COMMAND_NAME = exports.LIST_COMMAND_NAME = exports.TEST_COMMAND_NAME = exports.DOC_COMMAND_NAME = exports.CONFIG_COMMAND_NAME = exports.GENERATE_COMMAND_NAME = exports.START_COMMAND_NAME = exports.BUILD_COMMAND_NAME = exports.NEW_COMMAND_NAME = exports.ADD_COMMAND_NAME = void 0;
-exports.ADD_COMMAND_NAME = "add";
-exports.NEW_COMMAND_NAME = "new";
-exports.BUILD_COMMAND_NAME = "build";
-exports.START_COMMAND_NAME = "start";
-exports.GENERATE_COMMAND_NAME = "generate";
-exports.CONFIG_COMMAND_NAME = "config";
-exports.DOC_COMMAND_NAME = "doc";
-exports.TEST_COMMAND_NAME = "test";
-exports.LIST_COMMAND_NAME = "list";
-exports.UPGRADE_COMMAND_NAME = "upgrade-packages";
-exports.MCP_COMMAND_NAME = "mcp";
-exports.AI_CONFIG_COMMAND_NAME = "ai-config";
-exports.ALL_COMMANDS = new Set([
-    exports.ADD_COMMAND_NAME,
-    exports.NEW_COMMAND_NAME,
-    exports.BUILD_COMMAND_NAME,
-    exports.START_COMMAND_NAME,
-    exports.GENERATE_COMMAND_NAME,
-    exports.CONFIG_COMMAND_NAME,
-    exports.DOC_COMMAND_NAME,
-    exports.TEST_COMMAND_NAME,
-    exports.LIST_COMMAND_NAME,
-    exports.UPGRADE_COMMAND_NAME,
-    exports.MCP_COMMAND_NAME,
-    exports.AI_CONFIG_COMMAND_NAME
-]);

package/lib/commands/upgrade.js

@@ -12,17 +12,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_core_1 = require("@igniteui/cli-core");
 const command = {
     command: "upgrade-packages",
-    describe: "upgrades Ignite UI Packages",
+    aliases: ["upgrade"],
+    describe: "Upgrades Ignite UI packages",
     templateManager: null,
     builder: (yargs) => {
         return yargs
             .option("skip-install", {
             alias: "si",
             default: false,
-            describe: "Runs upgrade command without performing install",
+            describe: "Run upgrade without installing packages",
             type: "boolean"
-        })
-            .usage(""); // do not show any usage instructions before the commands list
+        });
     },
     handler(argv) {
         return __awaiter(this, void 0, void 0, function* () {