piral-cli 0.15.0-alpha.4332 → 0.15.0-alpha.4396

package/src/cli.ts

@@ -1,5 +1,6 @@
 import * as yargs from 'yargs';
 import { detailed } from 'yargs-parser';
+import { caterpillerIcon, zapIcon } from './common';
 import { runQuestionnaireFor } from './questionnaire';
 import { ToolCommand } from './types';
 
@@ -46,7 +47,7 @@ export function setupCli(commands: Array<ToolCommand<any>>) {
           () => process.exit(0),
           (err) => {
             err && !err.logged && console.error(err.message);
-            console.log('Codes Reference: https://docs.piral.io/code/search');
+            console.log(`${caterpillerIcon} Codes Reference: https://docs.piral.io/code/search`);
             process.exit(1);
           },
         );
@@ -54,5 +55,5 @@ export function setupCli(commands: Array<ToolCommand<any>>) {
     );
   }
 
-  argv.epilog('For more information, check out the documentation at https://docs.piral.io.').help().strict().argv;
+  argv.epilog(`${zapIcon} For more information, check out the documentation at https://docs.piral.io.`).help().strict().argv;
 }

package/src/commands.ts

@@ -281,9 +281,11 @@ const allCommands: Array<ToolCommand<any>> = [
         .boolean('install')
         .describe('install', 'Already performs the installation of its npm dependencies.')
         .default('install', apps.newPiralDefaults.install)
+        .alias('install', 'package-install')
         .string('registry')
         .describe('registry', 'Sets the package registry to use for resolving the dependencies.')
         .default('registry', apps.newPiralDefaults.registry)
+        .alias('registry', 'package-registry')
         .number('log-level')
         .describe('log-level', 'Sets the log level to use (1-5).')
         .default('log-level', apps.newPiralDefaults.logLevel)
@@ -293,6 +295,7 @@ const allCommands: Array<ToolCommand<any>> = [
           'Sets the tag or version of the package to install. By default, this uses the version of the CLI.',
         )
         .default('tag', apps.newPiralDefaults.version)
+        .alias('tag', 'piral-version')
         .choices('force-overwrite', forceOverwriteKeys)
         .describe('force-overwrite', 'Determines if files should be overwritten by the installation.')
         .default('force-overwrite', keyOfForceOverwrite(apps.newPiralDefaults.forceOverwrite))
@@ -354,6 +357,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .boolean('install')
         .describe('install', 'Already performs the update of its npm dependencies.')
         .default('install', apps.upgradePiralDefaults.install)
+        .alias('install', 'package-install')
         .choices('npm-client', clientTypeKeys)
         .describe('npm-client', 'Sets the npm client to be used when upgrading.')
         .default('npm-client', apps.upgradePiralDefaults.npmClient)
@@ -614,6 +618,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .choices('mode', publishModeKeys)
         .describe('mode', 'Sets the authorization mode to use.')
         .default('mode', apps.publishPiletDefaults.mode)
+        .alias('mode', 'auth-mode')
         .choices('bundler', availableBundlers)
         .describe('bundler', 'Sets the bundler to use.')
         .default('bundler', availableBundlers[0])
@@ -672,9 +677,11 @@ const allCommands: Array<ToolCommand<any>> = [
         .string('registry')
         .describe('registry', 'Sets the package registry to use for resolving the specified Piral app.')
         .default('registry', apps.newPiletDefaults.registry)
+        .alias('registry', 'package-registry')
         .boolean('install')
         .describe('install', 'Already performs the installation of its npm dependencies.')
         .default('install', apps.newPiletDefaults.install)
+        .alias('install', 'package-install')
         .choices('force-overwrite', forceOverwriteKeys)
         .describe('force-overwrite', 'Determines if files should be overwritten by the scaffolding.')
         .default('force-overwrite', keyOfForceOverwrite(apps.newPiletDefaults.forceOverwrite))
@@ -737,6 +744,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .boolean('install')
         .describe('install', 'Already performs the update of its npm dependencies.')
         .default('install', apps.upgradePiletDefaults.install)
+        .alias('install', 'package-install')
         .choices('force-overwrite', forceOverwriteKeys)
         .describe('force-overwrite', 'Determines if files should be overwritten by the upgrading process.')
         .default('force-overwrite', keyOfForceOverwrite(apps.upgradePiletDefaults.forceOverwrite))

package/src/common/emoji.ts

@@ -2,5 +2,14 @@ import { isWindows } from './info';
 
 const supportsEmoji = !isWindows || process.env.TERM === 'xterm-256color';
 
+// see https://unicode.org/emoji/charts/full-emoji-list.html
 export const liveIcon = supportsEmoji ? '🚀 ' : '>';
 export const settingsIcon = supportsEmoji ? '🔧 ' : '>';
+export const cactusIcon = supportsEmoji ? '👻' : '>';
+export const clapIcon = supportsEmoji ? '👏' : '^';
+export const sparklesIcon = supportsEmoji ? '✨' : '>';
+export const unicornIcon = supportsEmoji ? '🦄' : '>';
+export const caterpillerIcon = supportsEmoji ? '🐛' : '+';
+export const butterflyIcon = supportsEmoji ? '🦋' : '+';
+export const zapIcon = supportsEmoji ? '⚡' : '>';
+export const rainbowIcon = supportsEmoji ? '🌈' : '~';

package/src/common/npm.test.ts

@@ -66,7 +66,7 @@ jest.mock('fs', () => ({
   existsSync: (file: string) => {
     return true;
   },
-  readFile: (file: string, type: string, callback: (err: NodeJS.ErrnoException, data: string) => void) => {
+  readFile: (file: string, type: string, callback: (err: NodeJS.ErrnoException | undefined, data: string) => void) => {
     return callback(undefined, '');
   },
   realpathSync: () => ({}),
@@ -320,7 +320,7 @@ describe('npm Module', () => {
   });
 
   it('check if package from nothing is not local', () => {
-    const result = isLocalPackage('./', null);
+    const result = isLocalPackage('./', '');
     expect(result).toBeFalsy();
   });
 
@@ -364,7 +364,7 @@ describe('npm Module', () => {
     expect(result).toBeTruthy();
     result = isGitPackage('git+');
     expect(result).toBeTruthy();
-    result = isGitPackage(null);
+    result = isGitPackage('');
     expect(result).toBeFalsy();
   });
 
@@ -395,11 +395,11 @@ describe('npm Module', () => {
   it('combine package refernce', () => {
     let result = combinePackageRef('foo', '1.0.0', 'registry');
     expect(result).toBe('foo@1.0.0');
-    result = combinePackageRef('foo', null, 'registry');
+    result = combinePackageRef('foo', '', 'registry');
     expect(result).toBe('foo@latest');
-    result = combinePackageRef('foo', null, 'file');
+    result = combinePackageRef('foo', '', 'file');
     expect(result).toBe('foo');
-    result = combinePackageRef('foo', null, 'git');
+    result = combinePackageRef('foo', '', 'git');
     expect(result).toBe('foo');
   });
 
@@ -430,18 +430,18 @@ describe('npm Module', () => {
     expect(result).toEqual('1.0.0');
     result = getPackageVersion(false, 'foo', '1.0.0', 'registry', './');
     expect(result).toBeFalsy();
-    result = getPackageVersion(true, './foo.tgz', null, 'file', './');
+    result = getPackageVersion(true, './foo.tgz', '', 'file', './');
     expect(result).toEqual('file:foo.tgz');
-    result = getPackageVersion(true, 'git+https://.foo.git', null, 'git', null);
+    result = getPackageVersion(true, 'git+https://.foo.git', '', 'git', '');
     expect(result).toEqual('git+https://.foo.git');
   });
 
   it('gets path to git package', () => {
-    const result = getCurrentPackageDetails('./', './foo.tgz', null, 'file://foo.tgz', './');
+    const result = getCurrentPackageDetails('./', './foo.tgz', '', 'file://foo.tgz', './');
     result.then(([path, version]) => {
       expect(path).not.toBeUndefined();
     });
-    const result2 = getCurrentPackageDetails('./', './foo.tgz', null, 'git+https://.foo.git', './');
+    const result2 = getCurrentPackageDetails('./', './foo.tgz', '', 'git+https://.foo.git', './');
     result2.then(([path, version]) => {
       expect(path).not.toBeUndefined();
     });
@@ -454,32 +454,12 @@ describe('npm Module', () => {
 
   it('makeExternals without externals returns coreExternals', () => {
     const externals = makeExternals(process.cwd(), { piral: '*' });
-    expect(externals).toEqual([
-      'react',
-      'react-dom',
-      'react-router',
-      'react-router-dom',
-      'history',
-      'tslib',
-      'path-to-regexp',
-      '@libre/atom',
-      '@dbeining/react-atom',
-    ]);
+    expect(externals).toEqual(['react', 'react-dom', 'react-router', 'react-router-dom', 'history', 'tslib']);
   });
 
   it('makeExternals with no externals returns coreExternals', () => {
     const externals = makeExternals(process.cwd(), { piral: '*' }, []);
-    expect(externals).toEqual([
-      'react',
-      'react-dom',
-      'react-router',
-      'react-router-dom',
-      'history',
-      'tslib',
-      'path-to-regexp',
-      '@libre/atom',
-      '@dbeining/react-atom',
-    ]);
+    expect(externals).toEqual(['react', 'react-dom', 'react-router', 'react-router-dom', 'history', 'tslib']);
   });
 
   it('makeExternals with exclude coreExternals returns empty set', () => {
@@ -498,41 +478,17 @@ describe('npm Module', () => {
       'react-router-dom',
       'history',
       'tslib',
-      'path-to-regexp',
-      '@libre/atom',
-      '@dbeining/react-atom',
     ]);
   });
 
   it('makeExternals with external duplicate only reflects coreExternals', () => {
     const externals = makeExternals(process.cwd(), { piral: '*' }, ['react', 'foo']);
-    expect(externals).toEqual([
-      'react',
-      'foo',
-      'react-dom',
-      'react-router',
-      'react-router-dom',
-      'history',
-      'tslib',
-      'path-to-regexp',
-      '@libre/atom',
-      '@dbeining/react-atom',
-    ]);
+    expect(externals).toEqual(['react', 'foo', 'react-dom', 'react-router', 'react-router-dom', 'history', 'tslib']);
   });
 
   it('makeExternals with explicit include and exclude', () => {
     const externals = makeExternals(process.cwd(), { piral: '*' }, ['react', 'react-calendar', '!history']);
-    expect(externals).toEqual([
-      'react',
-      'react-calendar',
-      'react-dom',
-      'react-router',
-      'react-router-dom',
-      'tslib',
-      'path-to-regexp',
-      '@libre/atom',
-      '@dbeining/react-atom',
-    ]);
+    expect(externals).toEqual(['react', 'react-calendar', 'react-dom', 'react-router', 'react-router-dom', 'tslib']);
   });
 
   it('makeExternals with all exclude and explicit include', () => {

package/src/common/npm.ts

@@ -3,7 +3,7 @@ import { createReadStream, existsSync } from 'fs';
 import { log, fail } from './log';
 import { clients, detectClients, isWrapperClient } from './clients';
 import { config } from './config';
-import { legacyCoreExternals, frameworkLibs } from './constants';
+import { legacyCoreExternals, frameworkLibs, defaultRegistry } from './constants';
 import { inspectPackage } from './inspect';
 import { readJson, checkExists } from './io';
 import { clientTypeKeys } from '../helpers';
@@ -129,6 +129,22 @@ export function installNpmDependencies(client: NpmClientType, target = '.'): Pro
   return installDependencies(target);
 }
 
+export async function installNpmPackageFromOptionalRegistry(
+  packageRef: string,
+  target = '.',
+  registry: string,
+): Promise<void> {
+  try {
+    await installNpmPackage('npm', packageRef, target, '--registry', registry);
+  } catch (e) {
+    if (registry === defaultRegistry) {
+      throw e;
+    }
+
+    await installNpmPackage('npm', packageRef, target, '--registry', defaultRegistry);
+  }
+}
+
 export async function installNpmPackage(
   client: NpmClientType,
   packageRef: string,

package/src/common/scaffold.ts

@@ -1,5 +1,5 @@
 import { join, dirname, resolve, basename, isAbsolute } from 'path';
-import { installNpmPackage } from './npm';
+import { installNpmPackageFromOptionalRegistry } from './npm';
 import { ForceOverwrite } from './enums';
 import { createDirectory, createFileIfNotExists, updateExistingJson } from './io';
 import { cliVersion, isWindows } from './info';
@@ -41,7 +41,7 @@ async function getTemplateFiles(
       templatePackageName = `${templatePackageName}@latest`;
     }
 
-    await installNpmPackage('npm', templatePackageName, __dirname, '--registry', registry);
+    await installNpmPackageFromOptionalRegistry(templatePackageName, __dirname, registry);
   }
 
   const templateRunner = getTemplatePackage(templatePackageName);

package/src/questionnaire.ts

@@ -7,6 +7,7 @@ type FlagType = 'string' | 'number' | 'boolean' | 'object';
 interface Flag {
   name: string;
   type?: FlagType;
+  alias: Array<string>;
   values?: Array<any>;
   describe?: string;
   default?: any;
@@ -16,16 +17,23 @@ interface Flag {
 function getCommandData(retrieve: any) {
   const instructions: Array<Flag> = [];
   const fn = {
+    alias(name: string, altName: string) {
+      return this.swap(name, (flag) => ({
+        ...flag,
+        alias: [...flag.alias, altName],
+      }));
+    },
     positional(name: string, info: Flag) {
       instructions.push({
         ...info,
+        alias: [],
         name,
       });
       return this;
     },
     swap(name: string, swapper: (flag: Flag) => Flag) {
       const [flag] = instructions.filter((m) => m.name === name);
-      const newFlag = swapper(flag || { name });
+      const newFlag = swapper(flag || { name, alias: [] });
 
       if (!flag) {
         instructions.push(newFlag);
@@ -135,7 +143,7 @@ export function runQuestionnaireFor(
   const questions = instructions
     .filter((instruction) => !ignored.includes(instruction.name))
     .filter((instruction) => !acceptAll || (instruction.default === undefined && instruction.required))
-    .filter((instruction) => args[instruction.name] === undefined)
+    .filter((instruction) => [...instruction.alias, instruction.name].every((m) => args[m] === undefined))
     .filter((instruction) => instruction.type !== 'object')
     .map((instruction) => ({
       name: instruction.name,
@@ -146,12 +154,16 @@ export function runQuestionnaireFor(
       validate: instruction.type === 'number' ? (input: string) => !isNaN(+input) : () => true,
     }));
 
+
   return inquirer.prompt(questions).then((answers) => {
     const parameters: any = {};
 
     for (const instruction of instructions) {
       const name = instruction.name;
-      const value = answers[name] ?? ignoredInstructions[name] ?? args[name];
+      const value =
+        answers[name] ??
+        ignoredInstructions[name] ??
+        [...instruction.alias, instruction.name].map((m) => args[m]).find((v) => v !== undefined);
       parameters[name] = value !== undefined ? getValue(instruction.type, value as any) : instruction.default;
     }