@mschauer5/spfx-toolkit 1.0.27 → 1.0.28

package/src/index.ts

@@ -1,261 +1,261 @@
-#! /usr/bin/env node
-import chalk from 'chalk';
-import * as commander from 'commander';
-import { Command } from 'commander';
-import * as commands from './commands';
-import { logger, util } from './common';
-const program = new Command();
-
-const defaultToolkitName = 'spfx-toolkit';
-
-program
-  .name('Matt Schauer SPFx Toolkit')
-  .description('CLI to help with SPFx development')
-  .addHelpText('beforeAll', chalk.blueBright('Developed by Matt Schauer'))
-  .version('1.0.27');
-
-program
-  .command('add-alias')
-  .description('add alias')
-  .addArgument(new commander.Argument('<name>', 'alias name to use for this program'))
-  .action((name) => {
-    commands.alias.addAlias(name, defaultToolkitName);
-  });
-
-program
-  .command('add-project')
-  .description('add project shortcut')
-  .addArgument(new commander.Argument('[name]', 'give the project a name or default to folder name'))
-  .action((name) => {
-    commands.projects.addProject(name);
-  });
-
-program
-  .command('open-project')
-  .alias('op')
-  .description('open project')
-  .addArgument(new commander.Argument('[name]', 'project name to open'))
-  .action((name) => {
-    if (!name) {
-      logger.error('Project name is required.');
-      return;
-    }
-    commands.projects.openProject(name);
-  });
-
-program
-  .command('clear-alias')
-  .description('remove any alias for spfx-toolkit')
-  .action(() => {
-    commands.alias.clearAlias(defaultToolkitName);
-  });
-
-program
-  .command('set-repo')
-  .description('Set current folder as the default repo location')
-  .action(() => {
-    commands.repo.SetRepo();
-  });
-
-program
-  .command('repo [args...]')
-  .description('Go to repository location')
-  .action((args) => {
-    commands.repo.goToRepo(Array.isArray(args) ? args : []);
-  });
-
-program
-  .command('serve')
-  .alias('s')
-  .description('Serve / Start the SPFx Project')
-  .action(() => {
-    commands.scripts.run('serve');
-  });
-
-program
-  .command('build')
-  .alias('bl')
-  .description('Build Project')
-  .action(() => {
-    commands.scripts.run('build');
-  });
-
-program
-  .command('bundle')
-  .alias('bn')
-  .description('Bundle Project')
-  .option('-i, --increment <part>', 'Increment package version (major, minor, patch)', (value: string) => {
-    if (!['major', 'minor', 'patch'].includes(value)) {
-      throw new Error(`Invalid increment part: ${value}.  Must be one of major, minor, or patch.`);
-    }
-    return value; // Return the validated value
-  })
-  .action((options) => {
-    commands.scripts.run('bundle', options.increment);
-  });
-
-program
-  .command('run')
-  .alias('r')
-  .description('Run a script from package.json by name')
-  .addArgument(new commander.Argument('<name>', 'script name to run from package.json'))
-  .action((name) => {
-    commands.scripts.run(name);
-  });
-
-program
-  .command('install')
-  .alias('i')
-  .description('Run an install')
-  .addArgument(new commander.Argument('[packages]', 'script name in global config or local OR package(s) to install'))
-  .action((packages) => {
-    commands.installer.install(packages, false);
-  });
-
-program
-  .command('install-packages')
-  .alias('ips')
-  .description('Run an installer package from global package.json by name')
-  .addArgument(new commander.Argument('<name>', 'package name in global config to install'))
-  .action((name) => {
-    commands.installer.install(name, true);
-  });
-
-program
-  .command('add-nvmrc')
-  .description('Add .nvmrc file with current specified Node version')
-  .action(() => {
-    commands.nvmrc.addNvmrc();
-  });
-
-program
-  .command('use-nvmrc')
-  .description('Use Node version specified in .nvmrc file')
-  .action(() => {
-    commands.nvmrc.useNvmrc();
-  });
-
-program
-  .command('uninstall')
-  .alias('un')
-  .description('Run an uninstall')
-  .addArgument(new commander.Argument('<packages>', 'script name in global config or local OR package(s) to uninstall'))
-  .action((packages) => {
-    commands.installer.uninstall(packages, false);
-  });
-
-program
-  .command('uninstall-script')
-  .alias('uns')
-  .description('Run an uninstall script from package.json by name')
-  .addArgument(new commander.Argument('<name>', 'script name in global config or local to uninstall'))
-
-  .action((name) => {
-    commands.installer.uninstall(name, true);
-  });
-
-program
-  .command('open-global-config')
-  .alias('ogc')
-  .description('Open global package.json for spfx-toolkit')
-  .action(() => {
-    util.openGlobalPackageJsonInEditor();
-  });
-
-program
-  .command('global-config-init')
-  .alias('ogci')
-  .description('Set default scripts in global package.json for spfx-toolkit')
-  .option('-f, --force', 'If set will overwrite existing scripts names in global package.json')
-  .action((options) => {
-    util.initGlobalPackageJsonWithDefaults(options.force);
-  });
-
-program
-  .command('sync-script')
-  .description('Sync a script name from global or local package.json')
-  .addArgument(new commander.Argument('<name>', 'script name in package.json'))
-  .addArgument(new commander.Argument('<to>', 'global | local'))
-  .action((name, to) => {
-    if (to !== 'global' && to !== 'local') {
-      logger.error("Source must be either 'global' or 'local'.");
-      return;
-    }
-    commands.scripts.sync(name, to);
-  });
-
-program
-  .command('open-solution')
-  .alias('os')
-  .description('Open solution folder')
-  .action(() => {
-    commands.open.solution();
-  });
-
-program
-  .command('open-directory')
-  .alias('od')
-  .description('Open directory folder')
-  .action(() => {
-    commands.open.directory();
-  });
-
-program
-  .command('open-vs')
-  .alias('vs')
-  .description('Open current directory in VS Code')
-  .action(() => {
-    commands.open.vs();
-  });
-
-program
-  .command('eslint')
-  .description('Backup and restore eslint file')
-  .option('-b, --backup', 'Backup the eslint file')
-  .option('-r, --restore', 'Restore from backup eslint file')
-  .action((options) => {
-    if (options.backup) {
-      commands.env.backupEslint();
-    } else if (options.restore) {
-      commands.env.restoreEslint();
-    } else {
-      logger.error('No action specified. Use --backup | -b <OR> --restore | -r');
-    }
-  });
-
-program
-  .command('set-env')
-  .description('Set tenantDomain environment variables')
-  .addArgument(new commander.Argument('[tenantDomain]', 'Tenant domain to set'))
-  .option('-t, --tenant <tenantDomain>', 'Specify the tenant domain')
-  .action((tenantDomain, options) => {
-    // Prefer positional argument, fallback to option
-    const domain = tenantDomain || options.tenant;
-
-    commands.envCommands.setEnv(domain);
-  });
-
-program
-  .command('version')
-  .option('-l, --list', 'List SPFx project versions')
-  .option('-s, --sync', 'Sync package.json version with package-solution.json version')
-  .option('-i, --increment <part>', 'Increment package version (major, minor, patch)', (value: string) => {
-    if (!['major', 'minor', 'patch'].includes(value)) {
-      throw new Error(`Invalid increment part: ${value}.  Must be one of major, minor, or patch.`);
-    }
-    return value; // Return the validated value
-  })
-  .action((options) => {
-    const { list, sync } = options;
-    if (list) {
-      commands.version.listVersions();
-    } else if (sync) {
-      commands.version.syncVersion();
-    } else if (options.increment) {
-      commands.version.incrementVersion(options.increment);
-    } else {
-      logger.error('No action specified. Use --list | -l OR --sync | -s OR --increment | -i');
-    }
-  });
-
-program.parse();
+#! /usr/bin/env node
+import chalk from 'chalk';
+import * as commander from 'commander';
+import { Command } from 'commander';
+import * as commands from './commands';
+import { logger, util } from './common';
+const program = new Command();
+
+const defaultToolkitName = 'spfx-toolkit';
+
+program
+  .name('Matt Schauer SPFx Toolkit')
+  .description('CLI to help with SPFx development')
+  .addHelpText('beforeAll', chalk.blueBright('Developed by Matt Schauer'))
+  .version('1.0.27');
+
+program
+  .command('add-alias')
+  .description('add alias')
+  .addArgument(new commander.Argument('<name>', 'alias name to use for this program'))
+  .action((name) => {
+    commands.alias.addAlias(name, defaultToolkitName);
+  });
+
+program
+  .command('add-project')
+  .description('add project shortcut')
+  .addArgument(new commander.Argument('[name]', 'give the project a name or default to folder name'))
+  .action((name) => {
+    commands.projects.addProject(name);
+  });
+
+program
+  .command('open-project')
+  .alias('op')
+  .description('open project')
+  .addArgument(new commander.Argument('[name]', 'project name to open'))
+  .action((name) => {
+    if (!name) {
+      logger.error('Project name is required.');
+      return;
+    }
+    commands.projects.openProject(name);
+  });
+
+program
+  .command('clear-alias')
+  .description('remove any alias for spfx-toolkit')
+  .action(() => {
+    commands.alias.clearAlias(defaultToolkitName);
+  });
+
+program
+  .command('set-repo')
+  .description('Set current folder as the default repo location')
+  .action(() => {
+    commands.repo.SetRepo();
+  });
+
+program
+  .command('repo [args...]')
+  .description('Go to repository location')
+  .action((args) => {
+    commands.repo.goToRepo(Array.isArray(args) ? args : []);
+  });
+
+program
+  .command('serve')
+  .alias('s')
+  .description('Serve / Start the SPFx Project')
+  .action(() => {
+    commands.scripts.run('serve');
+  });
+
+program
+  .command('build')
+  .alias('bl')
+  .description('Build Project')
+  .action(() => {
+    commands.scripts.run('build');
+  });
+
+program
+  .command('bundle')
+  .alias('bn')
+  .description('Bundle Project')
+  .option('-i, --increment <part>', 'Increment package version (major, minor, patch)', (value: string) => {
+    if (!['major', 'minor', 'patch'].includes(value)) {
+      throw new Error(`Invalid increment part: ${value}.  Must be one of major, minor, or patch.`);
+    }
+    return value; // Return the validated value
+  })
+  .action((options) => {
+    commands.scripts.run('bundle', options.increment);
+  });
+
+program
+  .command('run')
+  .alias('r')
+  .description('Run a script from package.json by name')
+  .addArgument(new commander.Argument('<name>', 'script name to run from package.json'))
+  .action((name) => {
+    commands.scripts.run(name);
+  });
+
+program
+  .command('install')
+  .alias('i')
+  .description('Run an install')
+  .addArgument(new commander.Argument('[packages]', 'script name in global config or local OR package(s) to install'))
+  .action((packages) => {
+    commands.installer.install(packages, false);
+  });
+
+program
+  .command('install-packages')
+  .alias('ips')
+  .description('Run an installer package from global package.json by name')
+  .addArgument(new commander.Argument('<name>', 'package name in global config to install'))
+  .action((name) => {
+    commands.installer.install(name, true);
+  });
+
+program
+  .command('add-nvmrc')
+  .description('Add .nvmrc file with current specified Node version')
+  .action(() => {
+    commands.nvmrc.addNvmrc();
+  });
+
+program
+  .command('use-nvmrc')
+  .description('Use Node version specified in .nvmrc file')
+  .action(() => {
+    commands.nvmrc.useNvmrc();
+  });
+
+program
+  .command('uninstall')
+  .alias('un')
+  .description('Run an uninstall')
+  .addArgument(new commander.Argument('<packages>', 'script name in global config or local OR package(s) to uninstall'))
+  .action((packages) => {
+    commands.installer.uninstall(packages, false);
+  });
+
+program
+  .command('uninstall-script')
+  .alias('uns')
+  .description('Run an uninstall script from package.json by name')
+  .addArgument(new commander.Argument('<name>', 'script name in global config or local to uninstall'))
+
+  .action((name) => {
+    commands.installer.uninstall(name, true);
+  });
+
+program
+  .command('open-global-config')
+  .alias('ogc')
+  .description('Open global package.json for spfx-toolkit')
+  .action(() => {
+    util.openGlobalPackageJsonInEditor();
+  });
+
+program
+  .command('global-config-init')
+  .alias('ogci')
+  .description('Set default scripts in global package.json for spfx-toolkit')
+  .option('-f, --force', 'If set will overwrite existing scripts names in global package.json')
+  .action((options) => {
+    util.initGlobalPackageJsonWithDefaults(options.force);
+  });
+
+program
+  .command('sync-script')
+  .description('Sync a script name from global or local package.json')
+  .addArgument(new commander.Argument('<name>', 'script name in package.json'))
+  .addArgument(new commander.Argument('<to>', 'global | local'))
+  .action((name, to) => {
+    if (to !== 'global' && to !== 'local') {
+      logger.error("Source must be either 'global' or 'local'.");
+      return;
+    }
+    commands.scripts.sync(name, to);
+  });
+
+program
+  .command('open-solution')
+  .alias('os')
+  .description('Open solution folder')
+  .action(() => {
+    commands.open.solution();
+  });
+
+program
+  .command('open-directory')
+  .alias('od')
+  .description('Open directory folder')
+  .action(() => {
+    commands.open.directory();
+  });
+
+program
+  .command('open-vs')
+  .alias('vs')
+  .description('Open current directory in VS Code')
+  .action(() => {
+    commands.open.vs();
+  });
+
+program
+  .command('eslint')
+  .description('Backup and restore eslint file')
+  .option('-b, --backup', 'Backup the eslint file')
+  .option('-r, --restore', 'Restore from backup eslint file')
+  .action((options) => {
+    if (options.backup) {
+      commands.env.backupEslint();
+    } else if (options.restore) {
+      commands.env.restoreEslint();
+    } else {
+      logger.error('No action specified. Use --backup | -b <OR> --restore | -r');
+    }
+  });
+
+program
+  .command('set-env')
+  .description('Set tenantDomain environment variables')
+  .addArgument(new commander.Argument('[tenantDomain]', 'Tenant domain to set'))
+  .option('-t, --tenant <tenantDomain>', 'Specify the tenant domain')
+  .action((tenantDomain, options) => {
+    // Prefer positional argument, fallback to option
+    const domain = tenantDomain || options.tenant;
+
+    commands.envCommands.setEnv(domain);
+  });
+
+program
+  .command('version')
+  .option('-l, --list', 'List SPFx project versions')
+  .option('-s, --sync', 'Sync package.json version with package-solution.json version')
+  .option('-i, --increment <part>', 'Increment package version (major, minor, patch)', (value: string) => {
+    if (!['major', 'minor', 'patch'].includes(value)) {
+      throw new Error(`Invalid increment part: ${value}.  Must be one of major, minor, or patch.`);
+    }
+    return value; // Return the validated value
+  })
+  .action((options) => {
+    const { list, sync } = options;
+    if (list) {
+      commands.version.listVersions();
+    } else if (sync) {
+      commands.version.syncVersion();
+    } else if (options.increment) {
+      commands.version.incrementVersion(options.increment);
+    } else {
+      logger.error('No action specified. Use --list | -l OR --sync | -s OR --increment | -i');
+    }
+  });
+
+program.parse();

package/lib/commands/install.command.js

@@ -1,28 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-const detect_package_manager_1 = require("detect-package-manager");
-const scripts_command_1 = require("./scripts.command");
-const run = (name) => __awaiter(void 0, void 0, void 0, function* () {
-    const usercommand = yield (0, detect_package_manager_1.detect)();
-    const getScriptByNameValue = yield (0, scripts_command_1.getScriptByName)(`install:${name}`);
-    if (getScriptByNameValue !== undefined) {
-        const args = getScriptByNameValue.split(' ');
-        // add install to the command
-        args.unshift('install');
-        const spawn = require('cross-spawn');
-        spawn.sync(usercommand, args, { stdio: 'inherit' });
-        return;
-    }
-});
-exports.run = run;
-//# sourceMappingURL=install.command.js.map

package/lib/commands/install.command.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"install.command.js","sourceRoot":"","sources":["../../src/commands/install.command.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mEAAgD;AAChD,uDAAoD;AAE7C,MAAM,GAAG,GAAG,CAAO,IAAY,EAAE,EAAE;IACxC,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAM,GAAE,CAAC;IAEnC,MAAM,oBAAoB,GAAG,MAAM,IAAA,iCAAe,EAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IACtE,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,oBAAoB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7C,6BAA6B;QAC7B,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAExB,MAAM,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QACpD,OAAO;IACT,CAAC;AACH,CAAC,CAAA,CAAC;AAbW,QAAA,GAAG,OAad"}

package/lib/commands/open-solution.command.js

@@ -1,30 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openSolution = void 0;
-const path_1 = __importDefault(require("path"));
-const child_process_1 = __importDefault(require("child_process"));
-const common_1 = require("../common");
-const openSolution = () => {
-    let solutionPath = path_1.default.resolve(common_1.constants.WORKING_DIRECTORY, 'sharepoint', 'solution');
-    var cmd = ``;
-    switch (require(`os`).platform().toLowerCase().replace(/[0-9]/g, ``).replace(`darwin`, `macos`)) {
-        case `win`:
-            solutionPath = solutionPath || '=';
-            cmd = `explorer`;
-            break;
-        case `linux`:
-            solutionPath = solutionPath || '/';
-            cmd = `xdg-open`;
-            break;
-        case `macos`:
-            solutionPath = solutionPath || '/';
-            cmd = `open`;
-            break;
-    }
-    child_process_1.default.spawn(cmd, [solutionPath]);
-};
-exports.openSolution = openSolution;
-//# sourceMappingURL=open-solution.command.js.map

package/lib/commands/open-solution.command.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"open-solution.command.js","sourceRoot":"","sources":["../../src/commands/open-solution.command.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,kEAAuC;AACvC,sCAAsC;AAE/B,MAAM,YAAY,GAAG,GAAG,EAAE;IAC/B,IAAI,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,kBAAS,CAAC,iBAAiB,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;IAEvF,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,QAAQ,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QAChG,KAAK,KAAK;YACR,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;YACnC,GAAG,GAAG,UAAU,CAAC;YACjB,MAAM;QACR,KAAK,OAAO;YACV,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;YACnC,GAAG,GAAG,UAAU,CAAC;YACjB,MAAM;QACR,KAAK,OAAO;YACV,YAAY,GAAG,YAAY,IAAI,GAAG,CAAC;YACnC,GAAG,GAAG,MAAM,CAAC;YACb,MAAM;IACV,CAAC;IAED,uBAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;AACxC,CAAC,CAAC;AApBW,QAAA,YAAY,gBAoBvB"}

package/lib/commands/serve.command.js

@@ -1,27 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-const common_1 = require("../common");
-const run = () => __awaiter(void 0, void 0, void 0, function* () {
-    common_1.logger.info('Starting the SPFx development server...');
-    common_1.util.isUsingGulp().then((usingGulp) => {
-        if (usingGulp) {
-            common_1.logger.info('Gulp detected. Running gulp serve...');
-        }
-        else {
-            common_1.logger.error('Gulp not detected. Please ensure you have gulp installed and configured.');
-        }
-    });
-    // Implementation of the serve command goes here
-});
-exports.run = run;
-//# sourceMappingURL=serve.command.js.map

package/lib/commands/serve.command.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serve.command.js","sourceRoot":"","sources":["../../src/commands/serve.command.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sCAAyC;AAElC,MAAM,GAAG,GAAG,GAAwB,EAAE;IAC3C,eAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IACvD,aAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QACpC,IAAI,SAAS,EAAE,CAAC;YACd,eAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,eAAM,CAAC,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC3F,CAAC;IACH,CAAC,CAAC,CAAC;IACH,gDAAgD;AAClD,CAAC,CAAA,CAAC;AAVW,QAAA,GAAG,OAUd"}