Add SFDX: Create LWC Bundle command #277

vazexqi · 2018-01-27T02:30:29Z

What does this PR do?

Refactors the dependencies from salesforcedx-vscode-core to make it more shareable to other commands
Introduces the "SFDX: Create LWC Bundle" command to the command palette and right-click menu.

What issues does this PR fix or reference?

@W-4642992, W-4326859@

vazexqi · 2018-01-27T02:30:57Z

packages/salesforcedx-utils-vscode/src/types/index.ts

@@ -0,0 +1,41 @@
+/*


I moved all the command type declarations into salesforcedx-utils-vscode so we can share them.

vazexqi · 2018-01-27T02:31:23Z

packages/salesforcedx-vscode-core/src/commands/commands.ts

@@ -10,6 +10,14 @@ import {
  Command,
  CommandExecution
 } from '@salesforce/salesforcedx-utils-vscode/out/src/cli';
+import {


So, now we import them from the salesforcedx-utils-vscode package.

vazexqi · 2018-01-27T02:32:33Z

packages/salesforcedx-vscode-core/src/index.ts

@@ -265,6 +273,21 @@ export async function activate(context: vscode.ExtensionContext) {
    scratchOrgDecorator.showOrg();
    scratchOrgDecorator.monitorConfigChanges();
  }
+
+  const api: any = {


We export these using https://code.visualstudio.com/docs/extensionAPI/vscode-api#_extensions

@DatGuyJonathan - I was deciding between the way we discussed and this way. Ultimately I felt this was better since it is more scalable. If we have other packages in the future, we want to allow them to add it in their package and not pollute core.

vazexqi · 2018-01-27T02:33:03Z

packages/salesforcedx-vscode-core/src/index.ts

+    SfdxCommandlet,
+    SfdxCommandletExecutor,
+    SfdxWorkspaceChecker,
+    channelService,


By exporting the singleton services, we ensure that there is only one instance of it so we won't have any weird behavior.

Had we somehow made what Gunnar was trying to do in microsoft/vscode-vsce#207 it still might not have worked because we lose the singleton-ness of the service and you could have multiple of the services activating.

vazexqi · 2018-01-27T02:33:54Z

packages/salesforcedx-vscode-lwc/src/commands/forceLightningLwcCreate.ts

+import * as vscode from 'vscode';
+import { nls } from '../messages';
+
+const sfdxCoreExports = vscode.extensions.getExtension(


Here is how we import it.
The downside of this is that all of these things are exported as any so we lose the type safety... 😞

vazexqi · 2018-01-27T02:34:30Z

packages/salesforcedx-vscode-lwc/src/messages/i18n.ts

+ *
+ * If ommitted, we will assume _message.
+ */
+export const messages = {


@ruthemmanuelle - These are the customer facing text. I followed what we had for lightning.

Looks good, @vazexqi . I added one comment.

vazexqi · 2018-01-27T02:35:15Z

@Sweetman - Just a headsup since this affects #264 and the way we discussed.

codecov · 2018-01-27T05:30:04Z

Codecov Report

Merging #277 into develop will increase coverage by 6.97%.
The diff coverage is 59.09%.

@@             Coverage Diff             @@
##           develop     #277      +/-   ##
===========================================
+ Coverage    75.07%   82.04%   +6.97%     
===========================================
  Files          116      134      +18     
  Lines         4414     5025     +611     
  Branches       728      833     +105     
===========================================
+ Hits          3314     4123     +809     
+ Misses         915      724     -191     
+ Partials       185      178       -7

Impacted Files	Coverage Δ
...rcedx-vscode-core/src/commands/forceApexExecute.ts	`89.58% <ø> (+89.58%)`	⬆️
...forcedx-vscode-core/src/commands/forceOrgCreate.ts	`79.16% <ø> (-11.31%)`	⬇️
...core/src/commands/forceLightningComponentCreate.ts	`100% <ø> (+100%)`	⬆️
...vscode-core/src/commands/forceApexTriggerCreate.ts	`42.85% <ø> (-5.53%)`	⬇️
...re/src/commands/forceVisualforceComponentCreate.ts	`100% <ø> (+100%)`	⬆️
...de-core/src/commands/forceVisualforcePageCreate.ts	`100% <ø> (+100%)`	⬆️
...ode-core/src/commands/forceLightningEventCreate.ts	`100% <ø> (+100%)`	⬆️
...ges/salesforcedx-vscode-core/src/channels/index.ts	`100% <ø> (ø)`	⬆️
...ages/salesforcedx-vscode-core/src/messages/i18n.ts	`100% <ø> (ø)`
...cedx-vscode-core/src/commands/forceDebuggerStop.ts	`77.27% <ø> (-14.62%)`	⬇️
... and 67 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ab73f4...adb9858. Read the comment docs.

vazexqi · 2018-01-27T16:14:48Z

packages/salesforcedx-vscode-lwc/src/index.ts

+  return vscode.Disposable.from(forceLightningLwcCreateCmd);
+}
+
+export async function activate(context: vscode.ExtensionContext) {


🐛 - I have to be careful while activating this command. It's actually possible for an extension to be installed without any of its extension-dependencies being installed (e.g, the user doesn't say install all dependencies, the user forcibly deletes the dependencies after, etc).

I need to have a check here for to ensure we don't activate if salesforcedx.salesforcedx-vscode-core exists and it has the api exported.

This is a bit more crucial because of the way the forceLightningLwcCreate gets its dependencies since the series of const on the top of that file.

*In the future, forceLightningLwcCreate is likely to move back into salesforcedx-vscode-core with the other create commands but for the time being, it's important to put it under here.

vazexqi · 2018-01-27T16:20:34Z

packages/salesforcedx-vscode-lwc/src/commands/forceLightningLwcCreate.ts

+  }
+}
+
+class ForceLightningLwcCreateExecutor extends (SfdxCommandletExecutor as {


This syntax is because of microsoft/TypeScript#17032

vazexqi · 2018-01-27T16:47:25Z

packages/salesforcedx-vscode-lwc/src/commands/forceLightningLwcCreate.ts

+const fileNameGatherer = new SelectFileName();
+const lightningFilePathExistsChecker = new LightningFilePathExistsChecker();
+
+export async function forceLightningLwcCreate(explorerDir?: any) {


🎗 I cannot write a test (that will pass on our CI) for this until the next force-language-services@pre-release/release goes out since it has a dependency on that. The sfdx force:lightning:lwc:create command is in there. That is not going to happen until next week.

ruthemmanuelle · 2018-01-29T18:58:35Z

packages/salesforcedx-vscode-lwc/src/messages/i18n.ts

+  warning_prompt_lightning_bundle_overwrite:
+    'An LWC bundle with the specified path already exists in your workspace. Do you want to overwrite any existing files in this bundle?',
+  warning_prompt_yes: 'Yes',
+  warning_prompt_no: 'No'


Can we change these from 'Yes' and 'No' to 'Overwrite' and 'Cancel'? We try to be as specific as possible about these confirmations, since people often just skim the text and don't necessarily realize what they're agreeing to.

Yes. The text was taken from the other scaffolding commands. I'll make those changes over there as well. Specifically, I will create a newconfirm_overwrite_text

This allows us to export the singletons and classes to the other modules. See https://code.visualstudio.com/docs/extensionAPI/vscode-api#_extensions

DatGuyJonathan · 2018-01-29T20:23:30Z

packages/salesforcedx-vscode-core/package.json

@@ -83,35 +83,43 @@
      "explorer/context": [
        {
          "command": "sfdx.force.apex.class.create",
-          "when": "explorerResourceIsFolder && sfdx:project_opened"
+          "when":
+            "explorerResourceIsFolder && resourceFilename != aura && resourceFilename != lightningcomponents && sfdx:project_opened"


It would be nice if we could create a re-usable compound when-clause. I don't think they have that support yet though.

sjurgis · 2018-06-30T20:19:23Z

What's a LWC bundle?

vazexqi requested review from Sweetman and DatGuyJonathan January 27, 2018 02:30

vazexqi commented Jan 27, 2018

View reviewed changes

ruthemmanuelle reviewed Jan 29, 2018

View reviewed changes

Nick Chen added 7 commits January 29, 2018 11:39

Refactor dependencies to facilitate reuse

87d080d

This allows us to export the singletons and classes to the other modules. See https://code.visualstudio.com/docs/extensionAPI/vscode-api#_extensions

Add SFDX: Create LWC Bundle command

9a0d293

Fix linting error

80c0a21

Reformat package.json

449e24a

Tighten checks around salesforcedx-vscode-core dependency

17f2190

Make context menu more context aware

c1f7f92

Tighten up message to say 'Overwrite'

0b8db1c

vazexqi force-pushed the nick/add-lwc-create-command branch from bb5b606 to 0b8db1c Compare January 29, 2018 20:16

DatGuyJonathan reviewed Jan 29, 2018

View reviewed changes

DatGuyJonathan approved these changes Jan 29, 2018

View reviewed changes

Sweetman approved these changes Jan 29, 2018

View reviewed changes

ruthemmanuelle approved these changes Jan 29, 2018

View reviewed changes

Fix test failures

adb9858

vazexqi merged commit 5eb8a1e into develop Jan 30, 2018

vazexqi deleted the nick/add-lwc-create-command branch January 30, 2018 01:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SFDX: Create LWC Bundle command #277

Add SFDX: Create LWC Bundle command #277

vazexqi commented Jan 27, 2018 •

edited

Loading

vazexqi Jan 27, 2018

vazexqi Jan 27, 2018

vazexqi Jan 27, 2018

vazexqi Jan 27, 2018 •

edited

Loading

vazexqi Jan 27, 2018

vazexqi Jan 27, 2018

ruthemmanuelle Jan 29, 2018

vazexqi commented Jan 27, 2018

codecov bot commented Jan 27, 2018 •

edited

Loading

vazexqi Jan 27, 2018

vazexqi Jan 27, 2018

vazexqi Jan 27, 2018

ruthemmanuelle Jan 29, 2018

vazexqi Jan 29, 2018

DatGuyJonathan Jan 29, 2018

sjurgis commented Jun 30, 2018

Add SFDX: Create LWC Bundle command #277

Add SFDX: Create LWC Bundle command #277

Conversation

vazexqi commented Jan 27, 2018 • edited Loading

What does this PR do?

What issues does this PR fix or reference?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vazexqi Jan 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vazexqi commented Jan 27, 2018

codecov bot commented Jan 27, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjurgis commented Jun 30, 2018

vazexqi commented Jan 27, 2018 •

edited

Loading

vazexqi Jan 27, 2018 •

edited

Loading

codecov bot commented Jan 27, 2018 •

edited

Loading