piral-cli 0.15.0-beta.4672 → 0.15.0-beta.4699

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-cli",
-  "version": "0.15.0-beta.4672",
+  "version": "0.15.0-beta.4699",
   "description": "The standard CLI for creating and building a Piral instance or a Pilet.",
   "keywords": [
     "portal",
@@ -42,11 +42,12 @@
   },
   "scripts": {
     "cleanup": "rimraf lib",
-    "build": "tsc --declaration && rimraf lib/external && ncc build src/external/index.ts -o lib/external",
+    "build": "yarn build:source && rimraf lib/external && yarn build:external",
+    "build:source": "tsc --declaration",
+    "build:external": "esbuild src/external/index.ts --bundle --outfile=lib/external/index.js --format=cjs --platform=node --external:pnpapi",
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "@parcel/logger": "^1.11.1",
     "@types/express": "^4.16.1",
     "@types/glob": "^7.1.1",
     "@types/inquirer": "^6.0.0",
@@ -57,26 +58,27 @@
     "@types/rimraf": "^2.0.2",
     "@types/tar": "^4.0.0",
     "@types/yargs": "^15.0.4",
-    "@zeit/ncc": "^0.22.3",
     "axios": "^0.21.1",
+    "chalk": "^4.0.0",
+    "enhanced-resolve": "^5.10.0",
     "form-data": "^3.0.0",
     "get-port": "^5.0.0",
     "glob": "^7.1.3",
     "inquirer": "^6.2.2",
+    "is-interactive": "^2.0.0",
     "jju": "^1.4.0",
     "mime": "^2.5.2",
     "open": "^7.1.0",
+    "ora": "^6.1.2",
     "rc": "^1.2.8",
-    "strip-ansi": "^5.2.0",
     "tar": "^4.4.8"
   },
   "dependencies": {
-    "chalk": "^2.4.2",
     "dets": "^0.12.0",
     "kras": "^0.15.1",
     "rimraf": "^3.0.0",
     "typescript": "^4.7.3",
     "yargs": "^15.4.1"
   },
-  "gitHead": "cd1026b70c90290fa5ba3f9b86c038eb852595be"
+  "gitHead": "1d7d09c7a953009ade1470abf74b5e7e627f2bc2"
 }

package/src/apps/debug-pilet.ts

@@ -305,7 +305,7 @@ export async function debugPilet(baseDir = process.cwd(), options: DebugPiletOpt
     checkSanity(pilets);
 
     await hooks.beforeApp?.({ appInstanceDir, pilets });
-    const appDirs = [appInstanceDir] || (await getOrMakeApps(pilets[0], logLevel));
+    const appDirs = appInstanceDir ? [appInstanceDir] : (await getOrMakeApps(pilets[0], logLevel));
 
     await Promise.all(
       appDirs.map(async (appDir) => {

package/src/common/archive.test.ts

@@ -45,52 +45,58 @@ jest.mock('path', () =>
 );
 
 const fileNotFoundError = 'File not found!';
-jest.mock('tar', () => ({
-  create: (options: CreateOptions & FileOptions, fileList: ReadonlyArray<string>) => {
-    return new Promise((resolve, reject) => {
-      if (options.file && options.file == 'foo.txt') {
-        resolve(true);
-      } else {
-        reject(fileNotFoundError);
-      }
-    });
-  },
-  extract: (options: ExtractOptions & FileOptions, fileList?: ReadonlyArray<string>) => {
-    return new Promise((resolve, reject) => {
-      if (options.file && options.file.includes('foo.tgz')) {
-        resolve(true);
-      } else {
-        reject(fileNotFoundError);
-      }
-    });
-  },
-  Parse: () => {
-    return {
-      position: 0,
-      _stream: new Stream(),
-      _ended: false,
-      _streamEnd: () => {
-        this._ended = true;
-        console.log('_streamEnd');
-      },
-      process: (c: Buffer) => {
-        console.log('process');
-      },
-      _startEntry: (c: Buffer) => {
-        console.log('_startEntry');
-      },
-      on: (event: string, listener: (...args: any[]) => {}) => {
-        console.log(`on event: ${event}`);
-      },
-      once: (event: string, listener: (...args: any[]) => {}) => {
-        console.log(`once event: ${event}`);
-      },
-      emit: (event: string | symbol, ...args: any[]) => {
-        console.log(`emit event: ${event.toString()}`);
-        return true;
-      },
-    } as any;
+
+jest.mock('../external', () => ({
+  ora() {
+    return {};
   },
+  tar: {
+    create: (options: CreateOptions & FileOptions, fileList: ReadonlyArray<string>) => {
+      return new Promise((resolve, reject) => {
+        if (options.file && options.file == 'foo.txt') {
+          resolve(true);
+        } else {
+          reject(fileNotFoundError);
+        }
+      });
+    },
+    extract: (options: ExtractOptions & FileOptions, fileList?: ReadonlyArray<string>) => {
+      return new Promise((resolve, reject) => {
+        if (options.file && options.file.includes('foo.tgz')) {
+          resolve(true);
+        } else {
+          reject(fileNotFoundError);
+        }
+      });
+    },
+    Parse: () => {
+      return {
+        position: 0,
+        _stream: new Stream(),
+        _ended: false,
+        _streamEnd: () => {
+          this._ended = true;
+          console.log('_streamEnd');
+        },
+        process: (c: Buffer) => {
+          console.log('process');
+        },
+        _startEntry: (c: Buffer) => {
+          console.log('_startEntry');
+        },
+        on: (event: string, listener: (...args: any[]) => {}) => {
+          console.log(`on event: ${event}`);
+        },
+        once: (event: string, listener: (...args: any[]) => {}) => {
+          console.log(`once event: ${event}`);
+        },
+        emit: (event: string | symbol, ...args: any[]) => {
+          console.log(`emit event: ${event.toString()}`);
+          return true;
+        },
+      } as any;
+    },
+  }
 }));
 
 describe('Archive Module', () => {

package/src/common/browser.test.ts

@@ -2,13 +2,23 @@ import { openBrowser } from './browser';
 
 let error = false;
 
-jest.mock('open', () => (...args) => {
-  if (error) {
-    throw new Error('Error occured');
-  } else {
-    return null;
-  }
-});
+jest.mock('../external', () => ({
+  rc(_, cfg) {
+    return cfg;
+  },
+  ora() {
+    return {
+      fail() {},
+    };
+  },
+  open() {
+    if (error) {
+      throw new Error('Error occured');
+    } else {
+      return null;
+    }
+  },
+}));
 
 describe('Browser Module', () => {
   it('opens browser successfully', async () => {

package/src/common/constants.ts

@@ -3,6 +3,8 @@ export const filesTar = 'files';
 export const filesOnceTar = 'files_once';
 export const piralBaseRoot = 'piral-base/package.json';
 export const frameworkLibs = ['piral-native' as const, 'piral' as const, 'piral-core' as const, 'piral-base' as const];
+export const piletJsonSchemaUrl = 'https://schema.piral.io/v0/pilet.json';
+export const piralJsonSchemaUrl = 'https://schema.piral.io/v0/piral.json';
 export const entryModuleExtensions = ['.ts', '.tsx', '.js', '.jsx'];
 export const bundlerNames = [
   'esbuild' as const,

package/src/common/http.test.ts

@@ -7,66 +7,78 @@ let errorOther = false;
 let errorResponse = false;
 let errorResponse2 = false;
 
-jest.mock('axios', () => ({
-  default: {
-    post(url, _, options) {
-      const found = url === apiUrl;
-      const auth = options.headers.authorization === 'Basic 123';
+jest.mock('../external', () => ({
+  rc(_, cfg) {
+    return cfg;
+  },
+  ora() {
+    return {
+      warn() {},
+      fail() {},
+    };
+  },
+  axios: {
+    default: {
+      post(url, _, options) {
+        const found = url === apiUrl;
+        const auth = options.headers.authorization === 'Basic 123';
 
-      if (errorRequest) {
-        return Promise.reject({
-          request: {},
-        });
-      } else if (errorOther) {
-        return Promise.reject({
-          message: 'error',
-        });
-      } else if (errorResponse) {
-        return Promise.reject({
-          response: {
-            status: 410,
-            statusText: 'Not Gone',
-            data: '{ "message": "This component is not available anymore." }',
-          },
-        });
-      } else if (errorResponse2) {
-        return Promise.reject({
-          response: {
-            status: 410,
-            statusText: 'Not Gone',
-            data: { message: 'This component is not available anymore.' },
-          },
-        });
-      } else if (!found) {
-        return Promise.reject({
-          response: {
-            status: 404,
-            statusText: 'Not found',
-          },
-        });
-      } else if (!auth) {
-        return Promise.reject({
-          response: {
-            status: 401,
-            statusText: 'Not authorized',
-          },
-        });
-      } else {
-        return Promise.resolve({
-          status: 200,
-          statusText: 'OK',
-        });
-      }
-    },
-    get(url, options) {
-      if (errorOther) {
-        return Promise.reject({
-          message: 'error',
-        });
-      }
-      return Promise.resolve({ data: 'test' });
+        if (errorRequest) {
+          return Promise.reject({
+            request: {},
+          });
+        } else if (errorOther) {
+          return Promise.reject({
+            message: 'error',
+          });
+        } else if (errorResponse) {
+          return Promise.reject({
+            response: {
+              status: 410,
+              statusText: 'Not Gone',
+              data: '{ "message": "This component is not available anymore." }',
+            },
+          });
+        } else if (errorResponse2) {
+          return Promise.reject({
+            response: {
+              status: 410,
+              statusText: 'Not Gone',
+              data: { message: 'This component is not available anymore.' },
+            },
+          });
+        } else if (!found) {
+          return Promise.reject({
+            response: {
+              status: 404,
+              statusText: 'Not found',
+            },
+          });
+        } else if (!auth) {
+          return Promise.reject({
+            response: {
+              status: 401,
+              statusText: 'Not authorized',
+            },
+          });
+        } else {
+          return Promise.resolve({
+            status: 200,
+            statusText: 'OK',
+          });
+        }
+      },
+      get(url, options) {
+        if (errorOther) {
+          return Promise.reject({
+            message: 'error',
+          });
+        }
+        return Promise.resolve({ data: 'test' });
+      },
     },
   },
+  FormData: jest.requireActual('form-data'),
 }));
 
 describe('HTTP Module', () => {

package/src/common/injectors.ts

@@ -1,7 +1,7 @@
-import chalk from 'chalk';
 import { resolve } from 'path';
 import { liveIcon, settingsIcon } from './emoji';
 import { logInfo, log, logReset } from './log';
+import { chalk } from '../external';
 import { Bundler } from '../types';
 
 export function notifyServerOnline(bundlers: Array<Bundler>, path: string, api: string | false) {

package/src/common/interactive.test.ts

@@ -6,6 +6,9 @@ jest.mock('../external', () => ({
   rc(_, cfg) {
     return cfg;
   },
+  ora() {
+    return {};
+  },
   inquirer: {
     prompt: (...any) => {
       return Promise.resolve({ q: answer });

package/src/common/log.ts

@@ -1,111 +1,79 @@
 import * as messages from '../messages';
-import { join } from 'path';
 import { format } from 'util';
-import { createWriteStream } from 'fs';
-import { isWindows } from './info';
-import { stripAnsi } from '../external';
+import { ora } from '../external';
 import { LogLevels, QuickMessage } from '../types';
 
 type Messages = typeof messages;
 type MessageTypes = keyof Messages;
 let currentProgress: string = undefined;
-
-const logger = (() => {
-  try {
-    const logger = require('@parcel/logger');
-
-    // check to see if this is really right
-    if (typeof logger.verbose === 'function') {
-      return logger;
-    }
-  } catch {}
-
-  return require('../external').logger;
-})();
-
-// unfortunately, Parcel's support for verbose logging on Windows is broken
-if (isWindows) {
-  logger.verbose = function (message: string) {
-    if (this.logLevel < 4) {
-      return;
-    }
-
-    const currDate = new Date();
-    message = `[${currDate.toLocaleTimeString()}]: ${message}`;
-
-    if (this.logLevel > 4) {
-      if (!this.logFile) {
-        // the critical line is the filename; it must not contain colons!
-        const timestamp = currDate.toISOString().replace(/:/g, '');
-        const fileName = `parcel-debug-${timestamp}.log`;
-        this.logFile = createWriteStream(join(process.cwd(), fileName));
-      }
-
-      this.logFile.write(stripAnsi.default(message) + '\n');
-    }
-
-    this._log(message);
-  };
-}
+let logLevel = LogLevels.info;
+let instance = ora();
 
 export function getLogLevel(): LogLevels {
-  return logger.logLevel;
+  return logLevel;
 }
 
-export function setLogLevel(logLevel: LogLevels) {
-  logger.setOptions({ logLevel });
+export function setLogLevel(value: LogLevels) {
+  logLevel = value;
 }
 
 export function logInfo(message: string, ...args: Array<string | number | boolean>) {
   const msg = format(message, ...args);
-  logger.log(msg);
+  instance.info(msg);
   return msg;
 }
 
 export function logDebug(message: string, ...args: Array<string | number | boolean>) {
   const msg = format(message, ...args);
-  logger.verbose(msg);
+
+  if (logLevel >= LogLevels.debug) {
+    instance.info(msg);
+  }
+
   return msg;
 }
 
 export function logVerbose(message: string, ...args: Array<string | number | boolean>) {
   const msg = format(message, ...args);
-  logger.logLevel > 3 && logger.log(msg);
+
+  if (logLevel >= LogLevels.verbose) {
+    instance.info(msg);
+  }
+
   return msg;
 }
 
 export function logDone(message: string, ...args: Array<string | number | boolean>) {
   const msg = format(message, ...args);
-  logger.success(msg);
+  instance.succeed(msg);
   return msg;
 }
 
 export function logWarn(message: string, ...args: Array<string | number | boolean>) {
   const msg = format(message, ...args);
-  logger.warn(msg);
+  instance.warn(msg);
   return msg;
 }
 
 export function logFail(message: string, ...args: Array<string | number | boolean>) {
   const msg = format(message, ...args);
-  logger.error(msg);
+  instance.fail(msg);
   return msg;
 }
 
 export function progress(message: string, ...args: Array<string | number | boolean>) {
   currentProgress = format(message, ...args)
-  logger.progress(currentProgress);
+  instance.start(message);
 }
 
 export function logReset() {
-  logger.lines = 0;
-  logger.stopSpinner();
+  instance.stop();
 }
 
 export function logSuspend() {
   logReset();
 
-  return () => logger.progress(currentProgress);
+  return () => instance.start(currentProgress);
 }
 
 export function fail<T extends MessageTypes>(type: T, ...args: Parameters<Messages[T]>): never {

package/src/common/npm.test.ts

@@ -28,13 +28,8 @@ jest.mock('child_process');
 
 jest.mock('../external', () => ({
   rc() {},
-  logger: {
-    stopSpinner() {},
-    verbose() {},
-    info() {},
-    error() {},
-    log() {},
-    setOptions() {},
+  ora() {
+    return {};
   },
 }));
 

package/src/common/package.ts

@@ -7,11 +7,18 @@ import { ForceOverwrite } from './enums';
 import { checkAppShellCompatibility } from './compatibility';
 import { deepMerge } from './merge';
 import { readImportmap } from './importmap';
-import { filesTar, filesOnceTar, declarationEntryExtensions, bundlerNames } from './constants';
 import { getHash, checkIsDirectory, matchFiles } from './io';
 import { readJson, copy, updateExistingJson, findFile, checkExists } from './io';
 import { isGitPackage, isLocalPackage, makeGitUrl, makeFilePath } from './npm';
 import { makePiletExternals, makeExternals, findPackageRoot, findSpecificVersion } from './npm';
+import {
+  filesTar,
+  filesOnceTar,
+  declarationEntryExtensions,
+  bundlerNames,
+  piralJsonSchemaUrl,
+  piletJsonSchemaUrl,
+} from './constants';
 import {
   SourceLanguage,
   Framework,
@@ -210,7 +217,10 @@ export async function patchPiralPackage(
   await updateExistingJson(root, 'package.json', pkg);
   log('generalDebug_0003', `Succesfully patched the package.json.`);
 
-  await updateExistingJson(root, 'piral.json', { pilets: getPiletsInfo({}) });
+  await updateExistingJson(root, 'piral.json', {
+    $schema: piralJsonSchemaUrl,
+    pilets: getPiletsInfo({}),
+  });
   log('generalDebug_0003', `Succesfully patched the pilet.json.`);
 }
 
@@ -567,6 +577,7 @@ export async function patchPiletPackage(
   log('generalDebug_0003', `Succesfully patched the package.json.`);
 
   await updateExistingJson(root, 'pilet.json', {
+    $schema: piletJsonSchemaUrl,
     piralInstances: {
       [name]: {},
     },

package/src/common/port.test.ts

@@ -4,7 +4,10 @@ const defaultPort = 12345;
 const error = Error('RangeError: Port should be >= 0 and < 65536.');
 
 jest.mock('../external', () => ({
-  getPort: (options: any) => {
+  ora() {
+    return {};
+  },
+  getPort(options: any) {
     if (options == undefined) {
       return Promise.resolve(defaultPort);
     } else if (options && options.port && options.port > 65536) {

package/src/common/rules.test.ts

@@ -1,5 +1,5 @@
 import { ruleSummary, runRules } from './rules';
-import chalk from 'chalk';
+import { chalk } from '../external';
 
 const rule = {
   run: jest.fn(),
@@ -13,9 +13,9 @@ describe('Rules Module', () => {
     };
     expect(runException).toThrow(Error('[0080] Validation failed. Found 1 error(s).'));
 
-    let consoleSpy = jest.spyOn(console, 'log');
+    let consoleSpy = jest.spyOn(process.stderr, 'write');
     ruleSummary([], []);
-    expect(consoleSpy).toHaveBeenCalledWith(`✨  ${chalk.green.bold('Validation successful. No errors or warnings.')}`);
+    expect(consoleSpy).toHaveBeenLastCalledWith(`${chalk.green('✔')} Validation successful. No errors or warnings.\n`);
 
     jest.clearAllMocks();
     ruleSummary([], ['Warning!']);

package/src/external/index.test.ts

@@ -1,4 +1,4 @@
-import * as externals from './index';
+import * as externals from '../external';
 
 describe('Externals module', () => {
   it('exports the FormData class', () => {
@@ -27,7 +27,7 @@ describe('Externals module', () => {
   });
 
   it('exports the logger module', () => {
-    const logger = externals.logger;
+    const logger = externals.ora;
     expect(logger).not.toBeUndefined();
   });
 

package/src/external/index.ts

@@ -1,5 +1,3 @@
-import logger = require('@parcel/logger');
-import stripAnsi = require('strip-ansi');
 import inquirer = require('inquirer');
 import jju = require('jju');
 import glob = require('glob');
@@ -10,5 +8,10 @@ import axios = require('axios');
 import mime = require('mime');
 import getPort = require('get-port');
 import open = require('open');
+import chalk = require('chalk');
 
-export { logger, inquirer, glob, tar, FormData, rc, axios, mime, stripAnsi, getPort, open, jju };
+import isInteractive from 'is-interactive';
+import ora from 'ora';
+import { getModulePath } from './resolve';
+
+export { chalk, inquirer, isInteractive, ora, glob, tar, FormData, rc, axios, mime, getPort, open, jju, getModulePath };

package/src/external/resolve.ts

@@ -0,0 +1,28 @@
+import * as fs from 'graceful-fs';
+import { ResolverFactory, CachedInputFileSystem } from 'enhanced-resolve';
+
+const nodeFileSystem = new CachedInputFileSystem(fs, 4000);
+
+const nodeContext = {
+  environments: ['node+es3+es5+process+native'],
+};
+
+const enhancedResolve = ResolverFactory.createResolver({
+  aliasFields: ['browser'],
+  conditionNames: ['import', 'module', 'webpack', 'development', 'browser'],
+  extensions: ['.js', '.jsx', '.mjs', '.ts', '.tsx', '.json'],
+  exportsFields: ['exports'],
+  importsFields: ['imports'],
+  mainFields: ['browser', 'module', 'main'],
+  fileSystem: nodeFileSystem,
+});
+
+export function getModulePath(root: string, moduleName: string) {
+  const res = enhancedResolve.resolveSync(nodeContext, root, moduleName);
+
+  if (!res) {
+    throw new Error(`Could not find module "${moduleName}".`);
+  }
+
+  return res;
+}