lucid-package 0.0.103 → 0.0.107

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.103",
+    "version": "0.0.107",
     "description": "",
     "main": "index.js",
     "bin": {

package/src/editorextension.d.ts

@@ -1,6 +1,6 @@
 import { Compiler } from 'webpack';
 export declare function createEditorExtension(name: string, isInternal: boolean, skipSDKDependency: boolean, source?: string, deps?: string[]): Promise<void>;
-export declare function buildEditorExtension(name: string, isInternal: boolean, quiet?: boolean): Promise<void>;
+export declare function buildEditorExtension(name: string, isInternal: boolean, quiet?: boolean, skipSdkDependency?: boolean): Promise<void>;
 export declare function updateExtensionSDK(name: string): Promise<void>;
 /**
  * Uses webpack to watch for changes in the editor extension

package/src/editorextension.js

@@ -46,10 +46,10 @@ async function createEditorExtension(name, isInternal, skipSDKDependency, source
     (0, installationutil_1.installDependenciesIfNeeded)(isInternal, skipSDKDependency, deps);
 }
 exports.createEditorExtension = createEditorExtension;
-async function buildEditorExtension(name, isInternal, quiet = false) {
+async function buildEditorExtension(name, isInternal, quiet = false, skipSdkDependency = false) {
     const extensionCodePath = path.join('editorextensions', await getExtensionCodeDirectoryName(name));
     process.chdir(extensionCodePath);
-    (0, installationutil_1.installDependenciesIfNeeded)(isInternal);
+    (0, installationutil_1.installDependenciesIfNeeded)(isInternal, skipSdkDependency);
     const cli = new WebPackCLI();
     await cli.run(['node', 'webpack', '--mode', 'production', ...(quiet ? ['--stats', 'errors-only'] : [])]);
 }
@@ -292,7 +292,7 @@ async function getExtensionManifest(name) {
 async function getExtensionCodeDirectoryName(name) {
     const extensionManifest = (await getExtensionManifest(name)).extensionManifest;
     const codePath = extensionManifest?.['codePath'];
-    return codePath ? (await getExtensionCodeDirectoryNameFromCodePath(codePath)) ?? name : name;
+    return codePath ? ((await getExtensionCodeDirectoryNameFromCodePath(codePath)) ?? name) : name;
 }
 /**
  * Our codePath has the form '/editorextensions/{extensionName}/bin/extension.js'. This function returns the
@@ -308,7 +308,7 @@ async function getExtensionCodeDirectoryNameFromCodePath(codePath) {
 async function getRawEditorExtension(name, port) {
     const { manifest, extensionManifest } = await getExtensionManifest(name);
     const codePath = extensionManifest?.['codePath'];
-    const directory = codePath ? (await getExtensionCodeDirectoryNameFromCodePath(codePath)) ?? name : name;
+    const directory = codePath ? ((await getExtensionCodeDirectoryNameFromCodePath(codePath)) ?? name) : name;
     const products = extensionManifest
         ? getExtensionProducts(extensionManifest['product'], extensionManifest['products'])
         : [supportedproduct_1.SupportedProduct.Chart];

package/src/index.js

@@ -44,6 +44,11 @@ class LucidSuiteExtensionCLI {
         packageParser.add_argument('--env', {
             help: 'Provide the environment to define which manifest.<env>.json is combined with manifest.json when bundling. If not provided, uses manifest.json only.',
         });
+        packageParser.add_argument('--skip-sdk', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const updateSDKParser = subparsers.add_parser('update-sdk', {
             help: 'Update the editor extension SDK to the latest published version for all editor extensions in this package',
         });
@@ -65,6 +70,11 @@ class LucidSuiteExtensionCLI {
             action: 'store_true',
             help: argparse_1.SUPPRESS,
         });
+        buildExtensionParser.add_argument('--skip-sdk', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const testExtensionParser = subparsers.add_parser('test-editor-extension', {
             help: 'Compile one or more editor extensions in debug mode, and serve them at localhost:9900, along with any shape libraries in this package at localhost:9901. Watch for changes to the code and recompile as needed',
         });
@@ -204,7 +214,7 @@ class LucidSuiteExtensionCLI {
                 else {
                     switch (parsed['command']) {
                         case 'bundle':
-                            await (0, package_1.writePackage)(parsed['quiet'], parsed['env']);
+                            await (0, package_1.writePackage)(parsed['quiet'], parsed['env'], parsed['skip_sdk']);
                             break;
                         case 'update-sdk':
                             await (0, package_1.updateAllExtensionSDK)();
@@ -213,7 +223,7 @@ class LucidSuiteExtensionCLI {
                             await (0, editorextension_1.createEditorExtension)(parsed['name'], isInternal, parsed['skip_sdk']);
                             break;
                         case 'build-editor-extension':
-                            await (0, editorextension_1.buildEditorExtension)(parsed['name'], isInternal, parsed['quiet']);
+                            await (0, editorextension_1.buildEditorExtension)(parsed['name'], isInternal, parsed['quiet'], parsed['skip_sdk']);
                             break;
                         case 'create-shape-library':
                             await (0, shapelibrary_1.createEmptyShapeLibrary)(parsed['name']);

package/src/installationutil.js

@@ -15,6 +15,8 @@ function installDependenciesIfNeeded(isInternal, skipSDKDependency = false, addi
         (0, shellutil_1.execSyncLoggingOutputOnError)(`rm -rf ${sdkDir}`);
     }
     else if (!oldFs.existsSync(sdkDir) && !skipSDKDependency) {
+        // Otherwise, install the NPM version of the SDK directly. If you would like to opt out of this you can use the
+        // `--skip-sdk` CLI flag.
         console.log((0, theme_1.success)('Adding dependency on SDK'));
         console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --save lucid-extension-sdk').toString());
     }

package/src/package.d.ts

@@ -8,4 +8,4 @@ export declare function updateAllExtensionSDK(): Promise<void>;
  *
  * @param manifestOverrideEnv The environment definine what manifest to read from. `manifest.env.json`
  */
-export declare function writePackage(quiet?: boolean, manifestOverrideEnv?: string): Promise<void>;
+export declare function writePackage(quiet?: boolean, manifestOverrideEnv?: string, skipSdkDependency?: boolean): Promise<void>;

package/src/package.js

@@ -58,7 +58,7 @@ exports.updateAllExtensionSDK = updateAllExtensionSDK;
  *
  * @param manifestOverrideEnv The environment definine what manifest to read from. `manifest.env.json`
  */
-async function writePackage(quiet = false, manifestOverrideEnv) {
+async function writePackage(quiet = false, manifestOverrideEnv, skipSdkDependency = false) {
     const zip = new JSZip();
     const quietableConsoleLog = (...data) => {
         if (!quiet) {
@@ -95,11 +95,12 @@ async function writePackage(quiet = false, manifestOverrideEnv) {
                     process.argv[1] +
                     '" build-editor-extension ' +
                     (quiet ? '--quiet ' : '') +
+                    (skipSdkDependency ? '--skip-sdk ' : '') +
                     '"' +
                     parts[1] +
                     '"';
                 quietableConsoleLog(cmd);
-                quietableConsoleLog((0, shellutil_1.execSyncLoggingOutputOnError)(cmd, quiet = quiet).toString());
+                quietableConsoleLog((0, shellutil_1.execSyncLoggingOutputOnError)(cmd, (quiet = quiet)).toString());
             }
             zip.file(extension['codePath'], await fs.readFile(extension['codePath']));
         }

package/templates/editorextension/angular/skeleton/webpack.config.js

@@ -28,21 +28,27 @@ module.exports = {
     },
     plugins: [
         new WebpackShellPluginNext({
-            //When doing a watch build, run "ng serve" and update the html file to prefix http://localhost:4200/ to all the resource URLs
+            // Run during execution of `npx lucid-package@latest test-editor-extension`.
+            // When doing a watch build, the user must manually first run "ng serve".
+            // Then, this script will update the html file to prefix http://localhost:4200/ to all the resource URLs
             onWatchRun: {
                 scripts: angularTargets.map(
                     (target) =>
-                        `mkdir -p ../../public/${target.name} &&` +
+                        // Executed by WebpackShellPluginNext, from within the package's root level directory.
+                        `mkdir -p public/${target.name} &&` +
                         `curl http://localhost:${target.port} | ` +
                         `sed -E "s/(src|href)=\\"/\\\\1=\\"http:\\/\\/localhost:${target.port}\\//gi" > ` +
-                        `../../public/${target.name}/index.html`,
+                        `public/${target.name}/index.html`,
                 ),
                 blocking: true,
             },
-            //When doing a full build, run "ng build" and then copy all the assets to the root level public folder
+            // Run during execution of `npx lucid-package@latest bundle`.
+            // When doing a full build, this script will automatically run "ng build"
+            // and then copy all the assets to the root level public folder
             onBeforeNormalRun: {
                 scripts: angularTargets.map(
                     (target) =>
+                        // Executed by WebpackShellPluginNext from within each _extension's_ directory.
                         `mkdir -p ../../public/${target.name} &&` +
                         `cd ${target.name} && ` +
                         // `npx ng build` usually works, but this is more reliable when used with build tools such as bazel

package/templates/editorextension/react/skeleton/webpack.config.js

@@ -28,21 +28,27 @@ module.exports = {
     },
     plugins: [
         new WebpackShellPluginNext({
-            //When doing a watch build, run "npm start" and update the html file to prefix http://localhost:3000/ to all the resource URLs
+            // Run during execution of `npx lucid-package@latest test-editor-extension`.
+            // When doing a watch build, the user must manually first run "npm start".
+            // Then, this script will update the html file to prefix http://localhost:3000/ to all the resource URLs
             onWatchRun: {
                 scripts: reactTargets.map(
                     (target) =>
-                        `mkdir -p ../../public/${target.name} &&` +
+                        // Executed by WebpackShellPluginNext, from within the package's root level directory.
+                        `mkdir -p public/${target.name} &&` +
                         `curl http://localhost:${target.port} | ` +
                         `sed -E "s/(src|href)=\\"/\\\\1=\\"http:\\/\\/localhost:${target.port}\/gi" > ` +
-                        `../../public/${target.name}/index.html`,
+                        `public/${target.name}/index.html`,
                 ),
                 blocking: true,
             },
-            // When doing a full build, run "npm run build" and then copy all the assets to the root level public folder
+            // Run during execution of `npx lucid-package@latest bundle`.
+            // When doing a full build, this script will automatically run "npm run build"
+            // and then copy all the assets to the root level public folder
             onBeforeNormalRun: {
                 scripts: reactTargets.map(
                     (target) =>
+                        // Executed by WebpackShellPluginNext from within each _extension's_ directory.
                         `mkdir -p ../../public/${target.name} &&` +
                         `cd ${target.name} && ` +
                         `npm run build && ` +