lucid-package 0.0.99 → 0.0.100

package/package.json

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

package/src/editorextension.d.ts

@@ -6,15 +6,17 @@ export declare function updateExtensionSDK(name: string): Promise<void>;
  * Uses webpack to watch for changes in the editor extension
  * @param name The editor extension name
  * @param quiet If true, will only show errors in output
+ * @param ignoreNodeModules If true, while serving, will not autoreload on changes to node_modules files
  */
-export declare function watchEditorExtension(name: string, isInternal: boolean, quiet?: boolean): Promise<{
+export declare function watchEditorExtension(name: string, isInternal: boolean, quiet?: boolean, ignoreNodeModules?: boolean): Promise<{
     name: string;
     compiler: Compiler;
 }>;
 /**
- * Runs the editor extensions and shape libraries in debug mode, including watching code for changes.
+ * Runs the editor extensions and shape libraries in debug mode, possibly including watching code for changes.
  * @param extensionNames The names of the editor extensions
  * @param quiet If true, will only show errors in output
+ * @param watchIgnoreNodeModules If true, while serving, will not autoreload on changes to node_modules files
  */
-export declare function debugEditorExtension(extensionNames: string[], isInternal: boolean, quiet?: boolean, pickAnyPort?: boolean): Promise<void>;
+export declare function debugEditorExtension(extensionNames: string[], isInternal: boolean, quiet?: boolean, pickAnyPort?: boolean, watchIgnoreNodeModules?: boolean): Promise<void>;
 export declare function getAllExtensionNames(): Promise<string[]>;

package/src/editorextension.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAllExtensionNames = exports.debugEditorExtension = exports.watchEditorExtension = exports.updateExtensionSDK = exports.buildEditorExtension = exports.createEditorExtension = void 0;
+const child_process_1 = require("child_process");
 const express = require("express");
 const oldFs = require("fs");
 const fs = require("fs/promises");
+const checks_1 = require("lucid-extension-sdk/sdk/core/checks");
 const path = require("path");
 const cors_1 = require("./cors");
 const filesystemutil_1 = require("./filesystemutil");
@@ -13,7 +15,6 @@ const packagemanifest_1 = require("./packagemanifest");
 const shapelibrary_1 = require("./shapelibrary");
 const shellutil_1 = require("./shellutil");
 const supportedproduct_1 = require("./supportedproduct");
-const child_process_1 = require("child_process");
 const theme_1 = require("./theme");
 const webpack = require('webpack');
 const WebPackCLI = require('webpack-cli');
@@ -64,8 +65,9 @@ exports.updateExtensionSDK = updateExtensionSDK;
  * Uses webpack to watch for changes in the editor extension
  * @param name The editor extension name
  * @param quiet If true, will only show errors in output
+ * @param ignoreNodeModules If true, while serving, will not autoreload on changes to node_modules files
  */
-async function watchEditorExtension(name, isInternal, quiet = false) {
+async function watchEditorExtension(name, isInternal, quiet = false, ignoreNodeModules = false) {
     const originalDirectory = process.cwd();
     const extensionCodePath = path.join('editorextensions', await getExtensionCodeDirectoryName(name));
     process.chdir(extensionCodePath);
@@ -77,8 +79,26 @@ async function watchEditorExtension(name, isInternal, quiet = false) {
     if (quiet) {
         webpackConfig.stats = 'errors-only';
     }
+    if (ignoreNodeModules) {
+        // It's possible that `ignored` isn't defined yet, or is a single object
+        // So if needed, we create and modify objects, so they can be added to
+        // (For more info: https://webpack.js.org/configuration/watch/#watchoptionsignored)
+        if (!(0, checks_1.isDef)(webpackConfig.watchOptions)) {
+            webpackConfig.watchOptions = {};
+        }
+        let directoriesToIgnore = webpackConfig.watchOptions.ignored;
+        if (!(0, checks_1.isDef)(directoriesToIgnore)) {
+            directoriesToIgnore = [];
+        }
+        if (!(0, checks_1.isArray)(directoriesToIgnore)) {
+            directoriesToIgnore = [directoriesToIgnore];
+        }
+        directoriesToIgnore = ['**/node_modules', ...directoriesToIgnore];
+        webpackConfig.watchOptions = { ...webpackConfig.watchOptions, ignored: directoriesToIgnore };
+    }
     const compiler = webpack(webpackConfig);
-    compiler.watch({}, (err, stats) => {
+    const watchOptions = webpackConfig.watchOptions ?? {};
+    compiler.watch(watchOptions, (err, stats) => {
         console.log(stats?.toString({ colors: true }));
     });
     process.chdir(originalDirectory);
@@ -86,13 +106,14 @@ async function watchEditorExtension(name, isInternal, quiet = false) {
 }
 exports.watchEditorExtension = watchEditorExtension;
 /**
- * Runs the editor extensions and shape libraries in debug mode, including watching code for changes.
+ * Runs the editor extensions and shape libraries in debug mode, possibly including watching code for changes.
  * @param extensionNames The names of the editor extensions
  * @param quiet If true, will only show errors in output
+ * @param watchIgnoreNodeModules If true, while serving, will not autoreload on changes to node_modules files
  */
-async function debugEditorExtension(extensionNames, isInternal, quiet = false, pickAnyPort = false) {
+async function debugEditorExtension(extensionNames, isInternal, quiet = false, pickAnyPort = false, watchIgnoreNodeModules = false) {
     const port = 9900;
-    const watchers = await Promise.all(extensionNames.map(async (name) => watchEditorExtension(name, isInternal, quiet)));
+    const watchers = await Promise.all(extensionNames.map(async (name) => watchEditorExtension(name, isInternal, quiet, watchIgnoreNodeModules)));
     startCustomUIServers(extensionNames);
     const app = express();
     const server = listen(app, port, pickAnyPort);
@@ -315,7 +336,7 @@ function getExtensionProducts(product, products) {
 async function getAllExtensionNames() {
     const manifest = await (0, packagemanifest_1.readManifest)('local');
     if (manifest.extensions) {
-        return manifest.extensions.map(extn => extn.name);
+        return manifest.extensions.map((extn) => extn.name);
     }
     else {
         return [];
@@ -325,7 +346,9 @@ exports.getAllExtensionNames = getAllExtensionNames;
 async function startCustomUIServers(extensionNames) {
     for (let extensionName of extensionNames) {
         const extensionCodePath = path.resolve(path.join('editorextensions', await getExtensionCodeDirectoryName(extensionName)));
-        const potentialCustomUIServer = (await fs.readdir(extensionCodePath, { withFileTypes: true })).filter(dirent => dirent.isDirectory()).map(dirent => path.join(extensionCodePath, dirent.name));
+        const potentialCustomUIServer = (await fs.readdir(extensionCodePath, { withFileTypes: true }))
+            .filter((dirent) => dirent.isDirectory())
+            .map((dirent) => path.join(extensionCodePath, dirent.name));
         for (let potentialPaths of potentialCustomUIServer) {
             runNpmStartIfExists(potentialPaths);
         }

package/src/index.js

@@ -79,6 +79,11 @@ class LucidSuiteExtensionCLI {
             action: 'store_true',
             help: argparse_1.SUPPRESS,
         });
+        testExtensionParser.add_argument('--watch-ignore-node-modules', {
+            default: false,
+            action: 'store_true',
+            help: 'Do not recompile extension when files in node_modules are changed',
+        });
         const watchExtensionParser = subparsers.add_parser('watch-editor-extension', {
             help: 'Compile an editor extension in debug mode',
         });
@@ -88,6 +93,11 @@ class LucidSuiteExtensionCLI {
             action: 'store_true',
             help: argparse_1.SUPPRESS,
         });
+        watchExtensionParser.add_argument('--watch-ignore-node-modules', {
+            default: false,
+            action: 'store_true',
+            help: 'Do not recompile extension when files in node_modules are changed',
+        });
         const testShapeLibraries = subparsers.add_parser('test-shape-libraries', {
             help: 'Serve any shape libraries in this package at localhost:9901. Watch for changes to the code and live-update as needed',
         });
@@ -228,7 +238,7 @@ class LucidSuiteExtensionCLI {
                             if (parsed['name'].length === 0) {
                                 parsed['name'] = await (0, editorextension_1.getAllExtensionNames)();
                             }
-                            await (0, editorextension_1.debugEditorExtension)(parsed['name'], isInternal, parsed['quiet'], parsed['anyport']);
+                            await (0, editorextension_1.debugEditorExtension)(parsed['name'], isInternal, parsed['quiet'], parsed['anyport'], parsed['watch_ignore_node_modules']);
                             break;
                         case 'watch-editor-extension':
                             await (0, editorextension_1.watchEditorExtension)(parsed['name'], isInternal, parsed['quiet']);