[rush] VSCode Extension #3162

chengcyber · 2022-01-16T15:00:59Z

Summary

RushStack VSCode Extention

Details

How to develop in local

Prepare

rush update
rush build --to rushstack

Run predefined launcher in your VSCode

Play in Extension Host

a [Extension Development Host] window should popup if everything works fine. Open a rush project now

How to pack a production version and install it locally

Run the following command, a vsix format file called "rushstack-0.0.0.vsix" will be generated.

cd vsce/vscode-extension
rushx package

Run code --install-extension rushstack-0.0.0.vsix to install the prod version of rushstack vscode extension
Run code --uninstall-extension rushstack to uninstall it

Recipe: code --uninstall-extension rushstack || true && code --install-extension rushstack-0.0.0.vsix

chengcyber · 2022-03-03T10:04:52Z

Questions 2022/3/3

The way to get RushConfiguration and RushCommandLineParser
1.1 RushConfiguration is used to extract projects.
1.2 RushCommandLineParser is used to extract Rush commands and parameters
For now, the idea is leverage rush-sdk, making rush-sdk supports reload from another location, may related with [rush] Refactor rush-sdk to expose a loader API. #3212
rush add is a smart CLI, it uses the working directory (cwd) to decide the target project where the package should be installed to. It can be hardcode in Extension side like rush add push a project selector, or involving sth like a parameter configuration to make it as a canonical use case.

iclanton · 2022-04-09T02:18:15Z

Note: PR #3337 has renamed our GitHub master branch to main. This should not affect your pull request, but we recommend to redo your git clone to avoid confusion with the old branch name.

vsce/vscode-extension/src/providers/RushProjectsProvider.ts

dmichon-msft · 2022-10-06T22:16:21Z

vsce/vscode-extension/package.json

+  "dependencies": {
+    "@microsoft/rush-lib": "workspace:*",
+    "@rushstack/node-core-library": "workspace:*",
+    "@rushstack/rush-sdk": "workspace:*",


The trick to running webpack on @rushstack/rush-sdk is the @rushstack/webpack-preserve-dynamic-require-plugin, FYI.

chengcyber · 2022-11-24T02:11:03Z

Thanks to the hints from David's PR: #3651

I updated the building and packing process to rushstack vscode extension

Now, in extension development, it will be always try to load @microsoft/rush-lib first, while in a production version of extension, it will try to load @rushstack/rush-sdk from current workspace folders.

Also, this extension can be correctly packed to a "visx" format file, which means it's ready to be published to VSCode marketplace!

vsce/rush-command-webview/.eslintrc.js

TheLarkInn · 2022-12-06T00:05:21Z

.vscode/launch.json

+			"outFiles": [
+				"${workspaceFolder}/vscode-extensions/rush-vscode-extension/dist/**/*.js"
+			],
+			"preLaunchTask": "npm: build:watch - vscode-extensions/rush-vscode-extension"


Do heft commands work instead as the preLaunchTask?

TheLarkInn · 2022-12-06T00:06:42Z

README.md

@@ -154,6 +154,8 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/repo-scripts/generate-api-docs](./repo-scripts/generate-api-docs/) | Used to generate API docs for the rushstack.io website |
 | [/repo-scripts/repo-toolbox](./repo-scripts/repo-toolbox/) | Used to execute various operations specific to this repo |
 | [/rush-plugins/rush-litewatch-plugin](./rush-plugins/rush-litewatch-plugin/) | An experimental alternative approach for multi-project watch mode |
+| [/vscode-extensions/rush-vscode-command-webview](./vscode-extensions/rush-vscode-command-webview/) | Webview to run rush command in VSCode Extension |


I think we should use rushstack instead of rush as the language here. This extension will be a collection of all the relevant rushstack tools. In the future we wouldn't want an extension for rush, heft, etc.

TheLarkInn · 2022-12-06T00:21:15Z

vscode-extensions/rush-vscode-command-webview/src/ParameterView/ParameterForm/index.tsx

+
+  useEffect(() => {
+    // const defaultValues: FieldValues = defaultValuesRef.current;
+    console.log('rest', defaultValues);


Remove console.log

TheLarkInn · 2022-12-06T00:21:27Z

vscode-extensions/rush-vscode-command-webview/src/ParameterView/ParameterForm/index.tsx

+  }, [form]);
+  const { control, watch, reset } = form;
+
+  // const defaultValuesRef: MutableRefObject<FieldValues> = useRef<FieldValues>({});


Remove commented out code

TheLarkInn · 2022-12-07T19:26:51Z

vscode-extensions/rush-vscode-command-webview/webpack.config.js

+    },
+    devtool: production ? undefined : 'source-map',
+    optimization: {
+      runtimeChunk: false,


Are we just attempting to achieve one output bundle with this config? Looking for some rationale behind these config changes.

TheLarkInn · 2022-12-07T19:29:03Z

vscode-extensions/rush-vscode-command-webview/webpack.config.js

+      new HtmlWebpackPlugin({
+        template: 'public/index.html'
+      }),
+      new BundleAnalyzerPlugin({


Let's only run this during production in the same way we only generate sourcemaps for production. BundleAnalyzer is known for slowing down builds considerably.

TheLarkInn · 2022-12-07T19:36:55Z

vscode-extensions/rush-vscode-extension/package.json

+  "license": "MIT",
+  "author": "Cheng Liu<[email protected]>",
+  "publisher": "Microsoft",
+  "main": "./dist/extension.js",


We use /lib/ as our convention no?

TheLarkInn · 2022-12-07T19:39:57Z

vscode-extensions/rush-vscode-extension/package.json

+    "@vscode/test-electron": "^1.6.2",
+    "eslint": "~8.7.0",
+    "glob": "~7.0.5",
+    "mocha": "^9.1.3",


I know the default scaffolding for vscode extensions for yeoman provides mocha, but shouldn't we absolutely use jest and the infrastructure we have in place for testing?

TheLarkInn · 2022-12-07T19:41:51Z

vscode-extensions/rush-vscode-extension/scripts/vsce-package.js

+  const date = now.getDate();
+  const hour = now.getHours();
+  const min = now.getMinutes();
+  const version = `${year}_${month}_${date}_${hour}_${min}`;


Will this be our versioning schema for the extension package. Is this the best practice and what does vscode do with their community extensions for versioning?

TheLarkInn · 2022-12-07T19:57:31Z

vscode-extensions/rush-vscode-extension/src/extension.ts

+// your extension is activated the very first time the command is executed
+export async function activate(context: vscode.ExtensionContext): Promise<void> {
+  context.subscriptions.push(
+    vscode.commands.registerCommand('rushstack.selectWorkspace', async () => {


If there is no inscope state needs, we should simply extract the entire command into a separate module. It should be crystal clear where each of our commands live and we should separate each of them into their own modules. And example of this looks like:

https://github.com/TheLarkInn/rushstack/blob/018a69eb56cf2460e4a81de92809d86f595f2fc5/apps/rushstack-vscode-extension/src/extension.ts#L2-L7

chengcyber changed the title ~~feat(vscode-extension): hello world~~ [rush] VSCode Extension Jan 16, 2022

chengcyber force-pushed the feat-vscode-extension branch from 773045f to 15afb42 Compare January 16, 2022 15:04

dmichon-msft mentioned this pull request Sep 26, 2022

[rush] Integrate phased builds with VS Code #3651

Draft

dmichon-msft reviewed Oct 6, 2022

View reviewed changes

feat: rush vscode extension

58d4342

chengcyber force-pushed the feat-vscode-extension branch 3 times, most recently from 3c343eb to 0bf58a3 Compare November 23, 2022 14:37

chore: rush change

1b4425b

chengcyber force-pushed the feat-vscode-extension branch 2 times, most recently from 37b58fe to 7c7ef34 Compare November 23, 2022 16:06

chengcyber added 2 commits November 24, 2022 10:00

feat: rushstack vsce

ad9398e

chore: rush change

7142099

chengcyber force-pushed the feat-vscode-extension branch from 7c7ef34 to 7142099 Compare November 24, 2022 02:00

chengcyber added 2 commits November 24, 2022 10:21

chore: tsdoc

1e86a49

📝

1b893af

octogonz reviewed Nov 28, 2022

View reviewed changes

vsce/rush-command-webview/.eslintrc.js Outdated Show resolved Hide resolved

chengcyber added 4 commits November 28, 2022 16:28

chore: vsce -> vscode-extensions to avoid confusion

71777d5

fix: browser-approved-packages

8f11459

fix(rush-vscode-command-webview): production build warnings

db1c91c

📝

549b50a

chengcyber marked this pull request as ready for review November 29, 2022 11:53

chengcyber requested review from iclanton, apostolisms, D4N14L and patmill as code owners November 29, 2022 11:53

TheLarkInn mentioned this pull request Dec 5, 2022

Create home for Rushstack VSCode Extension w/ simple Rush CD Command #3808

Closed

3 tasks

TheLarkInn requested changes Dec 9, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[rush] VSCode Extension #3162

[rush] VSCode Extension #3162

chengcyber commented Jan 16, 2022 •

edited

Loading

chengcyber commented Mar 3, 2022 •

edited

Loading

iclanton commented Apr 9, 2022

dmichon-msft Oct 6, 2022

chengcyber commented Nov 24, 2022

TheLarkInn Dec 6, 2022 •

edited

Loading

TheLarkInn Dec 6, 2022

TheLarkInn Dec 6, 2022

TheLarkInn Dec 6, 2022

TheLarkInn Dec 7, 2022

TheLarkInn Dec 7, 2022

TheLarkInn Dec 7, 2022

TheLarkInn Dec 7, 2022

TheLarkInn Dec 7, 2022

TheLarkInn Dec 7, 2022

[rush] VSCode Extension #3162

Are you sure you want to change the base?

[rush] VSCode Extension #3162

Conversation

chengcyber commented Jan 16, 2022 • edited Loading

Summary

Details

How to develop in local

How to pack a production version and install it locally

chengcyber commented Mar 3, 2022 • edited Loading

Questions 2022/3/3

iclanton commented Apr 9, 2022

Choose a reason for hiding this comment

chengcyber commented Nov 24, 2022

TheLarkInn Dec 6, 2022 • 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

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

chengcyber commented Jan 16, 2022 •

edited

Loading

chengcyber commented Mar 3, 2022 •

edited

Loading

TheLarkInn Dec 6, 2022 •

edited

Loading