Skip to content

Commit 8f52413

Browse files
committed
Fixups before minor release (#507)
## 🎯 Aim The aim is to do some small fixup I noticed when prepping the product for a minor release ## 📷 Result ![image](https://github.com/user-attachments/assets/1d9eab51-88ae-43f2-b04c-4a37beef532a) ## ✅ What was done - [X] Code cleanup - [X] Updated the walkthrough headers - [X] Reverted the name of Validate local setup which was renamed by mistake
1 parent 8497b17 commit 8f52413

File tree

10 files changed

+27
-28
lines changed

10 files changed

+27
-28
lines changed

assets/walkthrough/actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Actions
1+
# Actions
22

33
The actions section allows unique functionalities that may significantly boost productivity when working with SPFx projects.
44

@@ -66,7 +66,7 @@ And the code tour guidance will provide you upgrade tips directly in your code!
6666

6767
[Check out our docs for more details](https://pnp.github.io/vscode-viva/features/actions/#set-form-customizer)
6868

69-
- **Increase project version** - This action allows you to increase project major, minor or patch varsion and automatically align the versioning between `package.json` and `package-solution.json` files.
69+
- **Increase project version** - This action allows you to increase project major, minor or patch version and automatically align the versioning between `package.json` and `package-solution.json` files.
7070

7171
![Increase project version](../images/increase-versioning.png)
7272

assets/walkthrough/cicd-workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## CI/CD Workflow
1+
# CI/CD Workflow
22

33
SharePoint Framework Toolkit extends VS Code with additional UI to present you with a scaffolding form that will allow you to create a CI/CD Workflow in 3 easy steps.
44

5-
It's important to know that many fields are already prefield and it is possible to hit create without changing any value to get a basic and default YAML workflow file.
5+
It's important to know that many fields are already pre-filled and it is possible to hit create without changing any value to get a basic and default YAML workflow file.
66

77
![CI CD pipeline](../images/CICD-pipeline.png)
88

assets/walkthrough/coding-snippets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Coding Snippets
1+
# Coding Snippets
22

3-
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/).
3+
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 [Elio Struyf](https://www.eliostruyf.com/).
44

55
It contains snippets for working in:
66

assets/walkthrough/create-new-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Create a new project
1+
# Create a new project
22

3-
Creating a new project was never easier. Just use the **create a new project** action, and the extension will guide you through the process with a dedicated scaffolding form.
3+
Creating a new project has never been easier. Just use the **create a new project** action, and the extension will guide you through the process with a dedicated scaffolding form.
44

55
![Create new project](../images/scaffolding.png)
66

@@ -31,7 +31,7 @@ Switch between the list and grid view and don't worry about the size of your VS
3131

3232
![Sample gallery is responsive](../images/samples-responsive.png)
3333

34-
Check out how easy it is to create a new project based on a existing sample 👇.
34+
Check out how easy it is to create a new project based on an existing sample 👇.
3535

3636
![Create project based on web part sample](../images/sample-gallery.gif)
3737

assets/walkthrough/spfx-intro.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11

2-
## SharePoint Framework
2+
# SharePoint Framework
33

44
With SharePoint Framework (SPFx), 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. This extensibility model allows you to write once and reuse your solutions in multiple Microsoft 365 applications with exactly the same code base.
55

66
The following are some of the key features included as part of the SPFx:
77

8-
- It runs in the context of the current user and connection in the browser. There are no iFrames for the customization (JavaScript is - embedded directly to the page).
8+
- It runs in the context of the current user and connection in the browser. There are no iFrames for the customization (JavaScript is embedded directly into the page).
99
- The controls are rendered in the normal page DOM.
1010
- The controls are responsive and accessible by nature.
1111
- It enables the developer to access the lifecycle in addition to render, load, serialize and deserialize, configuration changes, and more.
1212
- It's framework-agnostic. You can use any JavaScript framework that you like including, but not limited to, React, Handlebars, Knockout, Angular, and Vue.js.
1313
- The developer toolchain is based on popular open-source client development tools such as NPM, TypeScript, Yeoman, webpack, and gulp.
14-
Performance is reliable.
14+
- Performance is reliable.
1515
- End users can use SPFx client-side solutions that are approved by the tenant administrators (or their delegates) on all sites, including self-service team, group, or personal sites.
1616
- SPFx web parts can be added to both classic and modern pages.
1717
- SPFx solutions can be used to extend Microsoft Teams.
1818
- SPFx can be used to extend Microsoft Viva Connections.
19-
- SPFx can be use to extend Outlook and Office 365 app (Office)
19+
- SPFx can be used to extend Outlook and Office 365 app (Office)
2020

2121
With SharePoint Framework you may create client-side web parts, extensions, and adaptive cards.
2222

23-
- Web pats are are controls that appear inside a SharePoint page and execute client-side in the browser. They're the building blocks of pages that appear on a SharePoint site. You can build client-side web parts using modern client-side development tools and the SharePoint workbench (a development test surface). You can deploy your client-side web parts to both modern pages and classic web part pages in Microsoft 365 tenants.
24-
- Extensions allows you to extend the SharePoint user experience. With SPFx Extensions, you can customize more facets of the SharePoint experience, including notification areas, toolbars, list data views, and forms. SPFx Extensions are available in all Microsoft 365 subscriptions for production usage.SPFx Extensions enable you to extend the SharePoint user experience within modern pages and document libraries, while using the familiar SPFx tools and libraries for client-side development. Specifically, the SPFx includes four extension types:
23+
- Web pats are controls that appear inside a SharePoint page and execute client-side in the browser. They're the building blocks of pages that appear on a SharePoint site. You can build client-side web parts using modern client-side development tools and the SharePoint workbench (a development test surface). You can deploy your client-side web parts to both modern pages and classic web part pages in Microsoft 365 tenants.
24+
- Extensions allows you to extend the SharePoint user experience. With SPFx Extensions, you can customize more facets of the SharePoint experience, including notification areas, toolbars, list data views, and forms. SPFx Extensions are available in all Microsoft 365 subscriptions for production usage. SPFx Extensions enable you to extend the SharePoint user experience within modern pages and document libraries, while using the familiar SPFx tools and libraries for client-side development. Specifically, the SPFx includes four extension types:
2525

2626
- Application Customizers: Adds scripts to the page, and accesses well-known HTML element placeholders and extends them with custom renderings.
2727
- Field Customizers: Provides modified views to data for fields within a list.
2828
- Command Sets: Extends the SharePoint command surfaces to add new actions, and provides client-side code that you can use to implement behaviors.
29-
- Form Customizer: Provides a way to assoicate and override default new, edit and view form experience of list and libraries with custom forms by associating component to content type.
29+
- Form Customizer: Provides a way to assoicate and override default new, edit and view form experiences of list and libraries with custom forms by associating component to content type.
3030

31-
- Library components enables you to have independently versioned and deployed code served automatically for the SharePoint Framework components with a deployment through an app catalog. Library components provide you an alternative option to create shared code, which can be then used and referenced cross all the components in the tenant.
32-
- Adaptive Cards Extensions allows you to extend Viva Connections dashboard with your own custom functionalities and visualizations
31+
- Library components enables you to have independently versioned and deployed code served automatically for the SharePoint Framework components with a deployment through an app catalog. Library components provide you an alternative option to create shared code, which can be then used and referenced across all the components in the tenant.
32+
- Adaptive Cards Extensions allow you to extend Viva Connections dashboard with your own custom functionalities and visualizations
3333

3434
Go over the [overview of the SharePoint Framework](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview) to find out more.
3535

assets/walkthrough/tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Gulp tasks
1+
# Gulp tasks
22

33
The SharePoint Framework uses [Gulp](https://gulpjs.com/) as its task runner to handle building, bundling, and packaging of the client-side solution project.
44

assets/walkthrough/tenant-details.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Sign in to your tenant & retrieve environment details
1+
# Sign in to your tenant & retrieve environment details
22

33
The extension allows you to sign in to your Microsoft 365 tenant using CLI for Microsoft 365.
44

55
![login](../images/login.png)
66

7-
SPFx Toolkit needs and Entra App Registration to be able to sign in to your tenant. You may either use an existing app registration or create a new one with a single click using a dedicated form. SPFx Toolkit will guide you through the process of creating a new app registration either manually by providing step-by-step guidance or automatically by creating the app registration for you.
7+
SPFx Toolkit needs and Entra App Registration to sign in to your tenant. You may either use an existing app registration or create a new one with a single click using a dedicated form. SPFx Toolkit will guide you through the process of creating a new app registration either manually by providing step-by-step guidance or automatically by creating the app registration for you.
88

99
![app registration](../images/sign-in.gif)
1010

@@ -41,6 +41,6 @@ Using the extension settings you may choose show or hide the tenant-wide extensi
4141

4242
![settings](../images/settings.png)
4343

44-
Sign-in is also required for some actions to work properly like the deploy action which allows you to upload of the .sppkg file to the tenant or site-level App Catalog.
44+
Sign-in is also required for some actions to work properly, such as the deploy action, which allows you to upload of the .sppkg file to the tenant or site-level App Catalog.
4545

4646
[Check out our docs for more details](https://pnp.github.io/vscode-viva/features/login-tenant/)

assets/walkthrough/validate-local-setup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
## Set up your SharePoint Framework development environment
1+
# Set up your SharePoint Framework development environment
22

3-
To build and deploy client-side web parts, extensions, or adaptive cards using the SharePoint Framework, you will need to setup your development environment. SPFx requires:
3+
To build and deploy client-side web parts, extensions, or adaptive cards using the SharePoint Framework, you will need to set up your development environment. SPFx requires:
44

55
- Node.js
66
- Yeoman
77
- Gulp
88
- Yeoman SharePoint generator
99

10-
If you have Node.js you may validate and install these dependencies by running the following commands in your terminal
10+
If you have Node.js, you can validate and install these dependencies by running the following commands in your terminal.
1111

1212
```sh
1313
npm install gulp-cli yo @microsoft/generator-sharepoint --global
1414
```
1515

16-
or you may use SPFx toolkit to validate and install these dependencies for you.
16+
or you can use SPFx toolkit to validate and install these dependencies for you.
1717

1818
![setup local workspace](../images/validate-dependency.png)
1919

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@
607607
"viewsWelcome": [
608608
{
609609
"view": "pnp-view-empty",
610-
"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\nLearn more about SharePoint Framework and this toolkit.\n[Walkthrough](command:spfx-toolkit.welcome)\n\n\n\nStart effortlessly with GitHub Copilot. Get SPFx tailored support in setting up your local workspace, creating a new project, or managing your tenant.\n[Use @SPFx in GitHub Copilot](command:spfx-toolkit.openCopilot) \n\n\n\n\n\nFor additional help or resources visit the [SPFX Toolkit docs](https://pnp.github.io/vscode-viva)."
610+
"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[Validate local setup](command:spfx-toolkit.checkDependencies)\n\n\n\n\n\nInstall the required dependencies.\n[Install dependencies](command:spfx-toolkit.installDependencies)\n\n\n\nLearn more about SharePoint Framework and this toolkit.\n[Walkthrough](command:spfx-toolkit.welcome)\n\n\n\nStart effortlessly with GitHub Copilot. Get SPFx tailored support in setting up your local workspace, creating a new project, or managing your tenant.\n[Use @SPFx in GitHub Copilot](command:spfx-toolkit.openCopilot) \n\n\n\n\n\nFor additional help or resources visit the [SPFX Toolkit docs](https://pnp.github.io/vscode-viva)."
611611
}
612612
],
613613
"commands": [

src/services/actions/Scaffolder.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import { getExtensionSettings, getPlatform } from '../../utils';
1515
import { PnPWebview } from '../../webview/PnPWebview';
1616
import { Executer } from '../executeWrappers/CommandExecuter';
1717
import { M365AgentsToolkitIntegration } from '../dataType/M365AgentsToolkitIntegration';
18-
import { TerminalCommandExecuter } from '../executeWrappers/TerminalCommandExecuter';
1918

2019

2120
export const PROJECT_FILE = 'project.pnp';

0 commit comments

Comments
 (0)