piral-cli 1.5.0-beta.6684 → 1.5.0-beta.6690

package/src/apps/build-pilet.ts

@@ -27,6 +27,7 @@ import {
   validateSharedDependencies,
   defaultSchemaVersion,
   flattenExternals,
+  triggerBuildPilet,
 } from '../common';
 
 interface PiletData {
@@ -217,66 +218,23 @@ export async function buildPilet(baseDir = process.cwd(), options: BuildPiletOpt
   }
 
   const pilets = await concurrentWorkers(allEntries, concurrency, async (entryModule) => {
-    const targetDir = dirname(entryModule);
-    const { peerDependencies, peerModules, root, apps, piletPackage, ignored, importmap, schema } =
-      await retrievePiletData(targetDir, app);
-    const schemaVersion = originalSchemaVersion || schema || config.schemaVersion || defaultSchemaVersion;
-    const piralInstances = apps.map((m) => m.appPackage.name);
-    const externals = combinePiletExternals(piralInstances, peerDependencies, peerModules, importmap);
-    const dest = resolve(root, target);
-    const outDir = dirname(dest);
-    const outFile = basename(dest);
-
-    validateSharedDependencies(importmap);
-
-    if (fresh) {
-      progress('Removing output directory ...');
-      await removeDirectory(outDir);
-    }
-
-    logInfo('Bundle pilet ...');
-
-    await hooks.beforeBuild?.({ root, outDir, importmap, entryModule, schemaVersion, piletPackage });
-
-    await callPiletBuild(
-      {
-        root,
-        piralInstances,
-        optimizeModules,
-        sourceMaps,
-        watch,
-        contentHash,
-        minify,
-        externals,
-        targetDir,
-        importmap,
-        outFile,
-        outDir,
-        entryModule: `./${relative(root, entryModule)}`,
-        logLevel,
-        version: schemaVersion,
-        ignored,
-        _,
-      },
+    const { piletPackage, root, outDir, apps, outFile, dest } = await triggerBuildPilet({
+      _,
+      app,
       bundlerName,
-    );
-
-    await hooks.afterBuild?.({ root, outDir, importmap, entryModule, schemaVersion, piletPackage });
-
-    if (declaration) {
-      await hooks.beforeDeclaration?.({ root, outDir, entryModule, piletPackage });
-      await createPiletDeclaration(
-        piletPackage.name,
-        piralInstances,
-        root,
-        entryModule,
-        externals,
-        outDir,
-        ForceOverwrite.yes,
-        logLevel,
-      );
-      await hooks.afterDeclaration?.({ root, outDir, entryModule, piletPackage });
-    }
+      contentHash,
+      entryModule,
+      fresh,
+      logLevel,
+      minify,
+      optimizeModules,
+      originalSchemaVersion,
+      sourceMaps,
+      target,
+      watch,
+      hooks,
+      declaration,
+    });
 
     logDone(`Pilet "${piletPackage.name}" built successfully!`);
 

package/src/apps/build-piral.ts

@@ -1,34 +1,26 @@
 import { join, resolve } from 'path';
-import { callPiralBuild } from '../bundler';
 import { LogLevels, PiralBuildType } from '../types';
 import {
   retrievePiletsInfo,
   retrievePiralRoot,
   removeDirectory,
-  logDone,
   checkCliCompatibility,
   progress,
   setLogLevel,
   logReset,
-  createEmulatorSources,
-  log,
-  logInfo,
-  runScript,
-  packageEmulator,
   normalizePublicUrl,
   getDestination,
   validateSharedDependencies,
-  flattenExternals,
-  createEmulatorWebsite,
+  allName,
+  emulatorPackageName,
+  emulatorName,
+  emulatorWebsiteName,
+  emulatorSourcesName,
+  releaseName,
+  triggerBuildEmulator,
+  triggerBuildShell,
 } from '../common';
 
-const allName = 'all';
-const releaseName = 'release';
-const emulatorName = 'emulator';
-const emulatorPackageName = 'package';
-const emulatorSourcesName = 'sources';
-const emulatorWebsiteName = 'website';
-
 export interface BuildPiralOptions {
   /**
    * The location of the piral
@@ -130,18 +122,6 @@ export const buildPiralDefaults: BuildPiralOptions = {
   optimizeModules: false,
 };
 
-async function runLifecycle(root: string, scripts: Record<string, string>, type: string) {
-  const script = scripts?.[type];
-
-  if (script) {
-    log('generalDebug_0003', `Running "${type}" ("${script}") ...`);
-    await runScript(script, root);
-    log('generalDebug_0003', `Finished running "${type}".`);
-  } else {
-    log('generalDebug_0003', `No script for "${type}" found ...`);
-  }
-}
-
 export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOptions = {}) {
   const {
     entry = buildPiralDefaults.entry,
@@ -193,139 +173,56 @@ export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOpt
 
   // only applies to an explicit emulator target (e.g., "emulator-website") or to "all" / "emulator" with the setting from the piral.json
   if ([emulatorSourcesName, emulatorPackageName, emulatorWebsiteName].includes(emulatorType)) {
-    const emulatorPublicUrl = '/';
     const targetDir = useSubdir ? join(dest.outDir, emulatorName) : dest.outDir;
-    const appDir = emulatorType !== emulatorWebsiteName ? join(targetDir, 'app') : targetDir;
-    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,
-      hash,
-    } = await callPiralBuild(
-      {
-        root,
-        piralInstances,
-        emulator: true,
-        standalone: false,
-        optimizeModules,
-        sourceMaps,
-        watch,
-        contentHash,
-        minify: false,
-        externals: flattenExternals(externals),
-        publicUrl: emulatorPublicUrl,
-        entryFiles,
-        logLevel,
-        ignored,
-        outDir: appDir,
-        outFile: dest.outFile,
-        _,
-      },
-      bundlerName,
-    );
-
-    await hooks.afterBuild?.({
+    await triggerBuildEmulator({
       root,
-      publicUrl: emulatorPublicUrl,
+      logLevel,
+      bundlerName,
+      emulatorType,
+      hooks,
+      targetDir,
+      ignored,
       externals,
       entryFiles,
-      targetDir,
       piralInstances,
-      hash,
-      outDir,
-      outFile,
+      optimizeModules,
+      sourceMaps,
+      watch,
+      scripts,
+      contentHash,
+      outFile: dest.outFile,
+      _,
     });
 
-    await runLifecycle(root, scripts, 'piral:postbuild');
-    await runLifecycle(root, scripts, `piral:postbuild-${emulatorName}`);
-
-    await hooks.beforeEmulator?.({ root, externals, targetDir, outDir });
-
-    let rootDir = root;
-
-    switch (emulatorType) {
-      case emulatorPackageName:
-        rootDir = await createEmulatorSources(root, externals, outDir, outFile, logLevel);
-        await hooks.beforePackage?.({ root, externals, targetDir, outDir, rootDir });
-        await packageEmulator(rootDir);
-        await hooks.afterPackage?.({ root, externals, targetDir, outDir, rootDir });
-        break;
-      case emulatorSourcesName:
-        rootDir = await createEmulatorSources(root, externals, outDir, outFile, logLevel);
-        logDone(`Emulator package sources available in "${rootDir}".`);
-        break;
-      case emulatorWebsiteName:
-        rootDir = await createEmulatorWebsite(root, externals, outDir, outFile, logLevel);
-        logDone(`Emulator website available in "${rootDir}".`);
-        break;
-    }
-
-    await hooks.afterEmulator?.({ root, externals, targetDir, outDir, rootDir });
     logReset();
   }
 
   // either 'release' or 'all'
   if (type === releaseName || type === allName) {
     const targetDir = useSubdir ? join(dest.outDir, releaseName) : dest.outDir;
-    progress('Starting release build ...');
-
-    // since we create this anyway let's just pretend we want to have it clean!
-    await removeDirectory(targetDir);
-
-    logInfo(`Bundle ${releaseName} ...`);
 
-    await hooks.beforeBuild?.({ root, publicUrl, externals, entryFiles, targetDir, piralInstances });
-
-    const {
-      dir: outDir,
-      name: outFile,
-      hash,
-    } = await callPiralBuild(
-      {
-        root,
-        piralInstances,
-        emulator: false,
-        standalone: false,
-        optimizeModules,
-        sourceMaps,
-        watch,
-        contentHash,
-        minify,
-        externals: flattenExternals(externals),
-        publicUrl,
-        outFile: dest.outFile,
-        outDir: targetDir,
-        entryFiles,
-        logLevel,
-        ignored,
-        _,
-      },
+    await triggerBuildShell({
+      targetDir,
+      logLevel,
       bundlerName,
-    );
-
-    await hooks.afterBuild?.({
-      root,
-      publicUrl,
+      contentHash,
       externals,
+      ignored,
+      minify,
+      optimizeModules,
+      publicUrl,
+      outFile: dest.outFile,
+      root,
+      sourceMaps,
+      watch,
+      hooks,
       entryFiles,
-      targetDir,
       piralInstances,
-      outDir,
-      outFile,
-      hash,
+      scripts,
+      _,
     });
 
-    await runLifecycle(root, scripts, 'piral:postbuild');
-    await runLifecycle(root, scripts, `piral:postbuild-${releaseName}`);
-
-    logDone(`Files for publication available in "${outDir}".`);
     logReset();
   }
 

package/src/apps/debug-pilet.ts

@@ -275,9 +275,6 @@ export async function debugPilet(baseDir = process.cwd(), options: DebugPiletOpt
 
       await hooks.beforeBuild?.({ root, publicUrl, importmap, entryModule, schemaVersion });
 
-      watcherContext.watch(join(root, packageJson));
-      watcherContext.watch(join(root, piletJson));
-
       const bundler = await callPiletDebug(
         {
           root,
@@ -298,6 +295,10 @@ export async function debugPilet(baseDir = process.cwd(), options: DebugPiletOpt
         bundlerName,
       );
 
+      watcherContext.watch(join(root, packageJson));
+      watcherContext.watch(join(root, piletJson));
+      watcherContext.onClean(() => bundler.stop());
+
       bundler.on((args) => {
         hooks.afterBuild?.({
           ...args,
@@ -342,7 +343,7 @@ export async function debugPilet(baseDir = process.cwd(), options: DebugPiletOpt
     await Promise.all(
       appInstances.sort(byPort).map(async ([appDir, appPort], i) => {
         const platform = configurePlatform();
-        
+
         if (networks.length === i) {
           networks.push({
             port: appPort || originalPort + i,

package/src/apps/publish-pilet.ts

@@ -1,6 +1,5 @@
-import { relative, dirname, basename, resolve, isAbsolute } from 'path';
-import { callPiletBuild } from '../bundler';
-import { LogLevels, PiletSchemaVersion, PiletPublishSource, PiletPublishScheme } from '../types';
+import { relative, dirname, basename, resolve } from 'path';
+import { LogLevels, PiletSchemaVersion, PiletPublishSource, PublishScheme } from '../types';
 import {
   postFile,
   readBinary,
@@ -16,11 +15,7 @@ import {
   findNpmTarball,
   downloadFile,
   matchAnyPilet,
-  retrievePiletData,
-  removeDirectory,
-  logInfo,
-  combinePiletExternals,
-  defaultSchemaVersion,
+  triggerBuildPilet,
 } from '../common';
 
 export interface PublishPiletOptions {
@@ -92,12 +87,22 @@ export interface PublishPiletOptions {
   /**
    * Sets the authorization scheme to use.
    */
-  mode?: PiletPublishScheme;
+  mode?: PublishScheme;
 
   /**
    * Additional arguments for a specific bundler.
    */
   _?: Record<string, any>;
+
+  /**
+   * Hooks to be triggered at various stages.
+   */
+  hooks?: {
+    beforeBuild?(e: any): Promise<void>;
+    afterBuild?(e: any): Promise<void>;
+    beforeDeclaration?(e: any): Promise<void>;
+    afterDeclaration?(e: any): Promise<void>;
+  };
 }
 
 export const publishPiletDefaults: PublishPiletOptions = {
@@ -114,11 +119,6 @@ export const publishPiletDefaults: PublishPiletOptions = {
   interactive: false,
 };
 
-function isSubDir(parent: string, dir: string) {
-  const rel = relative(parent, dir);
-  return rel && !rel.startsWith('..') && !isAbsolute(rel);
-}
-
 async function getFiles(
   baseDir: string,
   sources: Array<string>,
@@ -129,6 +129,7 @@ async function getFiles(
   bundlerName: string,
   _?: Record<string, any>,
   ca?: Buffer,
+  hooks?: PublishPiletOptions['hooks'],
 ): Promise<Array<string>> {
   if (fresh) {
     log('generalDebug_0003', 'Detected "--fresh". Trying to resolve the package.json.');
@@ -140,54 +141,25 @@ async function getFiles(
 
     return await Promise.all(
       allEntries.map(async (entryModule) => {
-        const targetDir = dirname(entryModule);
-
         progress('Triggering pilet build ...');
-        const { root, piletPackage, importmap, peerDependencies, peerModules, apps, schema } = await retrievePiletData(
-          targetDir,
-        );
-        const schemaVersion = originalSchemaVersion || schema || config.schemaVersion || defaultSchemaVersion;
-        const piralInstances = apps.map((m) => m.appPackage.name);
-        const defaultOutput = 'dist/index.js';
-        const { main = defaultOutput, name = 'pilet' } = piletPackage;
-        const propDest = resolve(root, main);
-        const propDestDir = dirname(propDest);
-        log('generalDebug_0003', `Pilet "${name}" is supposed to generate artifact in "${propDest}".`);
-        const usePropDest = propDestDir !== root && propDestDir !== targetDir && isSubDir(root, propDest);
-        const dest = usePropDest ? propDest : resolve(root, defaultOutput);
-        log('generalDebug_0003', `Pilet "${name}" is generating artifact in "${dest}".`);
-        const outDir = dirname(dest);
-        const outFile = basename(dest);
-        const externals = combinePiletExternals(piralInstances, peerDependencies, peerModules, importmap);
-        log('generalDebug_0003', `Pilet "${name}" uses externals: ${externals.join(', ')}.`);
-
-        progress('Removing output directory ...');
-        await removeDirectory(outDir);
-
-        logInfo('Bundle pilet ...');
-        await callPiletBuild(
-          {
-            root,
-            piralInstances,
-            optimizeModules: false,
-            sourceMaps: true,
-            watch: false,
-            contentHash: true,
-            minify: true,
-            externals,
-            targetDir,
-            importmap,
-            outFile,
-            outDir,
-            entryModule: `./${relative(root, entryModule)}`,
-            logLevel,
-            version: schemaVersion,
-            ignored: [],
-            _,
-          },
-          bundlerName,
-        );
 
+        const { root, piletPackage } = await triggerBuildPilet({
+          _,
+          bundlerName,
+          entryModule,
+          fresh,
+          logLevel,
+          originalSchemaVersion,
+          watch: false,
+          optimizeModules: false,
+          sourceMaps: true,
+          declaration: true,
+          contentHash: true,
+          minify: true,
+          hooks,
+        });
+
+        const name = piletPackage.name;
         log('generalDebug_0003', `Pilet "${name}" built successfully!`);
         progress('Triggering pilet pack ...');
 
@@ -237,6 +209,7 @@ export async function publishPilet(baseDir = process.cwd(), options: PublishPile
     mode = publishPiletDefaults.mode,
     interactive = publishPiletDefaults.interactive,
     _ = {},
+    hooks = {},
     bundlerName,
   } = options;
   const fullBase = resolve(process.cwd(), baseDir);
@@ -259,7 +232,7 @@ export async function publishPilet(baseDir = process.cwd(), options: PublishPile
 
   log('generalDebug_0003', 'Getting the tgz files ...');
   const sources = Array.isArray(source) ? source : [source];
-  const files = await getFiles(fullBase, sources, from, fresh, schemaVersion, logLevel, bundlerName, _, ca);
+  const files = await getFiles(fullBase, sources, from, fresh, schemaVersion, logLevel, bundlerName, _, ca, hooks);
   const successfulUploads: Array<string> = [];
   log('generalDebug_0003', 'Received available tgz files.');
 
@@ -275,7 +248,7 @@ export async function publishPilet(baseDir = process.cwd(), options: PublishPile
     const content = await readBinary(fullBase, fileName);
 
     if (content) {
-      progress(`Publishing "%s" ...`, file, url);
+      progress(`Publishing "%s" to "%s" ...`, file, url);
       const result = await postFile(url, mode, apiKey, content, fields, headers, ca, interactive);
 
       if (result.success) {