create-unisphere-project 2.9.0 → 2.10.0

package/dist/CHANGELOG.md

@@ -1,5 +1,11 @@
 # create-unisphere-project
 
+## 2.10.0
+
+### Minor Changes
+
+- improve communication of errors
+
 ## 2.9.0
 
 ### Minor Changes

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-unisphere-project",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "private": false,
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",

package/dist/src/index.js

@@ -3,5 +3,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const create_unisphere_repo_command_1 = require("./lib/create-unisphere-repo-command");
 const commander_1 = require("commander");
-const command = (0, create_unisphere_repo_command_1.createCreateUnisphereRepoCommand)(new commander_1.Command());
-command.parse(process.argv);
+const program = new commander_1.Command();
+// Set up the main command
+program
+    .name('create-unisphere-project')
+    .description('Create a new Unisphere project from template')
+    .version(require('../package.json').version || '1.0.0');
+// Add the subcommand
+(0, create_unisphere_repo_command_1.createCreateUnisphereRepoCommand)(program);
+// Parse arguments
+program.parse(process.argv);
+// If no subcommand provided, show help
+if (program.args.length === 0 && process.argv.length <= 2) {
+    console.log('');
+    console.log('Usage: npx @unisphere/create-unisphere-project create-unisphere-repo [options]');
+    console.log('');
+    console.log('Required options:');
+    console.log('  --company-name <name>         Your company name (letters, hyphens, spaces)');
+    console.log('  --experience-name <name>      Experience name (letters, hyphens, spaces)');
+    console.log('  --is-internal-product <bool>  Is internal product (true or false)');
+    console.log('');
+    console.log('Example:');
+    console.log('  $ npx @unisphere/create-unisphere-project create-unisphere-repo \\');
+    console.log('      --company-name=acme \\');
+    console.log('      --experience-name=video \\');
+    console.log('      --is-internal-product=false');
+    console.log('');
+    console.log('For more information, run:');
+    console.log('  $ npx @unisphere/create-unisphere-project create-unisphere-repo --help');
+    console.log('');
+}

package/dist/src/lib/create-unisphere-repo-command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-unisphere-repo-command.d.ts","sourceRoot":"","sources":["../../../src/lib/create-unisphere-repo-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAU,MAAM,WAAW,CAAC;AAqC5C,eAAO,MAAM,gCAAgC,GAC3C,eAAe,OAAO,KACrB,OA+UF,CAAC"}
+{"version":3,"file":"create-unisphere-repo-command.d.ts","sourceRoot":"","sources":["../../../src/lib/create-unisphere-repo-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAU,MAAM,WAAW,CAAC;AAqC5C,eAAO,MAAM,gCAAgC,GAC3C,eAAe,OAAO,KACrB,OAkXF,CAAC"}

package/dist/src/lib/create-unisphere-repo-command.js

@@ -44,32 +44,52 @@ const createCreateUnisphereRepoCommand = (parentCommand) => {
     command
         .description('create a new unisphere repository from template')
         .option('--cwd <path>', 'The working directory', process.cwd())
-        .option('--company-name <name>', 'The company name (letters, hyphens, and spaces only)')
+        .option('--company-name <name>', '[REQUIRED] The company name (letters, hyphens, and spaces only)')
         .addOption(nxpluginPathOption)
         .addOption(clipathOption)
         .addOption(skipTypesPackagesOption)
-        .option('--experience-name <name>', 'The experience name (any format)')
-        .option('--is-internal-product <boolean>', 'Is internal product')
+        .option('--experience-name <name>', '[REQUIRED] The experience name (letters, hyphens, and spaces only)')
+        .option('--is-internal-product <boolean>', '[REQUIRED] Is internal product (true or false)')
         .option('--verbose', 'Output debug logs', false)
+        .addHelpText('after', `
+Examples:
+  $ npx @unisphere/create-unisphere-project --company-name=acme --experience-name=video --is-internal-product=false
+  $ npx @unisphere/create-unisphere-project --company-name="Acme Corp" --experience-name="Video Player" --is-internal-product=true
+
+All three options (--company-name, --experience-name, --is-internal-product) are required.
+`)
         .hook('preAction', utils_1.printVerboseHook)
         .action(async (options) => {
         const cwd = (0, path_1.resolve)(options.cwd || process.cwd());
         // Validate required options
         if (!options.companyName || !options.companyName.trim()) {
-            throw new Error('--company-name is required');
+            throw new Error(`Missing required option: --company-name\n` +
+                `  Description: Your company name (letters, hyphens, and spaces only)\n` +
+                `  Example: npx @unisphere/create-unisphere-project --company-name=acme --experience-name=video --is-internal-product=false`);
         }
         if (!options.experienceName || !options.experienceName.trim()) {
-            throw new Error('--experience-name is required');
+            throw new Error(`Missing required option: --experience-name\n` +
+                `  Description: The experience name for your project (letters, hyphens, and spaces only)\n` +
+                `  Example: npx @unisphere/create-unisphere-project --company-name=acme --experience-name=video --is-internal-product=false`);
         }
         if (typeof options.isInternalProduct === 'undefined') {
-            throw new Error('--is-internal-product is required');
+            throw new Error(`Missing required option: --is-internal-product\n` +
+                `  Description: Whether this is an internal product (true or false)\n` +
+                `  Allowed values: true, false\n` +
+                `  Example: npx @unisphere/create-unisphere-project --company-name=acme --experience-name=video --is-internal-product=false`);
         }
         // Validate input formats
         if (!validateInput(options.companyName.trim())) {
-            throw new Error('Company name can only contain letters, hyphens, and spaces');
+            throw new Error(`Invalid value for --company-name: '${options.companyName}'\n` +
+                `  Allowed format: letters, hyphens, and spaces only\n` +
+                `  Received: ${options.companyName}\n` +
+                `  Example: --company-name=acme or --company-name="Acme Corp"`);
         }
         if (!validateInput(options.experienceName.trim())) {
-            throw new Error('Experience name can only contain letters, hyphens, and spaces');
+            throw new Error(`Invalid value for --experience-name: '${options.experienceName}'\n` +
+                `  Allowed format: letters, hyphens, and spaces only\n` +
+                `  Received: ${options.experienceName}\n` +
+                `  Example: --experience-name=video or --experience-name="Video Player"`);
         }
         // Assign validated values
         const _companyName = options.companyName;
@@ -202,7 +222,7 @@ legacy-peer-deps=true`);
             },
             {
                 title: 'Create types package',
-                skip: () => options.skipPackagesCreation,
+                skip: () => !!options.skipPackagesCreation,
                 task: async (ctx, task) => {
                     const packageName = options.nxpluginPath || '@unisphere/nx';
                     const createTypesCommand = `npx nx g ${packageName}:add-package --packageName="types" --scope="${_isInternalProduct ? 'kaltura-corp' : 'unisphere'}" --no-interactive`;
@@ -232,7 +252,7 @@ legacy-peer-deps=true`);
             },
             {
                 title: 'Create documentation site',
-                skip: () => options.skipPackagesCreation,
+                skip: () => !!options.skipPackagesCreation,
                 task: async (ctx, task) => {
                     const packageName = options.nxpluginPath || '@unisphere/nx';
                     const createDocumentationCommand = `npx nx g ${packageName}:add-documentation --isExperienceLevel --skipInstall --no-interactive`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-unisphere-project",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "private": false,
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",