piral-cli 1.10.3 → 1.11.0-beta.1bddd86

package/src/apps/new-piral.test.ts

@@ -24,104 +24,84 @@ const testOptions = {
 };
 
 describe('New Piral Command', () => {
-  it(
-    'scaffolding in an empty directory works',
-    async () => {
-      const dir = createTempDir();
-      await newPiral(dir, { install: false });
-      expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.tsx'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
-      expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
-    },
-    testOptions,
-  );
+  it('scaffolding in an empty directory works', testOptions, async () => {
+    const dir = createTempDir();
+    await newPiral(dir, { install: false });
+    expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.tsx'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
+    expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
+  });
 
-  it(
-    'scaffolding with language JS works',
-    async () => {
-      const dir = createTempDir();
-      await newPiral(dir, {
-        language: 'js',
-        install: false,
-      });
-      expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeFalsy();
-      expect(existsSync(resolve(dir, 'src/index.jsx'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
-      expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
-    },
-    testOptions,
-  );
+  it('scaffolding with language JS works', testOptions, async () => {
+    const dir = createTempDir();
+    await newPiral(dir, {
+      language: 'js',
+      install: false,
+    });
+    expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'src/index.jsx'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
+    expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
+  });
 
-  it(
-    'scaffolding with custom app name works',
-    async () => {
-      const dir = createTempDir();
-      await newPiral(dir, {
-        name: 'test-name',
-        install: false,
-      });
+  it('scaffolding with custom app name works', testOptions, async () => {
+    const dir = createTempDir();
+    await newPiral(dir, {
+      name: 'test-name',
+      install: false,
+    });
 
-      expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.tsx'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
-      expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.tsx'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
+    expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
 
-      const packageContent = await JSON.parse(readFileSync(`${dir}/package.json`, 'utf8'));
-      expect(packageContent.name).toBe('test-name');
-    },
-    testOptions,
-  );
+    const packageContent = await JSON.parse(readFileSync(`${dir}/package.json`, 'utf8'));
+    expect(packageContent.name).toBe('test-name');
+  });
 
-  it(
-    'scaffolding for piral-core works',
-    async () => {
-      const dir = createTempDir();
-      await newPiral(dir, {
-        framework: 'piral-core',
-        install: false,
-      });
-      expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeFalsy();
-      expect(existsSync(resolve(dir, 'node_modules/piral-core/package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.jsx'))).toBeFalsy();
-      expect(existsSync(resolve(dir, 'src/index.tsx'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
-      expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
-    },
-    testOptions,
-  );
+  it('scaffolding for piral-core works', testOptions, async () => {
+    const dir = createTempDir();
+    await newPiral(dir, {
+      framework: 'piral-core',
+      install: false,
+    });
+    expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'node_modules/piral-core/package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.jsx'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'src/index.tsx'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
+    expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
+  });
 
-  it(
-    'scaffolding for piral-base works',
-    async () => {
-      const dir = createTempDir();
-      await newPiral(dir, {
-        framework: 'piral-base',
-        install: false,
-      });
-      expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeFalsy();
-      expect(existsSync(resolve(dir, 'node_modules/piral-core/package.json'))).toBeFalsy();
-      expect(existsSync(resolve(dir, 'node_modules/piral-base/package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.jsx'))).toBeFalsy();
-      expect(existsSync(resolve(dir, 'src/index.ts'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
-      expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
-      expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
-    },
-    testOptions,
-  );
+  it('scaffolding for piral-base works', testOptions, async () => {
+    const dir = createTempDir();
+    await newPiral(dir, {
+      framework: 'piral-base',
+      install: false,
+    });
+    expect(existsSync(resolve(dir, 'node_modules/piral/package.json'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'node_modules/piral-core/package.json'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'node_modules/piral-base/package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'package.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'tsconfig.json'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.jsx'))).toBeFalsy();
+    expect(existsSync(resolve(dir, 'src/index.ts'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/index.html'))).toBeTruthy();
+    expect(existsSync(resolve(dir, 'src/mocks/backend.js'))).toBeTruthy();
+    expect(existsSync(resolve(dir, '.npmrc'))).toBeFalsy();
+  });
 });

package/src/common/declaration.ts

@@ -1,12 +1,14 @@
 import { DeclOptions, generateDeclaration, createDiffPlugin, Logger } from 'dets';
 import { basename, dirname, extname, join, resolve } from 'path';
+
 import { progress, log, logWarn, logVerbose, logInfo } from './log';
 import { ForceOverwrite } from './enums';
-import { retrievePiralRoot, retrievePiletsInfo, flattenExternals, validateSharedDependencies } from './package';
+import { retrievePiralRoot, retrievePiletsInfo, flattenExternals } from './package';
+import { getRemoteTypesTarget, validateSharedDependencies } from './package';
 import { entryModuleExtensions, piralBaseRoot, packageJson } from './constants';
 import { readText, getEntryFiles, matchFiles, createFileIfNotExists, readJson } from './io';
 import { getModulePath } from '../external';
-import { LogLevels } from '../types';
+import { LogLevels, PiletDefinition } from '../types';
 
 const piletApiName = 'PiletApi';
 
@@ -146,6 +148,7 @@ async function createDeclarationFile(options: DeclOptions, target: string, force
 export async function createPiletDeclaration(
   piralInstances: Array<string>,
   root: string,
+  definition: PiletDefinition,
   entry: string,
   allowedImports: Array<string>,
   target: string,
@@ -159,15 +162,17 @@ export async function createPiletDeclaration(
   if (file) {
     const files = await getAllFiles([entry]);
     const types = findDeclaredTypings(root);
+    const excluded = getRemoteTypesTarget(root, definition);
     const options: DeclOptions = {
       name: piralInstance,
       root,
       files,
       types,
+      excluded: excluded ? [excluded] : [],
       plugins: [createDiffPlugin(file)],
       apis,
       noModuleDeclaration: true,
-      imports: allowedImports.filter(m => !piralInstances.includes(m)),
+      imports: allowedImports.filter((m) => !piralInstances.includes(m)),
       logLevel,
       logger: createLogger(),
     };

package/src/common/package.test.ts

@@ -7,141 +7,105 @@ const testOptions = {
 };
 
 describe('CLI package module', () => {
-  it(
-    'findPackageVersion finds the current package version',
-    async () => {
-      const version = await findPackageVersion(process.cwd(), 'sample-piral');
-      expect(version).toBe(cliVersion);
-    },
-    testOptions,
-  );
+  it('findPackageVersion finds the current package version', testOptions, async () => {
+    const version = await findPackageVersion(process.cwd(), 'sample-piral');
+    expect(version).toBe(cliVersion);
+  });
 
-  it(
-    'findPackageVersion falls back to latest',
-    async () => {
-      const version = await findPackageVersion(process.cwd(), 'foo-bar-not-exists');
-      expect(version).toBe('latest');
-    },
-    testOptions,
-  );
+  it('findPackageVersion falls back to latest', testOptions, async () => {
+    const version = await findPackageVersion(process.cwd(), 'foo-bar-not-exists');
+    expect(version).toBe('latest');
+  });
 
-  it(
-    'getPiletsInfo returns pilets information about provided piralInfo',
-    () => {
-      const emptyPiletsInfo = {
-        files: [],
+  it('getPiletsInfo returns pilets information about provided piralInfo', testOptions, () => {
+    const emptyPiletsInfo = {
+      files: [],
+      template: 'default',
+      scripts: {},
+      validators: {},
+      devDependencies: {},
+      preScaffold: '',
+      postScaffold: '',
+      packageOverrides: {},
+      preUpgrade: '',
+      postUpgrade: '',
+    };
+    let result = getPiletsInfo({});
+    expect(result).toStrictEqual(emptyPiletsInfo);
+
+    const piralInfo = {
+      pilets: {
+        files: ['foo.tgz', 'foo2.tgz'],
         template: 'default',
         scripts: {},
         validators: {},
         devDependencies: {},
         preScaffold: '',
-        postScaffold: '',
         packageOverrides: {},
+        postScaffold: '',
         preUpgrade: '',
         postUpgrade: '',
-      };
-      let result = getPiletsInfo({});
-      expect(result).toStrictEqual(emptyPiletsInfo);
-
-      const piralInfo = {
-        pilets: {
-          files: ['foo.tgz', 'foo2.tgz'],
-          template: 'default',
-          scripts: {},
-          validators: {},
-          devDependencies: {},
-          preScaffold: '',
-          packageOverrides: {},
-          postScaffold: '',
-          preUpgrade: '',
-          postUpgrade: '',
-        },
-      };
-      result = getPiletsInfo(piralInfo);
-      expect(result).toStrictEqual(piralInfo.pilets);
-    },
-    testOptions,
-  );
+      },
+    };
+    result = getPiletsInfo(piralInfo);
+    expect(result).toStrictEqual(piralInfo.pilets);
+  });
 
-  it(
-    'getPiralPackage returns piral package with webpack in latest version',
-    async () => {
-      const result = await getPiralPackage(
-        'app',
-        { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
-        '10.0.0',
-        'webpack',
-      );
-      expect(result.devDependencies['piral-cli-webpack']).toEqual('latest');
-    },
-    testOptions,
-  );
+  it('getPiralPackage returns piral package with webpack in latest version', testOptions, async () => {
+    const result = await getPiralPackage(
+      'app',
+      { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
+      '10.0.0',
+      'webpack',
+    );
+    expect(result.devDependencies['piral-cli-webpack']).toEqual('latest');
+  });
 
-  it(
-    'getPiralPackage returns piral package with webpack in beta version',
-    async () => {
-      const result = await getPiralPackage(
-        'app',
-        { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
-        '0.15.0-beta.1',
-        'webpack',
-      );
-      expect(result.devDependencies['piral-cli-webpack']).toEqual('next');
-    },
-    testOptions,
-  );
+  it('getPiralPackage returns piral package with webpack in beta version', testOptions, async () => {
+    const result = await getPiralPackage(
+      'app',
+      { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
+      '0.15.0-beta.1',
+      'webpack',
+    );
+    expect(result.devDependencies['piral-cli-webpack']).toEqual('next');
+  });
 
-  it(
-    'getPiralPackage returns piral package with webpack in alpha version',
-    async () => {
-      const result = await getPiralPackage(
-        'app',
-        { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
-        '0.15.0-alpha.1',
-        'webpack',
-      );
-      expect(result.devDependencies['piral-cli-webpack']).toEqual('canary');
-    },
-    testOptions,
-  );
+  it('getPiralPackage returns piral package with webpack in alpha version', testOptions, async () => {
+    const result = await getPiralPackage(
+      'app',
+      { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
+      '0.15.0-alpha.1',
+      'webpack',
+    );
+    expect(result.devDependencies['piral-cli-webpack']).toEqual('canary');
+  });
 
-  it(
-    'getPiralPackage returns piral package with webpack in existing version',
-    async () => {
-      const result = await getPiralPackage(
-        'app',
-        { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
-        '0.14.0',
-        'webpack',
-      );
-      expect(result.devDependencies['piral-cli-webpack']).toEqual('0.14.0');
-    },
-    testOptions,
-  );
+  it('getPiralPackage returns piral package with webpack in existing version', testOptions, async () => {
+    const result = await getPiralPackage(
+      'app',
+      { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
+      '0.14.0',
+      'webpack',
+    );
+    expect(result.devDependencies['piral-cli-webpack']).toEqual('0.14.0');
+  });
 
-  it(
-    'getPiralPackage returns piral package without bundler',
-    async () => {
-      const result = await getPiralPackage(
-        'app',
-        { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
-        '1.0.0',
-      );
-      expect(result.devDependencies['piral-cli-webpack']).toBeUndefined();
-    },
-    testOptions,
-  );
+  it('getPiralPackage returns piral package without bundler', testOptions, async () => {
+    const result = await getPiralPackage(
+      'app',
+      { language: 'ts', packageName: 'piral-base', reactRouterVersion: 5, reactVersion: 17 },
+      '1.0.0',
+    );
+    expect(result.devDependencies['piral-cli-webpack']).toBeUndefined();
+  });
 
-  it(
-    'retrievePiletData error cases',
-    async () => {
-      await expect(retrievePiletData('foo', 'bar')).rejects.toThrow(
-        '[0010] The defined Piral instance ("bar") could not be found.',
-      );
-      await expect(retrievePiletData('/foo', 'sample-piral')).rejects.toThrow(
-        '[0075] Cannot find the "package.json". You need a valid package.json for your pilet.',
-      );
-    },
-    testOptions,
-  );
+  it('retrievePiletData error cases', testOptions, async () => {
+    await expect(retrievePiletData('foo', 'bar')).rejects.toThrow(
+      '[0010] The defined Piral instance ("bar") could not be found.',
+    );
+    await expect(retrievePiletData('/foo', 'sample-piral')).rejects.toThrow(
+      '[0075] Cannot find the "package.json". You need a valid package.json for your pilet.',
+    );
+  });
 });

package/src/common/package.ts

@@ -16,11 +16,12 @@ import { makePiletExternals, makeExternals, findPackageRoot, findSpecificVersion
 import { scaffoldFromEmulatorWebsite, updateFromEmulatorWebsite, retrieveExtraTypings } from './website';
 import { getDependencies, getDependencyPackages, getDevDependencies } from './language';
 import { getDevDependencyPackages, getFrameworkDependencies } from './language';
-import { piralJsonSchemaUrl, filesTar, filesOnceTar, bundlerNames, packageJson } from './constants';
-import { frameworkLibs, declarationEntryExtensions, piralJson, piletJson } from './constants';
+import { piralJsonSchemaUrl, filesTar, filesOnceTar, bundlerNames } from './constants';
+import { frameworkLibs, defaultRemoteTypesTarget, packageJson } from './constants';
+import { declarationEntryExtensions, piralJson, piletJson } from './constants';
 import { satisfies } from './version';
 import { getModulePath } from '../external';
-import { PiletsInfo, SharedDependency, PiletDefinition, AppDefinition, NpmClient } from '../types';
+import type { PiletsInfo, SharedDependency, PiletDefinition, AppDefinition, NpmClient } from '../types';
 import type { SourceLanguage, PiralInstancePackageData, PiralInstanceDetails } from '../types';
 import type { Framework, FileInfo, TemplateFileLocation, PiletPackageData, PiralPackageData } from '../types';
 
@@ -236,6 +237,17 @@ async function saveRemoteTypes(generatedText: string, target: string) {
   }
 }
 
+export function getRemoteTypesTarget(rootDir: string, piletDefinition: PiletDefinition) {
+  const { remoteTypesTarget } = piletDefinition || {};
+  const proposedTarget =
+    typeof remoteTypesTarget === 'string'
+      ? remoteTypesTarget
+      : remoteTypesTarget
+        ? defaultRemoteTypesTarget
+        : undefined;
+  return proposedTarget ? resolve(rootDir, proposedTarget) : undefined;
+}
+
 async function writeRemoteTypes(
   rootDir: string,
   appPackages: Array<PiralInstancePackageData>,
@@ -243,14 +255,11 @@ async function writeRemoteTypes(
   piletDefinition: PiletDefinition,
   agent: Agent,
 ) {
-  const { remoteTypesTarget } = piletDefinition || {};
-  const proposedTarget =
-    typeof remoteTypesTarget === 'string' ? remoteTypesTarget : remoteTypesTarget ? './src/remote.d.ts' : undefined;
+  const target = getRemoteTypesTarget(rootDir, piletDefinition);
 
-  if (proposedTarget) {
+  if (target) {
     const snippets = await retrieveRemoteTypes(appPackages, piletPackage, agent);
     const generatedText = combineRemoteTypes(snippets);
-    const target = resolve(rootDir, proposedTarget);
 
     if (generatedText) {
       await saveRemoteTypes(generatedText, target);
@@ -959,6 +968,7 @@ export async function retrievePiletData(target: string, app?: string, agent?: Ag
     peerModules: piletPackage.peerModules || [],
     ignored: checkArrayOrUndefined(piletPackage, 'preservedDependencies'),
     schema: piletDefinition?.schemaVersion,
+    definition: piletDefinition,
     importmap,
     apps,
     piletPackage,

package/src/common/pilet.ts

@@ -68,7 +68,7 @@ export async function triggerBuildPilet({
   _,
 }: BuildPiletOptions) {
   const targetDir = dirname(entryModule);
-  const { peerDependencies, peerModules, root, apps, piletPackage, ignored, importmap, schema } =
+  const { peerDependencies, peerModules, root, apps, piletPackage, ignored, importmap, schema, definition } =
     await retrievePiletData(targetDir, app);
   const schemaVersion = originalSchemaVersion || schema || config.schemaVersion || defaultSchemaVersion;
   const piralInstances = apps.map((m) => m.appPackage.name);
@@ -119,6 +119,7 @@ export async function triggerBuildPilet({
     await createPiletDeclaration(
       piralInstances,
       root,
+      definition,
       entryModule,
       externals,
       outDir,