piral-cli 0.14.0-beta.3163 → 0.14.0-beta.3203

package/src/commands.ts

@@ -132,7 +132,10 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('source-maps', 'Create associated source maps for the bundles.')
         .default('source-maps', apps.buildPiralDefaults.sourceMaps)
         .boolean('subdir')
-        .describe('subdir', `Places the build's output in an appropriate subdirectory (e.g., "emulator"). Ignored for "--all".`)
+        .describe(
+          'subdir',
+          `Places the build's output in an appropriate subdirectory (e.g., "emulator"). Ignored for "--all".`,
+        )
         .default('subdir', apps.buildPiralDefaults.subdir)
         .boolean('content-hash')
         .describe('content-hash', 'Appends the hash to the side-bundle files.')
@@ -260,7 +263,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('framework', 'Sets the framework/library level to use.')
         .default('framework', apps.newPiralDefaults.framework)
         .boolean('install')
-        .describe('install', 'Already performs the installation of its NPM dependencies.')
+        .describe('install', 'Already performs the installation of its npm dependencies.')
         .default('install', apps.newPiralDefaults.install)
         .string('registry')
         .describe('registry', 'Sets the package registry to use for resolving the dependencies.')
@@ -269,7 +272,10 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('log-level', 'Sets the log level to use (1-5).')
         .default('log-level', apps.newPiralDefaults.logLevel)
         .string('tag')
-        .describe('tag', 'Sets the tag or version of the package to install. By default, this uses the version of the CLI.')
+        .describe(
+          'tag',
+          'Sets the tag or version of the package to install. By default, this uses the version of the CLI.',
+        )
         .default('tag', apps.newPiralDefaults.version)
         .choices('force-overwrite', forceOverwriteKeys)
         .describe('force-overwrite', 'Determines if files should be overwritten by the installation.')
@@ -281,7 +287,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('template', 'Sets the boilerplate template package to be used when scaffolding.')
         .default('template', apps.newPiralDefaults.template)
         .choices('npm-client', clientTypeKeys)
-        .describe('npm-client', 'Sets the NPM client to be used when scaffolding.')
+        .describe('npm-client', 'Sets the npm client to be used when scaffolding.')
         .default('npm-client', apps.newPiralDefaults.npmClient)
         .choices('bundler', bundlerKeys)
         .describe('bundler', 'Sets the default bundler to install.')
@@ -330,10 +336,10 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('log-level', 'Sets the log level to use (1-5).')
         .default('log-level', apps.upgradePiralDefaults.logLevel)
         .boolean('install')
-        .describe('install', 'Already performs the update of its NPM dependencies.')
+        .describe('install', 'Already performs the update of its npm dependencies.')
         .default('install', apps.upgradePiralDefaults.install)
         .choices('npm-client', clientTypeKeys)
-        .describe('npm-client', 'Sets the NPM client to be used when upgrading.')
+        .describe('npm-client', 'Sets the npm client to be used when upgrading.')
         .default('npm-client', apps.upgradePiralDefaults.npmClient)
         .string('base')
         .default('base', process.cwd())
@@ -606,7 +612,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('registry', 'Sets the package registry to use for resolving the specified Piral app.')
         .default('registry', apps.newPiletDefaults.registry)
         .boolean('install')
-        .describe('install', 'Already performs the installation of its NPM dependencies.')
+        .describe('install', 'Already performs the installation of its npm dependencies.')
         .default('install', apps.newPiletDefaults.install)
         .choices('force-overwrite', forceOverwriteKeys)
         .describe('force-overwrite', 'Determines if files should be overwritten by the scaffolding.')
@@ -621,7 +627,7 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('template', 'Sets the boilerplate template package to be used when scaffolding.')
         .default('template', apps.newPiletDefaults.template)
         .choices('npm-client', clientTypeKeys)
-        .describe('npm-client', 'Sets the NPM client to be used when scaffolding.')
+        .describe('npm-client', 'Sets the npm client to be used when scaffolding.')
         .default('npm-client', apps.newPiletDefaults.npmClient)
         .choices('bundler', bundlerKeys)
         .describe('bundler', 'Sets the default bundler to install.')
@@ -668,13 +674,13 @@ const allCommands: Array<ToolCommand<any>> = [
         .describe('log-level', 'Sets the log level to use (1-5).')
         .default('log-level', apps.upgradePiletDefaults.logLevel)
         .boolean('install')
-        .describe('install', 'Already performs the update of its NPM dependencies.')
+        .describe('install', 'Already performs the update of its npm dependencies.')
         .default('install', apps.upgradePiletDefaults.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))
         .choices('npm-client', clientTypeKeys)
-        .describe('npm-client', 'Sets the NPM client to be used when upgrading.')
+        .describe('npm-client', 'Sets the npm client to be used when upgrading.')
         .default('npm-client', apps.upgradePiletDefaults.npmClient)
         .string('base')
         .default('base', process.cwd())

package/src/common/clients/npm.ts

@@ -4,7 +4,7 @@ import { runCommand } from '../scripts';
 import { MemoryStream } from '../MemoryStream';
 
 function runNpmProcess(args: Array<string>, target: string, output?: NodeJS.WritableStream) {
-  log('generalDebug_0003', 'Starting the NPM process ...');
+  log('generalDebug_0003', 'Starting the npm process ...');
   const cwd = resolve(process.cwd(), target);
   return runCommand('npm', args, cwd, output);
 }
@@ -12,49 +12,49 @@ function runNpmProcess(args: Array<string>, target: string, output?: NodeJS.Writ
 export async function installDependencies(target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['install', '--legacy-peer-deps', ...flags], target, ms);
-  log('generalDebug_0003', `NPM install dependencies result: ${ms.value}`);
+  log('generalDebug_0003', `npm install dependencies result: ${ms.value}`);
   return ms.value;
 }
 
 export async function unpackPackage(packageRef: string, target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['pack', packageRef, ...flags], target, ms);
-  log('generalDebug_0003', `NPM (un)pack result: ${ms.value}`);
+  log('generalDebug_0003', `npm (un)pack result: ${ms.value}`);
   return ms.value;
 }
 
 export async function installPackage(packageRef: string, target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['install', packageRef, '--legacy-peer-deps', ...flags], target, ms);
-  log('generalDebug_0003', `NPM install package result: ${ms.value}`);
+  log('generalDebug_0003', `npm install package result: ${ms.value}`);
   return ms.value;
 }
 
 export async function createPackage(target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['pack', ...flags], target, ms);
-  log('generalDebug_0003', `NPM pack result: ${ms.value}`);
+  log('generalDebug_0003', `npm pack result: ${ms.value}`);
   return ms.value;
 }
 
 export async function publishPackage(target = '.', file = '*.tgz', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['publish', file, ...flags], target, ms);
-  log('generalDebug_0003', `NPM publish result: ${ms.value}`);
+  log('generalDebug_0003', `npm publish result: ${ms.value}`);
   return ms.value;
 }
 
 export async function findSpecificVersion(packageName: string, version: string) {
   const ms = new MemoryStream();
   await runNpmProcess(['show', packageName, 'version', '--tag', version], '.', ms);
-  log('generalDebug_0003', `NPM show result: ${ms.value}`);
+  log('generalDebug_0003', `npm show result: ${ms.value}`);
   return ms.value;
 }
 
 export async function findTarball(packageRef: string, target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['view', packageRef, 'dist.tarball', ...flags], target, ms);
-  log('generalDebug_0003', `NPM view packageRef result: ${ms.value}`);
+  log('generalDebug_0003', `npm view packageRef result: ${ms.value}`);
   return ms.value;
 }
 
@@ -64,9 +64,9 @@ export async function listPackage(packageRef: string, target = '.', ...flags: Ar
   try {
     await runNpmProcess(['ls', packageRef, '--json', '--depth', '0', ...flags], target, ms);
   } catch (e) {
-    log('generalDebug_0003', `NPM ls packageRef error: ${e}`);
+    log('generalDebug_0003', `npm ls packageRef error: ${e}`);
   }
 
-  log('generalDebug_0003', `NPM ls packageRef result: ${ms.value}`);
+  log('generalDebug_0003', `npm ls packageRef result: ${ms.value}`);
   return JSON.parse(ms.value);
 }

package/src/common/emulator.ts

@@ -119,7 +119,7 @@ export async function createEmulatorSources(
   // generate the associated index.d.ts
   await createPiralDeclaration(sourceDir, piralPkg.app ?? `./src/index.html`, targetDir, ForceOverwrite.yes, logLevel);
 
-  // since things like .gitignore are not properly treated by NPM we pack the files (for standard and once only)
+  // since things like .gitignore are not properly treated by npm we pack the files (for standard and once only)
   await Promise.all([
     createTarball(filesDir, rootDir, `${filesTar}.tar`),
     createTarball(filesOnceDir, rootDir, `${filesOnceTar}.tar`),

package/src/common/log.ts

@@ -11,10 +11,15 @@ type MessageTypes = keyof Messages;
 
 const logger = (() => {
   try {
-    return require('@parcel/logger');
-  } catch {
-    return require('../external').logger;
-  }
+    const logger = require('@parcel/logger');
+
+    // check to see if this is really right
+    if (typeof logger.verbose === 'function') {
+      return logger;
+    }
+  } catch {}
+
+  return require('../external').logger;
 })();
 
 // unfortunately, Parcel's support for verbose logging on Windows is broken

package/src/common/npm.test.ts

@@ -81,7 +81,7 @@ jest.mock('fs', () => ({
   },
 }));
 
-describe('NPM Module', () => {
+describe('npm Module', () => {
   it('dissects a fully qualified name with latest correctly', async () => {
     wrongCase = false;
     const [name, version, hadVersion, type] = await dissectPackageName(process.cwd(), 'foo@latest');
@@ -172,14 +172,14 @@ describe('NPM Module', () => {
     expect(type).toBe('registry');
   });
 
-  it('installs a package using the NPM command line tool without a target', async () => {
+  it('installs a package using the npm command line tool without a target', async () => {
     wrongCase = false;
     await installPackage('npm', 'foo', 'latest').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
     await installPackage('npm', 'foo', 'latest').then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
-  it('installs a package using the NPM command line tool without a version', async () => {
+  it('installs a package using the npm command line tool without a version', async () => {
     wrongCase = false;
     await installPackage('npm', 'foo').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
@@ -200,7 +200,7 @@ describe('NPM Module', () => {
     await installPackage('pnpm', 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
-  it('installs a package using the NPM command line tool with some flag', async () => {
+  it('installs a package using the npm command line tool with some flag', async () => {
     wrongCase = false;
     await installPackage('npm', 'foo', '1.3', '.', '--a=b').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;

package/src/common/npm.ts

@@ -69,27 +69,27 @@ export async function getLernaNpmClient(root: string): Promise<NpmClientType> {
  */
 export async function determineNpmClient(root: string, selected?: NpmClientType): Promise<NpmClientType> {
   if (!selected || !clientTypeKeys.includes(selected)) {
-    log('generalDebug_0003', 'No NPM client selected. Checking for lock files ...');
+    log('generalDebug_0003', 'No npm client selected. Checking for lock files ...');
     const [hasNpm, hasYarn, hasPnpm] = await Promise.all([detectNpm(root), detectYarn(root), detectPnpm(root)]);
     const found = +hasNpm + +hasYarn + +hasPnpm;
-    log('generalDebug_0003', `Results of the lock file check: NPM = ${hasNpm}, Yarn = ${hasYarn}, Pnpm = ${hasPnpm}`);
+    log('generalDebug_0003', `Results of the lock file check: npm = ${hasNpm}, Yarn = ${hasYarn}, Pnpm = ${hasPnpm}`);
     const defaultClient = config.npmClient;
 
     if (found !== 1) {
       const lernaClient = await getLernaNpmClient(root);
 
       if (clientTypeKeys.includes(lernaClient)) {
-        log('generalDebug_0003', `Found valid NPM client via Lerna: ${lernaClient}.`);
+        log('generalDebug_0003', `Found valid npm client via Lerna: ${lernaClient}.`);
         return lernaClient;
       }
     } else if (hasNpm) {
-      log('generalDebug_0003', `Found valid NPM client via lockfile.`);
+      log('generalDebug_0003', `Found valid npm client via lockfile.`);
       return 'npm';
     } else if (hasYarn) {
       log('generalDebug_0003', `Found valid Yarn client via lockfile.`);
       return 'yarn';
     } else if (hasPnpm) {
-      log('generalDebug_0003', `Found valid Pnpm client via lockfile.`);
+      log('generalDebug_0003', `Found valid pnpm client via lockfile.`);
       return 'pnpm';
     }
 
@@ -98,7 +98,7 @@ export async function determineNpmClient(root: string, selected?: NpmClientType)
       return defaultClient;
     }
 
-    log('generalDebug_0003', 'Using the default NPM client.');
+    log('generalDebug_0003', 'Using the default npm client.');
     return 'npm';
   }
 

package/src/common/package.ts

@@ -7,7 +7,7 @@ import { SourceLanguage, ForceOverwrite } from './enums';
 import { checkAppShellCompatibility } from './compatibility';
 import { deepMerge } from './merge';
 import { getHashFromUrl } from './http';
-import { isGitPackage, isLocalPackage, makeGitUrl, makeFilePath, makePiletExternals } from './npm';
+import { isGitPackage, isLocalPackage, makeGitUrl, makeFilePath, makePiletExternals, makeExternals } from './npm';
 import { filesTar, filesOnceTar, declarationEntryExtensions } from './constants';
 import { getHash, checkIsDirectory, matchFiles } from './io';
 import { readJson, copy, updateExistingJson, findFile, checkExists } from './io';
@@ -410,9 +410,12 @@ export async function retrievePiletsInfo(entryFile: string) {
   }
 
   const packageInfo = require(packageJson);
+  const info = getPiletsInfo(packageInfo);
+  const externals = makeExternals(info.externals);
 
   return {
-    ...getPiletsInfo(packageInfo),
+    ...info,
+    externals,
     name: packageInfo.name,
     version: packageInfo.version,
     dependencies: {

package/src/messages.ts

@@ -198,7 +198,7 @@ export function appInstanceInvalid_0011(): QuickMessage {
  * project folder has a package.json in its root.
  *
  * @see
- * - [NPM Package Specification](https://docs.npmjs.com/files/package.json)
+ * - [npm Package Specification](https://docs.npmjs.com/files/package.json)
  *
  * @example
  * You can see if you are currently in a correct folder.
@@ -235,7 +235,7 @@ export function packageJsonNotFound_0020(): QuickMessage {
  * The name of the pilet is provided by the name field specified in its package.json.
  *
  * A valid package.json file requires a valid name. The name has to follow standard naming
- * conventions of the NPM system.
+ * conventions of the npm system.
  *
  * @see
  * - [Package Naming Guidelines](https://docs.npmjs.com/package-name-guidelines)
@@ -285,7 +285,7 @@ export function packageJsonMissingName_0021(): QuickMessage {
  * specification.
  *
  * @see
- * - [NPM on Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
+ * - [npm on Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
  *
  * @example
  * Check the contents of the available package.json:
@@ -330,7 +330,7 @@ export function packageJsonMissingVersion_0022(): QuickMessage {
  * and which ones can remain at their current version.
  *
  * @see
- * - [NPM Install](https://docs.npmjs.com/cli/install)
+ * - [npm Install](https://docs.npmjs.com/cli/install)
  *
  * @example
  * Check that the package is indeed installed:
@@ -370,7 +370,7 @@ export function packageNotInstalled_0023(name: string): QuickMessage {
  * versions. If no release for the given version was found then an error is emitted.
  *
  * @see
- * - [StackOverflow Listing NPM Versions](https://stackoverflow.com/questions/41415945/how-to-list-all-versions-of-an-npm-module)
+ * - [StackOverflow Listing npm Versions](https://stackoverflow.com/questions/41415945/how-to-list-all-versions-of-an-npm-module)
  *
  * @example
  * Check that the version is valid:
@@ -481,7 +481,7 @@ export function projectReferenceNotSupported_0032(fullPath: string): QuickMessag
  * CLI via command line parameters.
  *
  * @see
- * - [NPM Package Specification](https://docs.npmjs.com/files/package.json)
+ * - [npm Package Specification](https://docs.npmjs.com/files/package.json)
  *
  * @example
  * Make sure you are in the right directory by calling commands such as
@@ -611,7 +611,7 @@ export function invalidPiletPackage_0042(): QuickMessage {
  * Even though everything seems to be correct on the first glance it may be that the
  * actual reference is broken. This could be due to various reasons.
  *
- * - NPM linking is broken
+ * - npm linking is broken
  * - The dependencies have not been installed yet (run `npm i`)
  * - The Piral instance's name is invalid (e.g., due to a typo)
  *
@@ -762,8 +762,8 @@ export function cannotFindFile_0046(file: string): QuickMessage {
  * Since the local resolution only works against a filename the update process has also to be triggered with
  * a file location. Otherwise, there is no chance to know a different file location.
  *
- * Potentially, you wanted to switch / resolve the module from NPM instead. Therefore, we are then trying to
- * obtain the Piral instance from NPM instead using the known name.
+ * Potentially, you wanted to switch / resolve the module from npm instead. Therefore, we are then trying to
+ * obtain the Piral instance from npm instead using the known name.
  *
  * @see
  * - [Local File Dependencies](https://stackoverflow.com/questions/14381898/local-dependency-in-package-json)
@@ -800,11 +800,11 @@ export function localeFileForUpgradeMissing_0050(): QuickMessage {
  * Right now we only support "latest" for Git resolved Piral instances. In this scenario we obtain the
  * current head from the repository's default branch and update accordingly.
  *
- * Potentially, you wanted to switch / resolve the module from NPM instead. Therefore, we are then trying to
- * obtain the Piral instance from NPM instead using the known name.
+ * Potentially, you wanted to switch / resolve the module from npm instead. Therefore, we are then trying to
+ * obtain the Piral instance from npm instead using the known name.
  *
  * @see
- * - [Git Dependencies in NPM](https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a)
+ * - [Git Dependencies in npm](https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a)
  *
  * @example
  * You may have set up the pilet using a locally available tgz file. In this case your original command may
@@ -995,7 +995,7 @@ export function missingPiletFeedUrl_0060(): QuickMessage {
  * directly.
  *
  * @see
- * - [NPM Pack](https://docs.npmjs.com/cli-commands/pack.html)
+ * - [npm Pack](https://docs.npmjs.com/cli-commands/pack.html)
  *
  * @example
  * Make sure to have build a pilet beforehand:
@@ -1541,10 +1541,10 @@ export function entryPointDoesNotExist_0073(app: string): QuickMessage {
  * point for the bundler.
  *
  * @see
- * - [NPM Init](https://docs.npmjs.com/cli/init)
+ * - [npm Init](https://docs.npmjs.com/cli/init)
  *
  * @example
- * You can create a new NPM project using the `npm init` command. This will essentially guide
+ * You can create a new npm project using the `npm init` command. This will essentially guide
  * you through a number of decisions for creating a proper package.json.
  *
  * Even better you could start a new Piral instance using the following command:
@@ -1577,10 +1577,10 @@ export function packageJsonMissing_0074(): QuickMessage {
  * point for the bundler.
  *
  * @see
- * - [NPM Init](https://docs.npmjs.com/cli/init)
+ * - [npm Init](https://docs.npmjs.com/cli/init)
  *
  * @example
- * You can create a new NPM project using the `npm init` command. This will essentially guide
+ * You can create a new npm project using the `npm init` command. This will essentially guide
  * you through a number of decisions for creating a proper package.json.
  *
  * Even better you could start a new pilet using the following command:
@@ -1855,7 +1855,7 @@ export function toolingIncompatible_0101(piralVersion: string, cliVersion: strin
  *
  * @example
  * The following command first removes the output directory, then starts the build,
- * and finally publishes the emulator to NPM.
+ * and finally publishes the emulator to npm.
  *
  * ```sh
  * rm -rf dist
@@ -1881,7 +1881,7 @@ export function publishDirectoryMissing_0110(directory: string): QuickMessage {
  *
  * @example
  * The following command first removes the output directory, then starts the build,
- * and finally publishes the emulator to NPM.
+ * and finally publishes the emulator to npm.
  *
  * ```sh
  * rm -rf dist
@@ -1964,7 +1964,11 @@ export function publishProviderMissing_0113(providerName: string, availableProvi
  * The type is "release".
  */
 export function publishEmulatorSourcesInvalid_0114(): QuickMessage {
-  return [LogLevels.error, '0114', `The command "publish" cannot be done with "--type emulator-sources". Use another type instead.`];
+  return [
+    LogLevels.error,
+    '0114',
+    `The command "publish" cannot be done with "--type emulator-sources". Use another type instead.`,
+  ];
 }
 
 /**
@@ -1986,7 +1990,7 @@ export function publishEmulatorSourcesInvalid_0114(): QuickMessage {
  * - The API for opening the default browser is invalid
  *
  * @see
- * - [NPM Open Package](https://www.npmjs.com/package/open)
+ * - [npm Open Package](https://www.npmjs.com/package/open)
  *
  * @example
  * The browser is usually just opened via the command line: