Add --canister / -c flag to select specific Motoko canisters (#39)

* Add '--canister' / '-c' flag * Implement '-c' flag * 0.10.0
dfinity · Jun 6, 2023 · 0f0ff1a · 0f0ff1a
1 parent 31950ae
commit 0f0ff1a
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 6 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "mo-dev",
-    "version": "0.9.0",
+    "version": "0.10.0",
     "description": "A live reload development server for Motoko smart contracts.",
     "author": "DFINITY Foundation (https://dfinity.org)",
     "license": "Apache-2.0",

diff --git a/src/commands/mo-dev.ts b/src/commands/mo-dev.ts
@@ -11,12 +11,15 @@ const testModes: TestMode[] = [];
 const addTestMode = (mode: string) => testModes.push(asTestMode(mode));
 const testFiles: string[] = [];
 const addTestFile = (file: string) => testFiles.push(file);
+const canisterNames: string[] = [];
+const addCanisterName = (name: string) => canisterNames.push(name);
 
 const examples: [string, string][] = [
-    ['-r', 'redeploy canisters on file change'],
-    ['-d', 'upgrade canisters on file change'],
+    ['-d', 'redeploy canisters on file change'],
+    ['-d -y', 'upgrade canisters on file change'],
     ['-g', 'generate TypeScript bindings on file change'],
     ['-t', 'run unit tests on file change'],
+    ['-r -c foo_canister -c bar_canister', 'redeploy `foo_canister` and `bar_canister` on file change'],
 ];
 
 const {
@@ -30,7 +33,6 @@ const {
     test,
     yes,
     hotReload,
-    ci,
 } = program
     .name('mo-dev')
     .description(
@@ -55,6 +57,11 @@ const {
         `only run tests with the given file name prefix`,
         addTestFile,
     )
+    .option(
+        '-c, --canister <canister>',
+        `use the given Motoko canister`,
+        addCanisterName,
+    )
     .option(
         '-y, --yes',
         `respond "yes" to reinstall prompts (may reset canister state)`,
@@ -93,6 +100,7 @@ const settings: Settings = {
     test: !!test || defaultSettings.test,
     testModes: testModes.length ? testModes : defaultSettings.testModes,
     testFiles: testFiles.length ? testFiles : defaultSettings.testModes,
+    canisterNames: canisterNames.length ? canisterNames : defaultSettings.canisterNames,
     reinstall: !!yes || defaultSettings.reinstall,
     hotReload: !!hotReload || defaultSettings.hotReload,
     // ci: !!ci || defaultSettings.ci,

diff --git a/src/settings.ts b/src/settings.ts
@@ -13,6 +13,7 @@ export interface Settings {
     test: boolean;
     testModes: TestMode[];
     testFiles: string[];
+    canisterNames: string[];
     reinstall: boolean;
     hotReload: boolean;
     ci: boolean;
@@ -29,6 +30,7 @@ export const defaultSettings: Settings = {
     test: false,
     testModes: ['interpreter'],
     testFiles: [],
+    canisterNames: [],
     reinstall: false,
     hotReload: false,
     ci: process.env.CI && process.env.CI !== '0' && process.env.CI !== 'false',

diff --git a/src/watch.ts b/src/watch.ts
@@ -123,6 +123,34 @@ export async function watch(settings: Settings) {
                 return;
             }
             canisters = getDfxCanisters(directory, dfxConfig);
+            if (settings.canisterNames.length) {
+                const showExpected = settings.canisterNames.some((name) => {
+                    if (!canisters.some((c) => name === c.alias)) {
+                        log(
+                            0,
+                            'unexpected canister:',
+                            pc.yellow(pc.bold(name)),
+                        );
+                        return true;
+                    }
+                });
+                if (showExpected) {
+                    log(
+                        0,
+                        `options:`,
+                        pc.gray(
+                            canisters
+                                .map((c) => pc.bold(pc.green(c.alias)))
+                                .join(', '),
+                        ),
+                    );
+                }
+                canisters = canisters.filter((canister) =>
+                    settings.canisterNames.some(
+                        (name) => name === canister.alias,
+                    ),
+                );
+            }
         } catch (err) {
             console.error(
                 `Error while loading 'dfx.json' file:\n${err.message || err}`,