piral-cli 0.15.0-alpha.3640 → 0.15.0-alpha.3719

package/src/common/importmap.ts

@@ -62,7 +62,7 @@ async function resolveImportmap(dir: string, importmap: Importmap) {
       if (typeof url !== 'string') {
         log('generalInfo_0000', `The value of "${depName}" in the importmap is not a string and will be ignored.`);
       } else if (/^https?:\/\//.test(url)) {
-        const hash = computeHash(url);
+        const hash = computeHash(url).substring(0, 7);
 
         dependencies.push({
           id: `${identifier}@${hash}`,

package/src/common/io.ts

@@ -53,6 +53,27 @@ function isLegacy() {
   return +parts[0] < 10 || (+parts[0] === 10 && +parts[1] < 12);
 }
 
+export interface Destination {
+  outDir: string;
+  outFile: string;
+}
+
+export 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 async function removeAny(target: string) {
   const isDir = await checkIsDirectory(target);
 

package/src/common/npm.ts

@@ -2,12 +2,11 @@ import { resolve, relative, dirname } from 'path';
 import { createReadStream, existsSync, access, constants } from 'fs';
 import { log, fail } from './log';
 import { config } from './config';
-import { legacyCoreExternals } from './constants';
+import { legacyCoreExternals, frameworkLibs } from './constants';
 import { inspectPackage } from './inspect';
 import { readJson, checkExists, findFile } from './io';
 import { clientTypeKeys } from '../helpers';
 import { PackageType, NpmClientType } from '../types';
-import { frameworkLibs } from '.';
 
 const gitPrefix = 'git+';
 const filePrefix = 'file:';
@@ -441,6 +440,7 @@ function getCoreExternals(dependencies: Record<string, string>): Array<string> {
     }
   }
 
+  log('frameworkLibMissing_0078', frameworkLibs);
   return [];
 }
 

package/src/common/package.test.ts

@@ -61,10 +61,10 @@ describe('CLI package module', () => {
   });
 
   it('getPiralPackage returns piral package', () => {
-    let result = getPiralPackage('app', SourceLanguage.ts, '1.0.0', 'piral-base', 'npm');
-    expect(result.devDependencies['piral-cli-npm']).toEqual('1.0.0');
+    let result = getPiralPackage('app', SourceLanguage.ts, '1.0.0', 'piral-base', 'webpack');
+    expect(result.devDependencies['piral-cli-webpack']).toEqual('1.0.0');
     result = getPiralPackage('app', SourceLanguage.ts, '1.0.0', 'piral-base');
-    expect(result.devDependencies).not.toContain('piral-cli-npm');
+    expect(result.devDependencies).not.toContain('piral-cli-webpack');
   });
 
   it('retrievePiletData error cases', async () => {

package/src/common/package.ts

@@ -9,11 +9,27 @@ import { deepMerge } from './merge';
 import { applyTemplate } from './template';
 import { readImportmap } from './importmap';
 import { isGitPackage, isLocalPackage, makeGitUrl, makeFilePath, makePiletExternals, makeExternals } from './npm';
-import { filesTar, filesOnceTar, declarationEntryExtensions } from './constants';
+import { filesTar, filesOnceTar, declarationEntryExtensions, bundlerNames } from './constants';
 import { getHash, checkIsDirectory, matchFiles } from './io';
 import { readJson, copy, updateExistingJson, findFile, checkExists } from './io';
 import { Framework, FileInfo, PiletsInfo, TemplateFileLocation } from '../types';
 
+function appendBundler(devDependencies: Record<string, string>, bundler: string, version: string) {
+  if (bundler && bundler !== 'none') {
+    if (bundlerNames.includes(bundler as any)) {
+      devDependencies[`piral-cli-${bundler}`] = version;
+    } else if (!isValidDependency(bundler)) {
+      //Error case - print warning and ignore
+      log('generalWarning_0001', `The provided bundler name "${bundler}" does not refer to a valid package name.'`);
+    } else {
+      const sep = bundler.indexOf('@', 1);
+      const name = bundler.substring(0, sep !== -1 ? sep : bundler.length);
+      const version = sep !== -1 ? bundler.substring(sep + 1) : 'latest';
+      devDependencies[name] = version;
+    }
+  }
+}
+
 function getDependencyVersion(
   name: string,
   devDependencies: Record<string, string | true>,
@@ -168,9 +184,7 @@ export function getPiralPackage(
     ...getDependencies(language, packages),
   };
 
-  if (bundler && bundler !== 'none') {
-    devDependencies[`piral-cli-${bundler}`] = `${version}`;
-  }
+  appendBundler(devDependencies, bundler, version);
 
   return {
     app,
@@ -513,7 +527,7 @@ export async function patchPiletPackage(
     }, {}),
     [name]: `*`,
   };
-  const devDependencies = {
+  const devDependencies: Record<string, string> = {
     ...Object.keys(typeDependencies).reduce((deps, name) => {
       deps[name] = piralDependencies[name] || typeDependencies[name];
       return deps;
@@ -537,11 +551,9 @@ export async function patchPiletPackage(
 
   if (newInfo) {
     const bundler = newInfo.bundler;
-    devDependencies['piral-cli'] = `^${cliVersion}`;
-
-    if (bundler && bundler !== 'none') {
-      devDependencies[`piral-cli-${bundler}`] = `^${cliVersion}`;
-    }
+    const version = `^${cliVersion}`;
+    devDependencies['piral-cli'] = version;
+    appendBundler(devDependencies, bundler, version);
   }
 
   const packageContent = deepMerge(packageOverrides, {

package/src/helpers.ts

@@ -1,4 +1,5 @@
 import { ForceOverwrite, SourceLanguage } from './common/enums';
+import { bundlerNames, frameworkLibs } from './common/constants';
 import {
   Framework,
   NpmClientType,
@@ -13,20 +14,10 @@ export const fromKeys: Array<PiletPublishSource> = ['local', 'remote', 'npm'];
 export const piralBuildTypeKeys: Array<PiralBuildType> = ['all', 'release', 'emulator', 'emulator-sources'];
 export const piletBuildTypeKeys: Array<PiletBuildType> = ['default', 'standalone', 'manifest'];
 export const clientTypeKeys: Array<NpmClientType> = ['npm', 'pnpm', 'yarn'];
-export const bundlerKeys: Array<string> = [
-  'none',
-  'esbuild',
-  'parcel',
-  'parcel2',
-  'rollup',
-  'webpack',
-  'webpack5',
-  'vite',
-  'xbuild',
-];
+export const bundlerKeys: Array<string> = ['none', ...bundlerNames];
 export const availableBundlers: Array<string> = [];
 export const availableReleaseProviders: Array<string> = [];
-export const frameworkKeys: Array<Framework> = ['piral', 'piral-core', 'piral-base'];
+export const frameworkKeys: Array<Framework> = [...frameworkLibs];
 export const forceOverwriteKeys = Object.keys(ForceOverwrite).filter((m) => typeof ForceOverwrite[m] === 'number');
 
 export function valueOfForceOverwrite(key: string): ForceOverwrite {

package/src/messages.ts

@@ -1882,6 +1882,67 @@ export function entryFileMissing_0077(): QuickMessage {
   return [LogLevels.error, '0077', 'No valid entry file for the pilet found.'];
 }
 
+/**
+ * @kind Warning
+ *
+ * @summary
+ * The Piral instance is not referencing any framework package.
+ *
+ * @abstract
+ * A Piral instance has to reference either `piral-base`, `piral-core`
+ * or the whole `piral` framework package. If none of these dependencies
+ * is found then no framework dependencies can be shared automatically.
+ * Framework dependencies include react and react-router.
+ *
+ * @example
+ * You might use a monorepo where most / all dependencies are declared in
+ * a top-level package.json. Therefore, the package.json of the actual
+ * Piral instance could look like this:
+ *
+ * ```json
+ * {
+ *   "name": "my-piral-instance",
+ *   "version": "1.0.0",
+ *   "app": "./src/index.html",
+ *   "pilets": {}
+ * }
+ * ```
+ *
+ * While perfectly valid, this one lacks `dependencies` and `devDependencies`.
+ * Surely, those are not really needed in the described case, but under
+ * those conditions we cannot know what dependencies you may want to share. It
+ * could be that you only reference `piral-base` and therefore don't want to
+ * share anything except `tslib`. Or you use `piral-core` and also share things
+ * like `react` or `react-router-dom`.
+ *
+ * Either way, in order to recognize that you'll need to include the correct
+ * reference:
+ *
+ * ```json
+ * {
+ *   "name": "my-piral-instance",
+ *   "version": "1.0.0",
+ *   "app": "./src/index.html",
+ *   "pilets": {},
+ *   "dependencies": {
+ *     "piral": "latest"
+ *   }
+ * }
+ * ```
+ *
+ * If you only want to use `piral-base` or `piral-core` then replace `piral` in
+ * the example above. Also use the version that you'll like to use - `latest`
+ * is just one example.
+ *
+ */
+export function frameworkLibMissing_0078(frameworkLibs: Array<string>): QuickMessage {
+  return [
+    LogLevels.warning,
+    '0078',
+    `Did not find any reference to either ${frameworkLibs.join(', ')}. No framework dependencies are shared.`,
+  ];
+}
+
 /**
  * @kind Error
  *

package/src/types/public.ts

@@ -71,6 +71,8 @@ export interface DebugPiralParameters extends BaseBundleParameters {
   hmr: boolean;
   externals: Array<string>;
   publicUrl: string;
+  outFile: string;
+  outDir: string;
   entryFiles: string;
   logLevel: LogLevels;
 }
@@ -103,6 +105,8 @@ export interface DebugPiletParameters extends BaseBundleParameters {
   externals: Array<string>;
   importmap: Array<SharedDependency>;
   targetDir: string;
+  outFile: string;
+  outDir: string;
   entryModule: string;
   logLevel: LogLevels;
   version: PiletSchemaVersion;