piral-cli 0.14.0-unstable.3096 → 0.14.1-beta.3244

package/src/messages.ts

@@ -161,7 +161,7 @@ export function appInstanceNotFound_0010(name: string): QuickMessage {
  * It should be an HTML file.
  *
  * @see
- * - [Parcel HTML Asset](https://parceljs.org/html.html)
+ * - [Parcel HTML Asset](https://parceljs.org/languages/html/)
  *
  * @example
  * Make sure the package.json of the Piral instance is valid (has an "app" field).
@@ -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
@@ -944,6 +944,7 @@ export function cannotResolveVersion_0052(name: string): QuickMessage {
  *     }
  *   }
  * }
+ * ```
  */
 export function cannotResolveDependency_0053(name: string, rootDir: string): QuickMessage {
   return [LogLevels.warning, '0053', `Could not resolve "${name}" from "${rootDir}". Taking "latest" version.`];
@@ -995,7 +996,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:
@@ -1277,10 +1278,10 @@ export function failedHttpGet_0068(error: string): QuickMessage {
  *
  * @abstract
  * While submitting the HTTP get request an error was reported.
- * 
+ *
  * Potentially, the server returned some more indicative error message. In this
  * case read it carefully to know what version was already published.
- * 
+ *
  * In any case only the documentation of the corresponding feed service can be
  * conclusive how this can be resolved. Presumably, some payment of some fee
  * is necessary to publish pilets.
@@ -1299,28 +1300,28 @@ export function failedToUploadPayment_0161(response: any): QuickMessage {
  *
  * @abstract
  * While submitting the HTTP get request an error was reported.
- * 
+ *
  * Potentially, the server returned some more indicative error message. In this
  * case read it carefully to know what version was already published.
- * 
+ *
  * In any case you need to change the version to continue. You can do that by
  * editing the "version" field in the pilet's package.json or using `npm version`.
  *
  * @example
  * If you already published the pilet, e.g., via
- * 
+ *
  * ```sh
  * pilet publish --api-key ... --url ...
  * ```
- * 
+ *
  * then doing this again without any change should result in this error.
- * 
+ *
  * Now we can patch-upgrade the version of the pilet:
- * 
+ *
  * ```sh
  * npm version patch
  * ```
- * 
+ *
  * And try the `pilet publish` command again. This time it should just work.
  */
 export function failedToUploadVersion_0162(response: any): QuickMessage {
@@ -1337,10 +1338,10 @@ export function failedToUploadVersion_0162(response: any): QuickMessage {
  *
  * @abstract
  * While submitting the HTTP get request an error was reported.
- * 
+ *
  * Potentially, the server returned some more indicative error message. In this
  * case read it carefully to know how much the limit was exceeded.
- * 
+ *
  * In any case the pilet must be somehow trimmed down. Most often, the size is
  * dominantly determined by some external packages that are referened. Use a
  * page such as bundlephobia.com or some IDE tools to find out which packages
@@ -1541,10 +1542,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 +1578,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 +1856,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 +1882,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
@@ -1960,11 +1961,15 @@ export function publishProviderMissing_0113(providerName: string, availableProvi
  * ```sh
  * piral publish --type release --provider xcopy --fields.target "/temp/dest"
  * ```
- * 
+ *
  * 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 +1991,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:
@@ -2018,7 +2023,7 @@ export function failedToOpenBrowser_0170(error: string): QuickMessage {
  *
  * The v1 version has better support for older browsers, but requires a polyfill to work
  * correctly. This polyfill is part of the standard Piral polyfills.
- * 
+ *
  * The v2 version uses a SystemJS format for the pilet. It has the broadest browser support
  * but requires the custom format as output. Most bundlers support SystemJS directly or
  * indirectly, making it a quite broad choice.
@@ -2058,6 +2063,7 @@ export function invalidSchemaVersion_0171(schemaVersion: string, schemas: Array<
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
+ * - [esbuild](https://esbuild.github.io)
  * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
  *
  * @example
@@ -2089,6 +2095,7 @@ export function bundlerMissing_0172(bundlerName: string, installed: Array<string
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
+ * - [esbuild](https://esbuild.github.io)
  * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
  *
  * @example
@@ -2120,6 +2127,7 @@ export function defaultBundlerMissing_0173(): QuickMessage {
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
+ * - [esbuild](https://esbuild.github.io)
  * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
  *
  * @example

package/src/types/common.ts

@@ -48,6 +48,7 @@ export interface ReleaseProvider {
 export interface TemplateFileLocation {
   from: string;
   to: string;
+  template?: boolean;
   deep?: boolean;
   once?: boolean;
 }

package/src/types/public.ts

@@ -1,14 +1,5 @@
 import { Argv, Arguments } from 'yargs';
-import {
-  RuleRunner,
-  PiletRuleContext,
-  PiralRuleContext,
-  Bundler,
-  BundleDetails,
-  LogLevels,
-  SharedDependency,
-  ReleaseProvider,
-} from './common';
+import { RuleRunner, PiletRuleContext, PiralRuleContext, LogLevels, SharedDependency, ReleaseProvider } from './common';
 
 export interface ToolCommandRunner<U = {}> {
   (args: Arguments<U>): void | Promise<void>;
@@ -131,28 +122,85 @@ export interface BuildPiletParameters extends BaseBundleParameters {
   version: PiletSchemaVersion;
 }
 
-export interface WatchPiralBundlerDefinition {
-  run(args: WatchPiralParameters): Promise<Bundler>;
+export interface BundlerPrepareArgs<T> {
+  (args: T): T | Promise<T>;
 }
 
-export interface DebugPiralBundlerDefinition {
+export interface BaseBundlerDefinition<T> {
+  path: string;
+  prepare?: BundlerPrepareArgs<T>;
+}
+
+export interface WatchPiralBundlerDefinition extends BaseBundlerDefinition<WatchPiralParameters> {}
+
+export interface DebugPiralBundlerDefinition extends BaseBundlerDefinition<DebugPiralParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: DebugPiralParameters): Promise<Bundler>;
 }
 
-export interface BuildPiralBundlerDefinition {
+export interface BuildPiralBundlerDefinition extends BaseBundlerDefinition<BuildPiralParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: BuildPiralParameters): Promise<BundleDetails>;
 }
 
-export interface DebugPiletBundlerDefinition {
+export interface DebugPiletBundlerDefinition extends BaseBundlerDefinition<DebugPiletParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: DebugPiletParameters): Promise<Bundler>;
 }
 
-export interface BuildPiletBundlerDefinition {
+export interface BuildPiletBundlerDefinition extends BaseBundlerDefinition<BuildPiletParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: BuildPiletParameters): Promise<BundleDetails>;
+}
+
+export interface PiralBuildHandler {
+  create(config: {
+    root: string;
+    entryFiles: string;
+    outDir: string;
+    outFile: string;
+    externals: Array<string>;
+    emulator: boolean;
+    sourceMaps: boolean;
+    contentHash: boolean;
+    minify: boolean;
+    publicUrl: string;
+    hmr: boolean;
+    logLevel: LogLevels;
+    watch: boolean;
+    args: any;
+  }): Promise<BundleHandlerResponse>;
+}
+
+export interface PiletBuildHandler {
+  create(config: {
+    root: string;
+    piral: string;
+    entryModule: string;
+    targetDir: string;
+    outDir: string;
+    outFile: string;
+    externals: Array<string>;
+    importmap: Array<SharedDependency>;
+    version: PiletSchemaVersion;
+    develop: boolean;
+    sourceMaps: boolean;
+    contentHash: boolean;
+    minify: boolean;
+    logLevel: LogLevels;
+    watch: boolean;
+    args: any;
+  }): Promise<BundleHandlerResponse>;
+}
+
+export interface BundleResult {
+  outDir: string;
+  outFile: string;
+  hash?: string;
+  name?: string;
+  requireRef?: string;
+}
+
+export interface BundleHandlerResponse {
+  onStart(cb: () => void): void;
+  onEnd(cb: (result: BundleResult) => void): void;
+  bundle(): Promise<BundleResult>;
 }
 
 export interface BundlerDefinition {