Release v3.3.0 (#253)

## 🎯 Aim The aim is to prepare a new minor release with the latest changes that focus mainly on code refactoring and maintenance. ## ✅ What was done - [X] Refactored scaffolding form to smaller components - [X] Updated GH release workflows - [X] Added npm-shrinkwrap - [X] Improved method docs - [X] Added missing ACE template for line chart card for SPFx 1.19.0 - [X] Refactored chat participant - removed `action` command and fine-tuned the prompts --------- Co-authored-by: Saurabh Tripathi <[email protected]>
pnp · Jun 15, 2024 · 8708a8d · 8708a8d
1 parent f10b971
commit 8708a8d
Show file tree

Hide file tree

Showing 51 changed files with 1,015 additions and 447 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -20,7 +20,6 @@
         "no-dupe-keys": "error",
         "no-duplicate-case": "error",
         "no-duplicate-imports": "error",
-        "no-unused-vars": "error",
         "curly": "error",
         "eqeqeq": "error",
         "no-throw-literal": "warn",

diff --git a/.github/workflows/release-beta.yml b/.github/workflows/release-beta.yml
@@ -21,7 +21,7 @@ jobs:
           path: vscode-viva
 
       - name: Install the dependencies
-        run: npm install
+        run: npm ci
         working-directory: vscode-viva
 
       - name: Checkout cli-microsoft365
@@ -36,7 +36,7 @@ jobs:
           dir
 
       - name: Restore dependencies for cli-microsoft365
-        run: npm install
+        run: npm i
         working-directory: cli-microsoft365
 
       - name: Build cli-microsoft365

diff --git a/.github/workflows/release-local.yml b/.github/workflows/release-local.yml
@@ -21,7 +21,7 @@ jobs:
           path: vscode-viva
 
       - name: Install the dependencies
-        run: npm install
+        run: npm ci
         working-directory: vscode-viva
 
       - name: Checkout cli-microsoft365
@@ -36,7 +36,7 @@ jobs:
           dir
 
       - name: Restore dependencies for cli-microsoft365
-        run: npm install
+        run: npm i
         working-directory: cli-microsoft365
 
       - name: Build cli-microsoft365

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,7 +24,7 @@ jobs:
           path: vscode-viva
 
       - name: Install the dependencies
-        run: npm install
+        run: npm ci
         working-directory: vscode-viva
 
       - name: Checkout cli-microsoft365
@@ -39,7 +39,7 @@ jobs:
           dir
 
       - name: Restore dependencies for cli-microsoft365
-        run: npm install
+        run: npm i
         working-directory: cli-microsoft365
 
       - name: Build cli-microsoft365

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Change Log
 
+## [3.3.0] - 2024-06-16
+
+- Refactored scaffolding form to smaller components
+- Code house keeping
+- Added missing ACE template DataVisualization for SPFx 1.19.0
+- Added GitHub Copilot Chat participant for SPFx Toolkit
+
+## [3.2.0] - 2024-05-12
+
+- Added support for SPFx 1.19.0
+
+## [3.1.0] - 2024-04-28
+
+- Refactor the action naming
+- Fixed bug when there's a space in the folder path causing serve
+
 ## [3.0.0] - 2024-03-31
 
 - Added VS Code extension walkthrough

diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@
 
 <p align="center">
   <a href="#-capabilities">Capabilities</a> |
+  <a href="#-preview-features">Preview features</a> |
   <a href="#%EF%B8%8F-architecture">Architecture</a> |
   <a href="#-wiki">Wiki</a> |
   <a href="#-contributing">Contributing</a> |
@@ -33,7 +34,7 @@
 </p>
 
 ![Sample Gallery](./assets/images/start.png)
- 
+
 ## ⭐ Capabilities
 
 The extension provides the following capabilities:
@@ -263,6 +264,36 @@ By default, the SharePoint Framework Toolkit will use the Node.js version that i
 
 You can use the settings to change which Node.js version manager you want to use. You may choose between `nvm` and `nvs`. If you wish to avoid using a Node.js version manager, you can set the value to `none`
 
+## 🧪 Preview features
+
+>  [!WARNING]
+>  Features described in this section are considered as an early beta feature. They may change or be removed in a future major or minor release.
+
+### 1️⃣ SPFx Toolkit GitHub Chat Participant 
+
+![SPFx Toolkit chat](./assets/images/chat-intro.png)
+
+Now you may use SPFx Toolkit as a chat participant in GitHub Copilot chat extension. Simply, mention @spfx in the chat to ask dedicated questions regarding SharePoint Framework development. 
+
+![SPFx Toolkit chat in action](./assets/images/chat-in-action.gif)
+
+@spfx is your dedicated AI Copilot that will help you with anything that is needed to develop your SharePoint Framework project. It has predefined commands that are tailored toward a specific activity for which you require guidance.
+
+![SPFx Toolkit chat commands](./assets/images/chat-commands.png)
+
+Currently, we support the following commands:
+- `/setup` - that is dedicated to providing information on how to setup your local workspace for SharePoint Framework development
+- `/new` - that may be used to get guidance on how to create a new solution or find and reuse an existing sample from the PnP SPFx sample gallery
+- `/code` - that is fine-tuned to provide help in coding your SharePoint Framework project and provides additional boosters like validating the correctness of your SPFx project, scaffolding a CI/CD workflow, or renaming your project, and many more.
+
+> [!IMPORTANT]  
+> In order for this feature to work you need to meet the following requirements:
+> - Use the [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) release
+> - Use the pre-release version of the [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extension
+> - Use latest version of [SPFx Toolkit](https://marketplace.visualstudio.com/items?itemName=m365pnp.viva-connections-toolkit)
+
+[Check out our docs for more details](https://github.com/pnp/vscode-viva/wiki/8.-Preview-features)
+
 ## ⚙️ Architecture
 
 SharePoint Framework Toolkit for Visual Studio Code is an abstraction layer on top of the [SPFx](https://aka.ms/spfx) Yeoman generator and [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/). 

diff --git a/assets/images/chat-commands.png b/assets/images/chat-commands.png
diff --git a/assets/images/chat-in-action.gif b/assets/images/chat-in-action.gif
diff --git a/assets/images/chat-intro.png b/assets/images/chat-intro.png
diff --git a/package-lock.json → npm-shrinkwrap.json b/package-lock.json → npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -2,18 +2,20 @@
 	"name": "viva-connections-toolkit",
 	"displayName": "SharePoint Framework Toolkit",
 	"description": "SharePoint Framework Toolkit aims to boost your productivity in developing and managing SharePoint Framework solutions helping at every stage of your development flow, from setting up your development workspace to deploying a solution straight to your tenant without the need to leave VS Code and now even create a CI/CD pipeline to introduce automate deployment of your app. This toolkit is provided by the community.",
-	"version": "3.2.0",
+	"version": "3.3.0",
 	"publisher": "m365pnp",
 	"preview": false,
 	"homepage": "https://github.com/pnp/vscode-viva",
 	"icon": "assets/logo-large.png",
 	"engines": {
-		"vscode": "^1.65.0"
+		"vscode": "^1.90.0"
 	},
 	"categories": [
 		"Snippets",
 		"Extension Packs",
-		"Other"
+		"Other",
+		"AI",
+		"Chat"
 	],
 	"repository": {
 		"type": "git",
@@ -45,6 +47,29 @@
 	"license": "MIT",
 	"main": "./dist/extension.js",
 	"contributes": {
+		"chatParticipants": [
+			{
+				"id": "spfx-toolkit.pnp",
+				"fullName": "SPFx Toolkit",
+				"name": "spfx",
+				"description": "How can I help you with SPFx development?",
+				"isSticky": true,
+				"commands": [
+					{
+						"name": "setup",
+						"description": "Prepare your local workspace for SharePoint Framework development"
+					},
+					{
+						"name": "new",
+						"description": "Create a new SharePoint Framework project."
+					},
+					{
+						"name": "code",
+						"description": "Let's write some SPFx code"
+					}
+				]
+			}
+		],
 		"walkthroughs": [
 			{
 				"id": "spfx-toolkit-intro",
@@ -64,8 +89,8 @@
 						"title": "Check and get required dependencies",
 						"description": "Validate if your local workspace is ready for SharePoint Framework development. \n[Check dependencies](command:spfx-toolkit.checkDependencies)",
 						"media": {
-							"image": "assets/images/validate-dependency.png", 
-							"altText": "Validate dependencies" 
+							"image": "assets/images/validate-dependency.png",
+							"altText": "Validate dependencies"
 						}
 					},
 					{
@@ -113,7 +138,7 @@
 						"title": "Continue your learning and get additional tooling",
 						"description": "SharePoint Framework Toolkit is your single point to get to the official Microsoft documentation and learning regarding SharePoint Framework and additional tooling that will help you create apps for Microsoft 365.",
 						"media": {
-							"image": "assets/images/help-and-feedback.png", 
+							"image": "assets/images/help-and-feedback.png",
 							"altText": "help and feedback section"
 						}
 					},
@@ -122,8 +147,8 @@
 						"title": "Connect with the Microsoft 365 and Power Platform community",
 						"description": "Stay up to date and connected. \nVisit the [Microsoft 365 and Power Platform community](https://pnp.github.io/) to get more learning materials, guidance, tooling, and engage in community calls. \nJoin the [community Discord server](https://aka.ms/community/discord) to stay connected and help out others. \n Sharing is caring!",
 						"media": {
-							"image": "assets/images/parker-pnp.png", 
-							"altText": "PnP Parker" 
+							"image": "assets/images/parker-pnp.png",
+							"altText": "PnP Parker"
 						}
 					}
 				]
@@ -411,9 +436,10 @@
 		"@types/react": "^18.0.8",
 		"@types/react-dom": "^18.0.3",
 		"@types/react-router-dom": "^5.3.3",
-		"@types/vscode": "^1.65.0",
+		"@types/vscode": "^1.90.0",
 		"@typescript-eslint/eslint-plugin": "^5.9.1",
 		"@typescript-eslint/parser": "^5.9.1",
+		"@vscode/prompt-tsx": "^0.2.3-alpha",
 		"@vscode/test-electron": "^2.0.3",
 		"@vscode/webview-ui-toolkit": "^1.0.0",
 		"autoprefixer": "^10.4.5",
@@ -449,4 +475,4 @@
 		"react-markdown": "^9.0.1",
 		"remark-gfm": "^4.0.0"
 	}
-}
+}