Add more framework samples (microsoft#80)

Description of changes

Adds hello world sample extensions for Svelte, Vue, Angular, and SolidJS-based webview extensions.
Also includes some minor clean-up to the React samples and reorganizes the overall repo structure.

Author: hawkticehurst

README.md

@@ -14,51 +14,29 @@ Follow the instructions in the `README` file of the desired sample extension.
 
 ### Default samples
 
-A set of sample extensions using vanilla HTML, CSS, and JavaScript to render the webview UI.
+A set of sample extensions using vanilla HTML, CSS, and JavaScript/TypeScript to render the webview UI and demonstrate various VS Code APIs.
 
-| Sample extension                                 | Description                                                                       |
-| ------------------------------------------------ | --------------------------------------------------------------------------------- |
-| [component-gallery](./default/component-gallery) | Demonstrates every component in the Webview UI Toolkit.                           |
-| [hello-world](./default/hello-world)             | A basic hello-world starter extension.                                            |
-| [notepad](./default/notepad)                     | A simple notetaking extension that leverages the VS Code TreeView API.            |
-| [weather-webview](./default/weather-webview)     | Demonstrates the toolkit being used within a webview view – i.e., Visual Studio Code sidebar. |
-
-### React samples
-
-A set of sample extensions using React to render the webview UI.
-
-| Sample extension                             | Description                                                           |
-| ---------------------------------------------| --------------------------------------------------------------------- |
-| [hello-world-cra](./react/hello-world-cra)   | A basic hello-world starter extension using React + Create React App. |
-| [hello-world-vite](./react/hello-world-vite) | A basic hello-world starter extension using React + Vite.             |
-
-### Svelte samples
-
-A set of sample extensions using Svelte to render the webview UI.
+Don't see a demonstration for your desired use case, VS Code API, etc.? Open an issue and request it.
 
-| Sample extension | Description |
-| -----------------| ----------- |
-| _Coming soon_    |             |
-
-### Vue samples
-
-A set of sample extensions using Vue to render the webview UI.
-
-| Sample extension | Description |
-| -----------------| ----------- |
-| _Coming soon_    |             |
-
-### Angular samples
-
-A set of sample extensions using Angular to render the webview UI.
+| Sample extension                                 | Description                                                                                   |
+| ------------------------------------------------ | --------------------------------------------------------------------------------------------- |
+| [component-gallery](./default/component-gallery) | Demonstrates every component in the Webview UI Toolkit.                                       |
+| [hello-world](./default/hello-world)             | A basic hello-world starter extension.                                                        |
+| [notepad](./default/notepad)                     | A simple notetaking extension that leverages the VS Code TreeView API.                        |
+| [weather-webview](./default/weather-webview)     | Demonstrates the toolkit being used within a webview view – i.e., Visual Studio Code sidebar. |
 
-| Sample extension | Description |
-| -----------------| ----------- |
-| _Coming soon_    |             |
+### Framework samples
 
-### Other samples
+A set of sample extensions that demonstrate how to use various web frameworks to render the webview UI.
 
-Don't see a demonstration for your desired framework, API, use case, etc.? Open an issue and request it.
+| Sample extension                                              | Description                                                           |
+| --------------------------------------------------------------| --------------------------------------------------------------------- |
+| [hello-world-angular](./frameworks/hello-world-angular)       | A basic hello-world starter extension using Angular.                  |
+| [hello-world-react-cra](./frameworks/hello-world-react-cra)   | A basic hello-world starter extension using React + Create React App. |
+| [hello-world-react-vite](./frameworks/hello-world-react-vite) | A basic hello-world starter extension using React + Vite.             |
+| [hello-world-solidjs](./frameworks/hello-world-solidjs)       | A basic hello-world starter extension using SolidJS.                  |
+| [hello-world-svelte](./frameworks/hello-world-svelte)         | A basic hello-world starter extension using Svelte.                   |
+| [hello-world-vue](./frameworks/hello-world-vue)               | A basic hello-world starter extension using Vue.                      |
 
 ## Contributing
 

react/hello-world-cra/.eslintrc.json renamed to frameworks/hello-world-angular/.eslintrc.json

@@ -0,0 +1,13 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "quoteProps": "consistent",
+  "jsxSingleQuote": false,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": true,
+  "arrowParens": "always"
+}

react/hello-world-cra/.prettierignore renamed to frameworks/hello-world-angular/.prettierignore

@@ -0,0 +1,37 @@
+# Hello World (Angular)
+
+This is an implementation of the default [Hello World](https://github.com/microsoft/vscode-webview-ui-toolkit-samples/tree/main/default/hello-world) sample extension that demonstrates how to set up and use a [Angular](https://angular.io/) + [Webview UI Toolkit](https://github.com/microsoft/vscode-webview-ui-toolkit) webview extension.
+
+![A screenshot of the sample extension.](./assets/hello-world-screenshot.png)
+
+## Documentation
+
+For a deeper dive into how this sample works, read the guides below.
+
+- [Extension structure](./docs/extension-structure.md)
+- [Extension commands](./docs/extension-commands.md)
+- [Extension development cycle](./docs/extension-development-cycle.md)
+
+## Run The Sample
+
+```bash
+# Copy sample extension locally
+npx degit microsoft/vscode-webview-ui-toolkit-samples/frameworks/hello-world-angular hello-world
+
+# Navigate into sample directory
+cd hello-world
+
+# Install dependencies for both the extension and webview UI source code
+npm run install:all
+
+# Build webview UI source code
+npm run build:webview
+
+# Open sample in VS Code
+code .
+```
+
+Once the sample is open inside VS Code you can run the extension by doing the following:
+
+1. Press `F5` to open a new Extension Development Host window
+2. Inside the host window, open the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and type `Hello World (Angular): Show`

frameworks/hello-world-angular/.prettierrc

@@ -0,0 +1,10 @@
+# Extension commands
+
+A quick run down of some of the important commands that can be run when at the root of the project.
+
+```
+npm run install:all      Install package dependencies for both the extension and Angular webview source code.
+npm run start:webview    Runs the Angular webview source code in development mode. Open http://localhost:4200 to view it in the browser.
+npm run build:webview    Build Angular webview source code. Must be executed before compiling or running the extension.
+npm run compile          Compile VS Code extension.
+```

react/hello-world-cra/.vscode/extensions.json renamed to frameworks/hello-world-angular/.vscode/extensions.json

@@ -0,0 +1,32 @@
+# Extension development cycle
+
+The intended development cycle of this Angular-based webview extension is slightly different than that of other VS Code extensions.
+
+Due to the fact that the `webview-ui` directory holds a self-contained Angular application we get to take advantage of some of the perks that that enables. In particular,
+
+- UI development and iteration cycles can happen much more quickly by using the provided Angular dev server
+- Dependency management and project configuration is hugely simplified
+
+## UI development cycle
+
+Since we can take advantage of a much faster dev server, it is encouraged to begin developing webview UI by running the `npm run start:webview` command and then editing the code in the `webview-ui/src` directory.
+
+_Tip: Open the command palette and run the `Simple Browser` command and fill in `http://localhost:4200/` when prompted. This will open a simple browser environment right inside VS Code._
+
+### Message passing
+
+If you need to implement message passing between the webview context and extension context via the VS Code API, a helpful utility is provided in the `webview-ui/src/utilities/vscode.ts` file.
+
+This file contains a utility wrapper around the `acquireVsCodeApi()` function, which enables message passing and state management between the webview and extension contexts.
+
+This utility also enables webview code to be run in a browser-based dev server by using native web browser features that mock the functionality enabled by acquireVsCodeApi. This means you can keep building your webview UI with the dev server even when using the VS Code API.
+
+### Move to traditional extension development
+
+Once you're ready to start building other parts of your extension, simply shift to a development model where you run the `npm run build:webview` command as you make changes, press `F5` to compile your extension and open a new Extension Development Host window. Inside the host window, open the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and type `Hello World (Angular): Show`.
+
+## Dependency management and project configuration
+
+As mentioned above, the `webview-ui` directory holds a self-contained and isolated Angular application meaning you can (for the most part) treat the development of your webview UI in the same way you would treat the development of a regular Angular application.
+
+To install webview-specific dependencies simply navigate (i.e. `cd`) into the `webview-ui` directory and install any packages you need or set up any Angular specific configurations you want.

react/hello-world-cra/.vscode/launch.json renamed to frameworks/hello-world-angular/.vscode/launch.json

@@ -0,0 +1,40 @@
+# Extension structure
+
+This section provides a quick introduction into how this sample extension is organized and structured.
+
+The two most important directories to take note of are the following:
+
+- `src`: Contains all of the extension source code
+- `webview-ui`: Contains all of the webview UI source code
+
+## `src` directory
+
+The `src` directory contains all of the extension-related source code and can be thought of as containing the "backend" code/logic for the entire extension. Inside of this directory you'll find the:
+
+- `panels` directory
+- `utilities` directory
+- `extension.ts` file
+
+The `panels` directory contains all of the webview-related code that will be executed within the extension context. It can be thought of as the place where all of the "backend" code for each webview panel is contained.
+
+This directory will typically contain individual TypeScript or JavaScript files that contain a class which manages the state and behavior of a given webview panel. Each class is usually in charge of:
+
+- Creating and rendering the webview panel
+- Properly cleaning up and disposing of webview resources when the panel is closed
+- Setting message listeners so data can be passed between the webview and extension
+- Setting the initial HTML markdown of the webview panel
+- Other custom logic and behavior related to webview panel management
+
+As the name might suggest, the `utilties` directory contains all of the extension utility functions that make setting up and managing an extension easier. In this case, it contains `getUri.ts` which contains a helper function which will get the webview URI of a given file or resource.
+
+Finally, `extension.ts` is where all the logic for activating and deactiving the extension usually live. This is also the place where extension commands are registered.
+
+## `webview-ui` directory
+
+The `webview-ui` directory contains all of the Angular-based webview source code and can be thought of as containing the "frontend" code/logic for the extension webview.
+
+This directory is special because it contains a full-blown Angular application which was created using the Angular CLI. As a result, `webview-ui` contains its own `package.json`, `node_modules`, `tsconfig.json`, and so on––separate from the `hello-world` extension in the root directory.
+
+This strays a bit from other extension structures, in that you'll usually find the extension and webview dependencies, configurations, and source code more closely integrated or combined with each other.
+
+However, in this case, there are some unique benefits and reasons for why this sample extension does not follow those patterns such as easier management of conflicting dependencies and configurations, as well as the ability to use a browser-based dev server, which drastically improves the speed of developing your webview UI, versus recompiling your extension code every time you make a change to the webview.