Capabilities | + Preview features | Architecture | Wiki | Contributing | @@ -33,7 +34,7 @@
 - + ## ⭐ 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 + + + +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 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. + + + +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 new file mode 100644 index 0000000..d93097a Binary files /dev/null and b/assets/images/chat-commands.png differ diff --git a/assets/images/chat-in-action.gif b/assets/images/chat-in-action.gif new file mode 100644 index 0000000..7596dc3 Binary files /dev/null and b/assets/images/chat-in-action.gif differ diff --git a/assets/images/chat-intro.png b/assets/images/chat-intro.png new file mode 100644 index 0000000..513fcdc Binary files /dev/null and b/assets/images/chat-intro.png differ diff --git a/package-lock.json b/npm-shrinkwrap.json similarity index 99% rename from package-lock.json rename to npm-shrinkwrap.json index 876732c..c0f1d12 100644 --- a/package-lock.json +++ b/npm-shrinkwrap.json @@ -1,12 +1,12 @@ { "name": "viva-connections-toolkit", - "version": "3.2.0", + "version": "3.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "viva-connections-toolkit", - "version": "3.2.0", + "version": "3.3.0", "license": "MIT", "dependencies": { "@pnp/cli-microsoft365": "6.11.0", @@ -24,9 +24,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", @@ -57,7 +58,7 @@ "webpack-dev-server": "^4.8.1" }, "engines": { - "vscode": "^1.65.0" + "vscode": "^1.90.0" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -3828,19 +3829,6 @@ "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", "extraneous": true }, - "node_modules/@pnp/cli-microsoft365/node_modules/fsevents": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", - "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", - "extraneous": true, - "hasInstallScript": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, "node_modules/@pnp/cli-microsoft365/node_modules/function-bind": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", @@ -7195,9 +7183,10 @@ "integrity": "sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==" }, "node_modules/@types/vscode": { - "version": "1.84.1", - "dev": true, - "license": "MIT" + "version": "1.90.0", + "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.90.0.tgz", + "integrity": "sha512-oT+ZJL7qHS9Z8bs0+WKf/kQ27qWYR3trsXpq46YDjFqBsMLG4ygGGjPaJ2tyrH0wJzjOEmDyg9PDJBBhWg9pkQ==", + "dev": true }, "node_modules/@types/vscode-webview": { "version": "1.57.0", @@ -7401,6 +7390,12 @@ "version": "1.2.0", "license": "ISC" }, + "node_modules/@vscode/prompt-tsx": { + "version": "0.2.3-alpha", + "resolved": "https://registry.npmjs.org/@vscode/prompt-tsx/-/prompt-tsx-0.2.3-alpha.tgz", + "integrity": "sha512-6u/WX4kjl/spf/jGL+sgI+ELlIFO42GqbiwDWcB7epB55YTQzl543Iwj0+dzu70ofr/kqV48IbGP0EjTuCUzGw==", + "dev": true + }, "node_modules/@vscode/test-electron": { "version": "2.3.6", "dev": true, @@ -13140,7 +13135,7 @@ } }, "node_modules/npm/node_modules/ip": { - "version": "2.0.0", + "version": "2.0.1", "dev": true, "inBundle": true, "license": "MIT" @@ -14277,7 +14272,7 @@ "inBundle": true, "license": "MIT", "dependencies": { - "ip": "^2.0.0", + "ip": "^2.0.1", "smart-buffer": "^4.2.0" }, "engines": { diff --git a/package.json b/package.json index 860fd58..48b0ae3 100644 --- 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" } -} \ No newline at end of file +} diff --git a/src/chat/PromptHandlers.ts b/src/chat/PromptHandlers.ts new file mode 100644 index 0000000..f28f70f --- /dev/null +++ b/src/chat/PromptHandlers.ts @@ -0,0 +1,113 @@ +import * as vscode from 'vscode'; +import { Commands, promptCodeContext, promptContext, promptNewContext, promptSetupContext } from '../constants'; + +const MODEL_SELECTOR: vscode.LanguageModelChatSelector = { vendor: 'copilot', family: 'gpt-4' }; + +export class PromptHandlers { + + public static async handle(request: vscode.ChatRequest, context: vscode.ChatContext, stream: vscode.ChatResponseStream, token: vscode.CancellationToken): PromiseThe component name already exists
+ } ++ Please fill up the required fields with valid values +
+ ) : ( + '' + )} +Working on it...
+The solution name already exists
+ } +General information
-The solution name already exists
- } -{componentTypeName} details
-The component name already exists
- } -Additional steps
-Please provide fill up the required fields with valid values
: - ''} -Working on it...
-{title}
+