Deployment change and autocomplete for Principal type #298
Conversation
…omplete-for-princiapal deployment change and autocomplete for principal
|
Dear @mmyslblocky, In order to potentially merge your code in this open-source repository and therefore proceed with your contribution, we need to have your approval on DFINITY's CLA. If you decide to agree with it, please visit this issue and read the instructions there. Once you have signed it, re-trigger the workflow on this PR to see if your code can be merged. — The DFINITY Foundation |
.vscode/launch.json
Outdated
| @@ -8,6 +8,8 @@ | |||
| "runtimeExecutable": "${execPath}", | |||
| "args": ["--extensionDevelopmentPath=${workspaceFolder}"], | |||
| "outFiles": ["${workspaceFolder}/out/**/*.js"], | |||
| "stopOnEntry": false, | |||
There was a problem hiding this comment.
Locally, I get a warning message saying "Property stopOnEntry is not allowed." Would it be possible to remove this, or is this important for development on your end?
| "stopOnEntry": false, |
There was a problem hiding this comment.
yes, sorry, I put this for test purpose of this extension only. I will remove it from PR
package.json
Outdated
| "title": "Motoko: Start local replica..." | ||
| }, | ||
| { | ||
| "command": "motoko.deployLocalSelection", | ||
| "title": "Motoko: Deploy (local node)..." | ||
| }, | ||
| { | ||
| "command": "motoko.candidLocalSelection", | ||
| "title": "Motoko: Open Candid UI for canister (local node)..." | ||
| }, | ||
| { | ||
| "command": "motoko.candidPlaygroundSelection", | ||
| "title": "Motoko: Open Candid UI for canister (playground)..." |
There was a problem hiding this comment.
For context, the ... suffix is used in this extension to indicate that you'll see a dropdown menu after selecting this command. Here are some suggested changes to the command titles:
| "title": "Motoko: Start local replica..." | |
| }, | |
| { | |
| "command": "motoko.deployLocalSelection", | |
| "title": "Motoko: Deploy (local node)..." | |
| }, | |
| { | |
| "command": "motoko.candidLocalSelection", | |
| "title": "Motoko: Open Candid UI for canister (local node)..." | |
| }, | |
| { | |
| "command": "motoko.candidPlaygroundSelection", | |
| "title": "Motoko: Open Candid UI for canister (playground)..." | |
| "title": "Motoko: Start local replica" | |
| }, | |
| { | |
| "command": "motoko.deployLocalSelection", | |
| "title": "Motoko: Deploy (local replica)..." | |
| }, | |
| { | |
| "command": "motoko.candidLocalSelection", | |
| "title": "Motoko: Open Candid UI for canister (local replica)..." | |
| }, | |
| { | |
| "command": "motoko.candidPlaygroundSelection", | |
| "title": "Motoko: Open Candid UI for canister (playground)..." |
| }), | ||
| ); | ||
| context.subscriptions.push( | ||
| commands.registerCommand('motoko.startReplica', async () => { |
There was a problem hiding this comment.
Maybe we could also include a motoko.stopReplica command for completeness?
src/extension.ts
Outdated
| dfx build ${canisterName ? canisterName : ''} && | ||
| dfx deploy ${ | ||
| canisterName ? canisterName : '' | ||
| } --playground`, |
There was a problem hiding this comment.
For readability / conciseness:
| dfx build ${canisterName ? canisterName : ''} && | |
| dfx deploy ${ | |
| canisterName ? canisterName : '' | |
| } --playground`, | |
| dfx build ${canisterName || ''} && | |
| dfx deploy ${canisterName || ''} --playground`, |
src/extension.ts
Outdated
| placeHolder: 'Select canister to deploy', | ||
| }); | ||
|
|
||
| if (selection === 'All') { |
There was a problem hiding this comment.
It might be worth changing this logic to account for the possibility of a canister being named All, which is unlikely but possible.
src/server/candidAddressProvider.ts
Outdated
| @@ -0,0 +1,69 @@ | |||
| import * as vscode from 'vscode'; | |||
| import * as fs from 'fs'; | |||
There was a problem hiding this comment.
I would encourage using the fs/promises API to avoid latency during I/O operations.
src/server/canisterNames.ts
Outdated
| @@ -0,0 +1,51 @@ | |||
| import * as vscode from 'vscode'; | |||
| import * as fs from 'fs'; | |||
There was a problem hiding this comment.
Same as above about using the fs/promises API.
| @@ -1398,6 +1428,105 @@ connection.onDocumentSymbol((event) => { | |||
| return results; | |||
| }); | |||
|
|
|||
| function addPrincipalAutocomplete( | |||
There was a problem hiding this comment.
It would be good to eventually generalize this to all base library modules. I tested this and it seems to work as expected, so we could probably keep the hard-coded autocompletions for the time being.
… first option with empty string for deployment of all canisters
…omplete-for-princiapal review remarks
|
I think I adjusted the code to your review remarks, so you can verify these changes. I also signed the CLA agreement |
|
Thank you for the updates. We are still deciding whether it makes sense to include these changes, since adding a dependency on The other question is whether we want to implement a more systematic autocompletion for all imports rather than just |
We changed the method of deploying canisters via extension from sending the canister code in motoko to playground Deployer Canister and instead we added deployment through CLI by sending deployment commands to vscode terminal. We also added functionality to start local replica and deploy canisters to local node. The minor drawback of our solution is that we cannot automatically open Candid UI when canister deployment is finished because we VSCode Terminal API does not support reading output so we need to manually open Candid UI after deployment of canister is finished by selecting this option.
We've added auto complete for Principal primitive type and for shared function principal argument. There's suggestion for every available Principal method with short description.