piral-cli 0.15.0-alpha.4311 → 0.15.0-alpha.4345

package/src/common/template.ts

@@ -1,53 +1,32 @@
-import { renderFile } from 'ejs';
-import { writeFile } from 'fs';
-import { resolve } from 'path';
-import { log } from './log';
 import { ForceOverwrite } from './enums';
 import { createFileIfNotExists } from './io';
 
-export async function applyTemplate(file: string, data: Record<string, string>) {
-  const content = await new Promise<string>((resolve, reject) => {
-    log('generalDebug_0003', `Filling template in "${file}".`);
-    renderFile(file, data, (err, str) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(str);
-      }
-    });
-  });
-  await new Promise<void>((resolve, reject) => {
-    writeFile(file, content, 'utf8', (err) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve();
-      }
-    });
-  });
-}
+function fillTemplate(data: any = {}) {
+  return `if (process.env.NODE_ENV === 'test') {
+  // behavior for the test environment, we'll try to make it work
 
-export function fillTemplate(name: string, data: any = {}) {
-  const path = resolve(__dirname, '..', '..', 'templates', `${name}.ejs`);
-  return new Promise<string>((resolve, reject) => {
-    log('generalDebug_0003', `Rendering template "${name}" in "${path}".`);
-    renderFile(path, data, (err, str) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(str);
-      }
-    });
-  });
+  if (typeof window !== 'undefined') {
+    require('./${data.outFile}');
+    const ctx = window['dbg:piral'];
+    const dependencies = (ctx && ctx.pilets && ctx.pilets.getDependencies({})) || {};
+    module.exports = dependencies['${data.name}'] || {};
+  } else {
+    console.error('Your test environment does not define "window". Please make sure to provide a proper environment.');
+    module.exports = {};
+  }
+} else {
+  // under "normal" circumstances disallow such an import
+  throw new Error("This file should not be included anywhere. Usually, this means you've imported the Piral instance directly.");
+}
+`;
 }
 
-export async function createFileFromTemplateIfNotExists(
-  prefix: string,
+export async function createPiralStubIndexIfNotExists(
   targetDir: string,
   fileName: string,
   forceOverwrite?: ForceOverwrite,
   data?: any,
 ) {
-  const content = await fillTemplate(`${prefix}-${fileName}`, data);
+  const content = fillTemplate(data);
   await createFileIfNotExists(targetDir, fileName, content, forceOverwrite);
 }

package/src/helpers.test.ts

@@ -1,5 +1,5 @@
-import { keyOfForceOverwrite, keyOfSourceLanguage, valueOfForceOverwrite, valueOfSourceLanguage } from './helpers';
-import { ForceOverwrite, SourceLanguage } from './common/enums';
+import { keyOfForceOverwrite, valueOfForceOverwrite } from './helpers';
+import { ForceOverwrite } from './common/enums';
 
 describe('Piral CLI Command Helpers Module', () => {
   it('correct value of keyOfForceOverwrite results in same key', () => {
@@ -12,16 +12,6 @@ describe('Piral CLI Command Helpers Module', () => {
     expect(result).toBe('no');
   });
 
-  it('correct value of keyOfPiletLanguage results in same key', () => {
-    const result = keyOfSourceLanguage(SourceLanguage.ts);
-    expect(result).toBe('ts');
-  });
-
-  it('incorrect value of keyOfPiletLanguage results in key for TS', () => {
-    const result = keyOfSourceLanguage(5);
-    expect(result).toBe('ts');
-  });
-
   it('correct key of valueOfForceOverwrite results in same value', () => {
     const result = valueOfForceOverwrite('prompt');
     expect(result).toBe(ForceOverwrite.prompt);
@@ -31,14 +21,4 @@ describe('Piral CLI Command Helpers Module', () => {
     const result = valueOfForceOverwrite('foo');
     expect(result).toBe(ForceOverwrite.no);
   });
-
-  it('correct key of valueOfPiletLanguage results in same value', () => {
-    const result = valueOfSourceLanguage('ts');
-    expect(result).toBe(SourceLanguage.ts);
-  });
-
-  it('incorrect key of valueOfPiletLanguage results in value for TS', () => {
-    const result = valueOfSourceLanguage('foo');
-    expect(result).toBe(SourceLanguage.ts);
-  });
 });

package/src/helpers.ts

@@ -1,4 +1,4 @@
-import { ForceOverwrite, SourceLanguage } from './common/enums';
+import { ForceOverwrite } from './common/enums';
 import { bundlerNames, frameworkLibs } from './common/constants';
 import type {
   Framework,
@@ -8,6 +8,7 @@ import type {
   PiralBuildType,
   PiletBuildType,
   PiletPublishScheme,
+  SourceLanguage,
 } from './types';
 
 export const schemaKeys: Array<PiletSchemaVersion> = ['v0', 'v1', 'v2', 'none'];
@@ -16,6 +17,7 @@ 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', 'pnp', 'yarn', 'lerna', 'rush'];
+export const sourceLanguageKeys: Array<SourceLanguage> = ['ts', 'js'];
 export const bundlerKeys: Array<string> = ['none', ...bundlerNames];
 export const availableBundlers: Array<string> = [];
 export const availableReleaseProviders: Array<string> = [];
@@ -41,25 +43,3 @@ export function keyOfForceOverwrite(value: ForceOverwrite) {
 
   return forceOverwriteKeys[0];
 }
-
-export const sourceLanguageKeys = Object.keys(SourceLanguage).filter((m) => typeof SourceLanguage[m] === 'number');
-
-export function valueOfSourceLanguage(key: string): SourceLanguage {
-  for (const piletLanguageKey of sourceLanguageKeys) {
-    if (piletLanguageKey === key) {
-      return SourceLanguage[piletLanguageKey];
-    }
-  }
-
-  return SourceLanguage.ts;
-}
-
-export function keyOfSourceLanguage(value: SourceLanguage) {
-  for (const piletLanguageKey of sourceLanguageKeys) {
-    if (SourceLanguage[piletLanguageKey] === value) {
-      return piletLanguageKey;
-    }
-  }
-
-  return sourceLanguageKeys[0];
-}

package/src/types/common.ts

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

package/src/types/public.ts

@@ -219,6 +219,8 @@ export interface BundlerDefinition {
 
 export type PiletSchemaVersion = 'none' | 'v0' | 'v1' | 'v2';
 
+export type SourceLanguage = 'js' | 'ts';
+
 export type PiletPublishScheme = 'none' | 'digest' | 'bearer' | 'basic';
 
 export type PiletPublishSource = 'local' | 'npm' | 'remote';

package/templates/piral-index.js.ejs

@@ -1,16 +0,0 @@
-if (process.env.NODE_ENV === 'test') {
-  // behavior for the test environment, we'll try to make it work
-
-  if (typeof window !== 'undefined') {
-    require('./<%- outFile %>');
-    const ctx = window['dbg:piral'];
-    const dependencies = (ctx && ctx.pilets && ctx.pilets.getDependencies({})) || {};
-    module.exports = dependencies['<%- name %>'] || {};
-  } else {
-    console.error('Your test environment does not define "window". Please make sure to provide a proper environment.');
-    module.exports = {};
-  }
-} else {
-  // under "normal" circumstances disallow such an import
-  throw new Error("This file should not be included anywhere. Usually, this means you've imported the Piral instance directly.");
-}