Add --deploy flag to specify installation arguments (#49)

* Add '--argument' flag for `dfx deploy` * Set up defaults for deployArgs * Implement deploy args * 0.10.1 * Update readme * Reformat * 0.11.0
dfinity · Jul 5, 2023 · 6ca688b · 6ca688b
1 parent 223b60f
commit 6ca688b
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -78,6 +78,12 @@ Only run the dev server for specific canisters (`--canister` or `-c`):
 mo-dev --canister foo --canister bar --deploy
 ```
 
+Pass an installation argument to `dfx deploy` (`--argument` or `-a`):
+
+```sh
+mo-dev --deploy --argument '()'
+```
+
 ## Advanced Features
 
 Show additional debug output in the console (`--verbose` or `-v`):

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.10.0",
+    "version": "0.11.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
@@ -9,17 +9,25 @@ const increaseVerbosity = () => verbosity++;
 
 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 deployArgs: string[] = [];
+const addDeployArg = (arg: string) => deployArgs.push(arg);
+
 const examples: [string, string][] = [
     ['-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'],
+    [
+        '-r -c foo_canister -c bar_canister',
+        'redeploy `foo_canister` and `bar_canister` on file change',
+    ],
 ];
 
 const {
@@ -62,6 +70,11 @@ const {
         `use the given Motoko canister`,
         addCanisterName,
     )
+    .option(
+        '-a, --argument <arg>',
+        `pass an install argument to \`dfx deploy\``,
+        addDeployArg,
+    )
     .option(
         '-y, --yes',
         `respond "yes" to reinstall prompts (may reset canister state)`,
@@ -97,10 +110,13 @@ const settings: Settings = {
     verbosity,
     generate: !!generate || defaultSettings.generate,
     deploy: !!deploy || defaultSettings.deploy,
+    deployArgs: deployArgs.length ? deployArgs : defaultSettings.deployArgs,
     test: !!test || defaultSettings.test,
     testModes: testModes.length ? testModes : defaultSettings.testModes,
     testFiles: testFiles.length ? testFiles : defaultSettings.testFiles,
-    canisterNames: canisterNames.length ? canisterNames : defaultSettings.canisterNames,
+    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
@@ -10,6 +10,7 @@ export interface Settings {
     verbosity: number;
     generate: boolean;
     deploy: boolean;
+    deployArgs: string[];
     test: boolean;
     testModes: TestMode[];
     testFiles: string[];
@@ -27,6 +28,7 @@ export const defaultSettings: Settings = {
     verbosity: 0,
     generate: false,
     deploy: false,
+    deployArgs: [],
     test: false,
     testModes: ['interpreter'],
     testFiles: [],

diff --git a/src/watch.ts b/src/watch.ts
@@ -73,6 +73,11 @@ export async function watch(settings: Settings) {
         hotReload,
     } = settings;
 
+    const deployArgs: string[] = [];
+    settings.deployArgs.forEach((arg) => {
+        deployArgs.push('--argument', arg);
+    });
+
     const log = (level: number, ...args: any[]) => {
         if (verbosity >= level) {
             const time = new Date().toLocaleTimeString();
@@ -187,6 +192,7 @@ export async function watch(settings: Settings) {
                             });
                         }
                     });
+                    // TODO: handle deploy args
                     dependencies.forEach((alias) => {
                         log(0, pc.green('prepare'), pc.gray(alias));
                         runDfx(['deploy', alias], 1);
@@ -202,6 +208,7 @@ export async function watch(settings: Settings) {
                                 'deploy',
                                 canister.alias,
                                 ...(reinstall ? ['-y'] : []),
+                                ...deployArgs,
                             ],
                             1,
                         );
@@ -402,6 +409,7 @@ export async function watch(settings: Settings) {
                                     canister.alias,
                                     ...(verbosity >= 1 ? [] : ['-qq']),
                                     ...(reinstall ? ['-y'] : []),
+                                    ...deployArgs,
                                 ],
                                 // TODO: hide 'Module hash ... is already installed' warnings
                                 pipe: pipe || !reinstall,