piral-cli 0.15.0-alpha.3589 → 0.15.0-alpha.3711

package/src/common/spec.ts

@@ -46,6 +46,7 @@ export function getPiletSpecMeta(target: string, basePath: string) {
         dependencies: getDependencies(plainDependencies, basePath),
       };
     } else {
+      // uses no arguments
       return {
         spec: 'v0',
         hash: computeHash(content),

package/src/helpers.ts

@@ -1,4 +1,5 @@
 import { ForceOverwrite, SourceLanguage } from './common/enums';
+import { bundlerNames, frameworkLibs } from './common/constants';
 import {
   Framework,
   NpmClientType,
@@ -13,10 +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', 'parcel', 'webpack', 'webpack5', 'esbuild', '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/injectors/pilet.ts

@@ -19,6 +19,7 @@ interface Pilet {
 
 export interface PiletInjectorConfig extends KrasInjectorConfig {
   pilets: Array<Pilet>;
+  meta: string;
   api: string;
   app: string;
   feed?: string;
@@ -29,17 +30,22 @@ interface PiletMetadata {
   [key: string]: unknown;
 }
 
-function fillPiletMeta(pilet: Pilet, basePath: string) {
+function fillPiletMeta(pilet: Pilet, basePath: string, metaFile: string) {
   const { root, bundler } = pilet;
-  const def = JSON.parse(readFileSync(join(root, 'package.json'), 'utf8'));
+  const metaPath = join(root, metaFile);
+  const packagePath = join(root, 'package.json');
+  const def = JSON.parse(readFileSync(packagePath, 'utf8'));
+  const metaOverride = existsSync(metaPath) ? JSON.parse(readFileSync(metaPath, 'utf8')) : undefined;
   const file = bundler.bundle.name.replace(/^[\/\\]/, '');
   const target = join(bundler.bundle.dir, file);
   const url = new URL(file, basePath);
   const meta = {
+    custom: def.custom,
+    config: def.piletConfig,
+    ...metaOverride,
     name: def.name,
     version: def.version,
     link: `${url.href}?updated=${Date.now()}`,
-    custom: def.custom,
     ...getPiletSpecMeta(target, basePath),
   };
 
@@ -92,7 +98,7 @@ export default class PiletInjector implements KrasInjector {
     pilets.forEach((p, i) =>
       p.bundler.on(() => {
         const basePath = `${this.piletApi}/${i}/`;
-        const meta = fillPiletMeta(p, basePath);
+        const meta = fillPiletMeta(p, basePath, options.meta);
 
         for (const id of Object.keys(cbs)) {
           cbs[id](meta);

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
  *