piral-cli 1.0.0-pre.2217 → 1.0.0

package/src/apps/build-piral.ts

@@ -1,4 +1,4 @@
-import { dirname, basename, extname, join, resolve } from 'path';
+import { join, resolve } from 'path';
 import { callPiralBuild } from '../bundler';
 import { LogLevels, PiralBuildType } from '../types';
 import {
@@ -15,33 +15,15 @@ import {
   logInfo,
   runScript,
   packageEmulator,
+  normalizePublicUrl,
+  getDestination,
+  validateSharedDependencies,
 } from '../common';
 
 const releaseName = 'release';
 const emulatorName = 'emulator';
 const emulatorSourcesName = 'emulator-sources';
 
-interface Destination {
-  outDir: string;
-  outFile: string;
-}
-
-function getDestination(entryFiles: string, target: string): Destination {
-  const isdir = extname(target) !== '.html';
-
-  if (isdir) {
-    return {
-      outDir: target,
-      outFile: basename(entryFiles),
-    };
-  } else {
-    return {
-      outDir: dirname(target),
-      outFile: basename(target),
-    };
-  }
-}
-
 export interface BuildPiralOptions {
   /**
    * The location of the piral
@@ -54,7 +36,7 @@ export interface BuildPiralOptions {
   target?: string;
 
   /**
-   * Sets the public URL (path) of the bundle.
+   * Sets the public URL (path) of the bundle. Only for release output.
    */
   publicUrl?: string;
 
@@ -88,6 +70,11 @@ export interface BuildPiralOptions {
    */
   sourceMaps?: boolean;
 
+  /**
+   * States if the build should run continuously and re-build when files change.
+   */
+  watch?: boolean;
+
   /**
    * Sets the bundler to use for building, if any specific.
    */
@@ -107,6 +94,20 @@ export interface BuildPiralOptions {
    * Additional arguments for a specific bundler.
    */
   _?: Record<string, any>;
+
+  /**
+   * Hooks to be triggered at various stages.
+   */
+  hooks?: {
+    onBegin?(e: any): Promise<void>;
+    beforeBuild?(e: any): Promise<void>;
+    afterBuild?(e: any): Promise<void>;
+    beforeEmulator?(e: any): Promise<void>;
+    afterEmulator?(e: any): Promise<void>;
+    beforePackage?(e: any): Promise<void>;
+    afterPackage?(e: any): Promise<void>;
+    onEnd?(e: any): Promise<void>;
+  };
 }
 
 export const buildPiralDefaults: BuildPiralOptions = {
@@ -119,6 +120,7 @@ export const buildPiralDefaults: BuildPiralOptions = {
   type: 'all',
   subdir: true,
   sourceMaps: true,
+  watch: false,
   contentHash: true,
   optimizeModules: false,
 };
@@ -139,27 +141,36 @@ export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOpt
   const {
     entry = buildPiralDefaults.entry,
     target = buildPiralDefaults.target,
-    publicUrl = buildPiralDefaults.publicUrl,
+    publicUrl: originalPublicUrl = buildPiralDefaults.publicUrl,
     logLevel = buildPiralDefaults.logLevel,
     minify = buildPiralDefaults.minify,
     sourceMaps = buildPiralDefaults.sourceMaps,
+    watch = buildPiralDefaults.watch,
     contentHash = buildPiralDefaults.contentHash,
     subdir = buildPiralDefaults.subdir,
     fresh = buildPiralDefaults.fresh,
     type = buildPiralDefaults.type,
     optimizeModules = buildPiralDefaults.optimizeModules,
     _ = {},
+    hooks = {},
     bundlerName,
   } = options;
+  const publicUrl = normalizePublicUrl(originalPublicUrl);
+  const fullBase = resolve(process.cwd(), baseDir);
+  const useSubdir = type === 'all' || subdir;
   setLogLevel(logLevel);
+
+  await hooks.onBegin?.({ options, fullBase });
   progress('Reading configuration ...');
-  const useSubdir = type === 'all' || subdir;
-  const entryFiles = await retrievePiralRoot(baseDir, entry);
+  const entryFiles = await retrievePiralRoot(fullBase, entry);
   const { name, root, ignored, externals, scripts } = await retrievePiletsInfo(entryFiles);
-  const dest = getDestination(entryFiles, resolve(baseDir, target));
+  const piralInstances = [name];
+  const dest = getDestination(entryFiles, resolve(fullBase, target));
 
   await checkCliCompatibility(root);
 
+  validateSharedDependencies(externals);
+
   if (fresh) {
     progress('Removing output directory ...');
     await removeDirectory(dest.outDir);
@@ -167,44 +178,71 @@ export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOpt
 
   // everything except release -> build emulator
   if (type !== releaseName) {
+    const emulatorPublicUrl = '/';
     const targetDir = useSubdir ? join(dest.outDir, emulatorName) : dest.outDir;
     progress('Starting emulator build ...');
 
     // since we create this anyway let's just pretend we want to have it clean!
     await removeDirectory(targetDir);
 
+    await hooks.beforeBuild?.({ root, publicUrl: emulatorPublicUrl, externals, entryFiles, targetDir, piralInstances });
+
     logInfo(`Bundle ${emulatorName} ...`);
-    const { dir: outDir, name: outFile } = await callPiralBuild(
+    const {
+      dir: outDir,
+      name: outFile,
+      hash,
+    } = await callPiralBuild(
       {
         root,
-        piral: name,
+        piralInstances,
         emulator: true,
+        standalone: false,
         optimizeModules,
         sourceMaps,
+        watch,
         contentHash,
         minify: false,
-        externals,
-        publicUrl,
-        outFile: dest.outFile,
-        outDir: join(targetDir, 'app'),
+        externals: externals.map(m => m.name),
+        publicUrl: emulatorPublicUrl,
         entryFiles,
         logLevel,
         ignored,
+        outDir: join(targetDir, 'app'),
+        outFile: dest.outFile,
         _,
       },
       bundlerName,
     );
 
+    await hooks.afterBuild?.({
+      root,
+      publicUrl: emulatorPublicUrl,
+      externals,
+      entryFiles,
+      targetDir,
+      piralInstances,
+      hash,
+      outDir,
+      outFile,
+    });
+
     await runLifecycle(root, scripts, 'piral:postbuild');
     await runLifecycle(root, scripts, `piral:postbuild-${emulatorName}`);
 
-    const rootDir = await createEmulatorSources(root, outDir, outFile, logLevel);
+    await hooks.beforeEmulator?.({ root, externals, targetDir, outDir });
+
+    const rootDir = await createEmulatorSources(root, externals, outDir, outFile, logLevel);
+
+    await hooks.afterEmulator?.({ root, externals, targetDir, outDir, rootDir });
 
     if (type !== emulatorSourcesName) {
+      await hooks.beforePackage?.({ root, externals, targetDir, outDir, rootDir });
       await packageEmulator(rootDir);
-      logDone(`Emulator sources available in "${rootDir}".`);
-    } else {
+      await hooks.afterPackage?.({ root, externals, targetDir, outDir, rootDir });
       logDone(`Emulator package available in "${rootDir}".`);
+    } else {
+      logDone(`Emulator sources available in "${rootDir}".`);
     }
 
     logReset();
@@ -219,16 +257,25 @@ export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOpt
     await removeDirectory(targetDir);
 
     logInfo(`Bundle ${releaseName} ...`);
-    const { dir: outDir } = await callPiralBuild(
+
+    await hooks.beforeBuild?.({ root, publicUrl, externals, entryFiles, targetDir, piralInstances });
+
+    const {
+      dir: outDir,
+      name: outFile,
+      hash,
+    } = await callPiralBuild(
       {
         root,
-        piral: name,
+        piralInstances,
         emulator: false,
+        standalone: false,
         optimizeModules,
         sourceMaps,
+        watch,
         contentHash,
         minify,
-        externals,
+        externals: externals.map(m => m.name),
         publicUrl,
         outFile: dest.outFile,
         outDir: targetDir,
@@ -240,10 +287,14 @@ export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOpt
       bundlerName,
     );
 
+    await hooks.afterBuild?.({ root, publicUrl, externals, entryFiles, targetDir, piralInstances, outDir, outFile, hash });
+
     await runLifecycle(root, scripts, 'piral:postbuild');
     await runLifecycle(root, scripts, `piral:postbuild-${releaseName}`);
 
     logDone(`Files for publication available in "${outDir}".`);
     logReset();
   }
+
+  await hooks.onEnd?.({ root });
 }