Skip to content

Commit

Permalink
Rebrand to SPFx Toolkit. Closes: #168 (#201)
Browse files Browse the repository at this point in the history
## 🎯 Aim

Rebrand to SPFx Toolkit

## 🔗 Related issue

 Closes: #168
  • Loading branch information
Adam-it authored Mar 23, 2024
1 parent 727ca41 commit 2664401
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 62 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<h1 align="center">
<img alt="Viva Connections Toolkit for Visual Studio Code" src="./assets/logo-large.png" width="150px" />
<img alt="SharePoint Framework Toolkit for Visual Studio Code" src="./assets/logo-large.png" width="150px" />
</h1>

<h1 align="center">
Viva Connections Toolkit for Visual Studio Code
SharePoint Framework Toolkit for Visual Studio Code
</h1>

<p align="center">
Expand All @@ -18,7 +18,7 @@
</a>
</p>

<p align="center">Viva Connections Toolkit (SPFx Toolkit) is a Visual Studio Code extension that 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. With SharePoint Framework, you can use modern web technologies and tools in your preferred development environment to build productive experiences and apps that are responsive and mobile-ready allowing you to create solutions to extend SharePoint, Microsoft Teams, Microsoft Viva Connections, Outlook and Microsoft365.com.</p>
<p align="center">SharePoint Framework Toolkit is a Visual Studio Code extension that 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. With SharePoint Framework, you can use modern web technologies and tools in your preferred development environment to build productive experiences and apps that are responsive and mobile-ready allowing you to create solutions to extend SharePoint, Microsoft Teams, Microsoft Viva Connections, Outlook and Microsoft365.com.</p>

<p align="center">
<a href="#-capabilities">Capabilities</a> |
Expand Down Expand Up @@ -210,7 +210,7 @@ And for Azure DevOps👇

[Check out our docs for more details](https://github.com/pnp/vscode-viva/wiki/5.5-Actions#add-new-component)

- **Open sample/scenario galleries of the SPFx web part, extensions, or ACEs projects** - Viva Connections Toolkit supports a couple of sample galleries that may be used to scaffold a new SPFx project.
- **Open sample/scenario galleries of the SPFx web part, extensions, or ACEs projects** - SharePoint Framework Toolkit supports a couple of sample galleries that may be used to scaffold a new SPFx project.

[Check out our docs for more details](https://github.com/pnp/vscode-viva/wiki/5.5-Actions#open-samplescenario-galleries-of-the-spfx-web-part-extensions-or-aces-projects)

Expand All @@ -224,7 +224,7 @@ The help and feedback section is a group of links that will direct you to the ri

### 1️⃣0️⃣ Coding Snippets

The Viva Connections Toolkit comes together as a bundle with two other extensions. One of them is [SPFx Snippets](https://marketplace.visualstudio.com/items?itemName=eliostruyf.spfx-snippets) created by [Elit Struyf](https://www.eliostruyf.com/).
The SharePoint Framework Toolkit comes together as a bundle with two other extensions. One of them is [SPFx Snippets](https://marketplace.visualstudio.com/items?itemName=eliostruyf.spfx-snippets) created by [Elit Struyf](https://www.eliostruyf.com/).

It contains snippets for working in:

Expand All @@ -246,21 +246,21 @@ Check it out in action 👇

### 1️⃣1️⃣ Teams Toolkit Integration

[Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) is a widely used VS Code extension that aims to help you develop solutions that will allow you to extend Microsoft Teams. Viva Connection Toolkit aims to boost your productivity in SharePoint Framework solutions that may be used to extend SharePoint, Microsoft Teams, Microsoft Viva Connections, Outlook, and Microsoft365.com. Among many awesome functionalities, Teams Toolkit allows you to create a project to extend Teams Tab with SPFx project, and that’s where both of those extensions may cooperate.
[Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) is a widely used VS Code extension that aims to help you develop solutions that will allow you to extend Microsoft Teams. SharePoint Framework Toolkit aims to boost your productivity in SharePoint Framework solutions that may be used to extend SharePoint, Microsoft Teams, Microsoft Viva Connections, Outlook, and Microsoft365.com. Among many awesome functionalities, Teams Toolkit allows you to create a project to extend Teams Tab with SPFx project, and that’s where both of those extensions may cooperate.

![Teams Toolkit integration](./assets/images/better-together.png)

[Check out our docs for more details](https://github.com/pnp/vscode-viva/wiki/6-Teams-Toolkit-Integration)

### 1️⃣2️⃣ Node.js Version Manager Support

By default, the Viva Connections Toolkit will use the Node.js version that is installed on your machine. If you want to use a different version, you can use a Node.js Version Manager such as [nvm](https://github.com/nvm-sh/nvm) or [nvs](https://github.com/jasongin/nvs). The Viva Connections Toolkit will detect the preferred version of Node.js if a `.nvmrc` file is present in the root of your project, and will use that version for all the actions.
By default, the SharePoint Framework Toolkit will use the Node.js version that is installed on your machine. If you want to use a different version, you can use a Node.js Version Manager such as [nvm](https://github.com/nvm-sh/nvm) or [nvs](https://github.com/jasongin/nvs). The SharePoint Framework Toolkit will detect the preferred version of Node.js if a `.nvmrc` file is present in the root of your project, and will use that version for all the actions.

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`

## ⚙️ Architecture

Viva Connections 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/).
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/).

This means that the features and capabilities provided through this tool are available for any solution which has been built with SPFx.

Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contribution guidelines

Thank you for your interest in contributing to the Viva Connections Toolkit extension. In this guide, we will walk you through the steps to get started.
Thank you for your interest in contributing to the SharePoint Framework Toolkit extension. In this guide, we will walk you through the steps to get started.

## Before you start

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

98 changes: 49 additions & 49 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "viva-connections-toolkit",
"displayName": "Viva Connections Toolkit",
"description": "Viva Connections 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": "2.6.1",
"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": "2.6.2",
"publisher": "m365pnp",
"preview": false,
"homepage": "https://github.com/pnp/vscode-viva",
Expand Down Expand Up @@ -46,9 +46,9 @@
"main": "./dist/extension.js",
"contributes": {
"configuration": {
"title": "Viva Connections Toolkit",
"title": "SharePoint Framework Toolkit",
"properties": {
"viva-connections-toolkit.nodeVersionManager": {
"spfx-toolkit.nodeVersionManager": {
"title": "Node.js Version Manager",
"type": "string",
"default": "nvm",
Expand Down Expand Up @@ -109,7 +109,7 @@
"activitybar": [
{
"id": "pnp-view",
"title": "Viva Connections Toolkit",
"title": "SharePoint Framework Toolkit",
"icon": "assets/logo-light.svg"
}
]
Expand All @@ -118,7 +118,7 @@
"pnp-view": [
{
"id": "pnp-view-empty",
"name": "Viva Connections Toolkit",
"name": "SharePoint Framework Toolkit",
"when": "pnp.project.showWelcome"
},
{
Expand Down Expand Up @@ -151,136 +151,136 @@
"viewsWelcome": [
{
"view": "pnp-view-empty",
"contents": "Welcome to Viva Connections Toolkit\n\n\nTo start create a new SharePoint Framework project. \n[Create a new project](command:viva-connections-toolkit.createProject)\n\n\n\n\n\nUse a sample to kick off a new project and boost your development.\n[View samples](command:viva-connections-toolkit.samplesGallery)\n\n\n\n\n\nYou can also open an existing app.\n[Open folder](command:vscode.openFolder)\n\n\n\n\n\nValidate your local workspace and check if you have the required dependencies.\n[Check dependencies](command:viva-connections-toolkit.checkDependencies)\n\n\n\n\n\nInstall the required dependencies.\n[Install dependencies](command:viva-connections-toolkit.installDependencies)\n\n\n\nIf you need additional help or resources visit the [extension wiki](https://github.com/pnp/vscode-viva/wiki) for more information."
"contents": "Welcome to SharePoint Framework Toolkit\n\n\nTo start create a new SharePoint Framework project. \n[Create a new project](command:spfx-toolkit.createProject)\n\n\n\n\n\nUse a sample to kick off a new project and boost your development.\n[View samples](command:spfx-toolkit.samplesGallery)\n\n\n\n\n\nYou can also open an existing app.\n[Open folder](command:vscode.openFolder)\n\n\n\n\n\nValidate your local workspace and check if you have the required dependencies.\n[Check dependencies](command:spfx-toolkit.checkDependencies)\n\n\n\n\n\nInstall the required dependencies.\n[Install dependencies](command:spfx-toolkit.installDependencies)\n\n\n\nIf you need additional help or resources visit the [extension wiki](https://github.com/pnp/vscode-viva/wiki) for more information."
}
],
"commands": [
{
"command": "viva-connections-toolkit.checkDependencies",
"command": "spfx-toolkit.checkDependencies",
"title": "Check dependencies",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.installDependencies",
"command": "spfx-toolkit.installDependencies",
"title": "Install dependencies",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.createProject",
"command": "spfx-toolkit.createProject",
"title": "Create new project",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.addToProject",
"command": "spfx-toolkit.addToProject",
"title": "Add component to project",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.executeTerminalCommand",
"command": "spfx-toolkit.executeTerminalCommand",
"title": "Execute terminal command",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.upgradeProject",
"command": "spfx-toolkit.upgradeProject",
"title": "Upgrade project to latest SPFx version",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.deployProject",
"command": "spfx-toolkit.deployProject",
"title": "Deploy the project",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.samplesGallery",
"command": "spfx-toolkit.samplesGallery",
"title": "Open SharePoint Framework Samples gallery",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.validateProject",
"command": "spfx-toolkit.validateProject",
"title": "Validate project",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.renameProject",
"command": "spfx-toolkit.renameProject",
"title": "Rename project",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.grantAPIPermissions",
"command": "spfx-toolkit.grantAPIPermissions",
"title": "Grant API permissions",
"category": "Viva Connections Toolkit"
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.pipelineGitHub",
"title": "Generate GitHub CI/CD workflow",
"category": "Viva Connections Toolkit"
"command": "spfx-toolkit.pipeline",
"title": "Generate CI/CD workflow",
"category": "SharePoint Framework Toolkit"
},
{
"command": "viva-connections-toolkit.login",
"command": "spfx-toolkit.login",
"title": "Sign in to M365",
"category": "Viva Connections Toolkit",
"category": "SharePoint Framework Toolkit",
"icon": "$(sign-in)"
},
{
"command": "viva-connections-toolkit.logout",
"command": "spfx-toolkit.logout",
"title": "Sign out from M365",
"category": "Viva Connections Toolkit",
"category": "SharePoint Framework Toolkit",
"icon": "$(sign-out)"
},
{
"command": "viva-connections-toolkit.refreshAppCatalogTreeView",
"command": "spfx-toolkit.refreshAppCatalogTreeView",
"title": "Refresh App Catalog list",
"category": "Viva Connections Toolkit",
"category": "SharePoint Framework Toolkit",
"icon": "$(refresh)"
},
{
"command": "viva-connections-toolkit.refreshAccountTreeView",
"command": "spfx-toolkit.refreshAccountTreeView",
"title": "Refresh Account view",
"category": "Viva Connections Toolkit",
"category": "SharePoint Framework Toolkit",
"icon": "$(refresh)"
}
],
"menus": {
"commandPalette": [
{
"command": "viva-connections-toolkit.executeTerminalCommand",
"command": "spfx-toolkit.executeTerminalCommand",
"when": "false"
},
{
"command": "viva-connections-toolkit.addToProject",
"command": "spfx-toolkit.addToProject",
"when": "pnp.project.isSPFxProject"
},
{
"command": "viva-connections-toolkit.upgradeProject",
"command": "spfx-toolkit.upgradeProject",
"when": "pnp.project.isSPFxProject"
},
{
"command": "viva-connections-toolkit.validateProject",
"command": "spfx-toolkit.validateProject",
"when": "pnp.project.isSPFxProject"
}
],
"view/title": [
{
"command": "viva-connections-toolkit.refreshAppCatalogTreeView",
"command": "spfx-toolkit.refreshAppCatalogTreeView",
"when": "view == pnp-view-environment",
"group": "navigation"
},
{
"command": "viva-connections-toolkit.refreshAccountTreeView",
"command": "spfx-toolkit.refreshAccountTreeView",
"when": "view == pnp-view-account",
"group": "navigation"
}
],
"view/item/context": [
{
"command": "viva-connections-toolkit.logout",
"command": "spfx-toolkit.logout",
"when": "view == pnp-view-account && viewItem == m365Account",
"group": "inline@1"
}
],
"explorer/context": [
{
"command": "viva-connections-toolkit.deployProject",
"command": "spfx-toolkit.deployProject",
"group": "pnp.project@1",
"when": "resourceExtname == '.sppkg' && pnp.project.hasAppCatalog"
}
Expand Down
2 changes: 1 addition & 1 deletion src/constants/General.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const EXTENSION_NAME = 'viva-connections-toolkit';
export const EXTENSION_NAME = 'spfx-toolkit';
2 changes: 1 addition & 1 deletion src/webview/PnPWebview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export class PnPWebview {
const ext = Extension.getInstance();

PnPWebview.webview = window.createWebviewPanel(
'viva-connections-toolkit.webview',
'spfx-toolkit.webview',
'PnP',
ViewColumn.One,
{
Expand Down

0 comments on commit 2664401

Please sign in to comment.