@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.3158148

package/docs/docs/cmd/spfx/project/project-externalize.mdx

@@ -0,0 +1,187 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spfx project externalize
+
+Externalizes SharePoint Framework project dependencies
+
+## Usage
+
+```sh
+m365 spfx project externalize [options]
+```
+
+## Options
+
+```md definition-list
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+
+`-h, --help`
+: output usage information
+
+`--query [query]`
+: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
+
+`-o, --output [output]`
+: Output type. `json`, `text`, `csv`, `md`. Default `json`
+
+`--verbose`
+: Runs command with verbose logging
+
+`--debug`
+: Runs command with debug logging
+```
+
+## Remarks
+
+:::info
+
+Run this command in the folder where the project for which you want to externalize dependencies is located. This command doesn't change your project files.
+
+:::
+    
+:::caution
+
+This command is in preview and could change once it's officially released. If you see any room for improvement, we'd love to hear from you at [https://github.com/pnp/cli-microsoft365/issues](https://github.com/pnp/cli-microsoft365/issues).
+
+:::
+
+The `spfx project externalize` command helps you externalize your SharePoint Framework project dependencies using the [unpkg CDN](https://unpkg.com/).
+
+This command doesn't change your project files. Instead, it gives you a report with all steps necessary to externalize your project dependencies. Externalizing project dependencies is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary changes and verify that everything is working as expected.
+
+Supported SharePoint Framework versions are 1.0.0, 1.0.1, 1.0.2, 1.1.0, 1.1.1, 1.1.3, 1.2.0, 1.3.0, 1.3.1, 1.3.2, 1.3.4, 1.4.0, 1.4.1, 1.5.0, 1.5.1, 1.6.0, 1.7.0, 1.7.1, 1.8.0, 1.8.1, 1.8.2, 1.9.1.
+
+## Examples
+
+Get instructions to externalize the current SharePoint Framework project dependencies and save the findings in a Markdown file
+
+```sh
+m365 spfx project externalize --output md > "deps-report.md"
+```
+
+Get instructions to externalize the current SharePoint Framework project dependencies and show the summary of the findings in the terminal
+
+```sh
+m365 spfx project externalize
+```
+
+## Response
+
+Below output will be produced to externalize the SharePoint Framework project dependencies.
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "externalConfiguration": {
+      "externals": {
+        "@pnp/sp": {
+          "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+          "globalName": "pnp.sp",
+          "globalDependencies": [
+            "@pnp/logging",
+            "@pnp/common",
+            "@pnp/odata",
+            "tslib"
+          ]
+        },
+        "tslib": {
+          "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+          "globalName": "tslib"
+        }
+      }
+    },
+    "edits": [
+      {
+        "action": "add",
+        "path": "C:\\react-global-news-sp2019\\src\\webparts\\news\\NewsWebPart.ts",
+        "targetValue": "require(\"tslib\");"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  In the config/config.json file update the externals property to:
+
+  {
+    "externalConfiguration": {
+      "externals": {
+        "@pnp/sp": {
+          "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+          "globalName": "pnp.sp",
+          "globalDependencies": [
+            "@pnp/logging",
+            "@pnp/common",
+            "@pnp/odata",
+            "tslib"
+          ]
+        },
+        "tslib": {
+          "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+          "globalName": "tslib"
+        }
+      }
+    },
+    "edits": [
+      {
+        "action": "add",
+        "path": "C:\\react-global-news-sp2019\\src\\webparts\\news\\NewsWebPart.ts",
+        "targetValue": "require(\"tslib\");"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ````md
+  # Externalizing dependencies of project react-global-news-sp2019
+
+  Date: 11/7/2022
+
+  ## Findings
+
+  ### Modify files
+
+  #### [config.json](config/config.json)
+
+  Replace the externals property (or add if not defined) with
+  
+  ```json
+  {
+    "externals": {
+      "@pnp/sp": {
+        "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+        "globalName": "pnp.sp",
+        "globalDependencies": [
+          "@pnp/logging",
+          "@pnp/common",
+          "@pnp/odata",
+          "tslib"
+        ]
+      },
+      "tslib": {
+        "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+        "globalName": "tslib"
+      }
+    }
+  }
+  ```
+
+  #### [C:\react-global-news-sp2019\src\webparts\news\NewsWebPart.ts](C:\react-global-news-sp2019\src\webparts\news\NewsWebPart.ts)
+  add
+  ```JavaScript
+  require("tslib");
+  ```
+  ````
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/spfx/project/project-permissions-grant.mdx

@@ -0,0 +1,101 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spfx project permissions grant
+
+Grant API permissions defined in the current SPFx project
+
+## Usage
+
+```sh
+m365 spfx project permissions grant [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::info
+
+Run this command in the folder where the project is located from where you want to grant the permissions.
+
+:::
+
+This command grant the permissions defined in: _package-solution.json_.
+
+## Examples
+
+Grant API permissions requested in the current SPFx project
+
+```sh
+m365 spfx project permissions grant
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
+    "ConsentType": "AllPrincipals",
+    "IsDomainIsolated": false,
+    "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
+    "PackageName": null,
+    "Resource": "Microsoft Graph",
+    "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
+    "Scope": "Mail.Read"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ClientId        : 6004a642-185c-479a-992a-15d1c23e2229
+  ConsentType     : AllPrincipals
+  IsDomainIsolated: false
+  ObjectId        : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+  PackageName     : null
+  Resource        : Microsoft Graph
+  ResourceId      : a46b0017-21e2-4db1-bc69-ca63576a38d6
+  Scope           : Mail.Read
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+  6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spfx project permissions grant
+
+  Date: 2/17/2023
+
+  ## QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+
+  Property | Value
+  ---------|-------
+  ClientId | 6004a642-185c-479a-992a-15d1c23e2229
+  ConsentType | AllPrincipals
+  IsDomainIsolated | false
+  ObjectId | QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+  PackageName | null
+  Resource | Microsoft Graph
+  ResourceId | a46b0017-21e2-4db1-bc69-ca63576a38d6
+  Scope | Mail.Read
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spfx/project/project-rename.mdx

@@ -0,0 +1,51 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spfx project rename
+
+Renames SharePoint Framework project
+
+## Usage
+
+```sh
+m365 spfx project rename [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --newName <newName>`
+: New name for the project
+
+`--generateNewId`
+: Generate a new solution ID for the project
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+Run this command in the folder where the project that you want to rename is located.
+
+:::
+
+This command will update the project name in: _package.json_, _.yo-rc.json_, _package-solution.json_, _deploy-azure-storage.json_ and _README.md_.
+
+## Examples
+
+Renames SharePoint Framework project to contoso
+
+```sh
+m365 spfx project rename --newName contoso
+```
+
+Renames SharePoint Framework project to contoso with new solution ID
+
+```sh
+m365 spfx project rename --newName contoso --generateNewId
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spfx/project/project-upgrade.mdx

@@ -0,0 +1,202 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spfx project upgrade
+
+Upgrades SharePoint Framework project to the specified version
+
+## Usage
+
+```sh
+m365 spfx project upgrade [options]
+```
+
+## Options
+
+```md definition-list
+`-v, --toVersion [toVersion]`
+: The version of SharePoint Framework to which upgrade the project
+
+`--packageManager [packageManager]`
+: The package manager you use. Supported managers `npm`, `pnpm`, `yarn`. Default `npm`
+
+`--shell [shell]`
+: The shell you use. Supported shells `bash`, `powershell`, `cmd`. Default `bash`
+
+`--preview`
+: Upgrade project to the latest SPFx preview version
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the upgrade report should be stored in. Ignored when `output` is `tour`
+```
+
+<Global />
+
+## Remarks
+
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.17.3).
+
+This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
+
+:::info
+
+Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
+
+:::
+
+## Examples
+
+Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and save the findings in a Markdown file
+
+```sh
+m365 spfx project upgrade --toVersion 1.5.0 --output md > "upgrade-report.md"
+```
+
+Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and show the summary of the findings in the shell
+
+```sh
+m365 spfx project upgrade --toVersion 1.5.0 --output text
+```
+
+Get instructions to upgrade the current SharePoint Framework project to the latest preview version
+
+```sh
+m365 spfx project upgrade --preview --output text
+```
+
+Get instructions to upgrade the current SharePoint Framework project to the specified preview version
+
+```sh
+m365 spfx project upgrade --toVersion 1.12.1-rc.0 --output text
+```
+
+Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using pnpm
+
+```sh
+m365 spfx project upgrade --packageManager pnpm --output text
+```
+
+Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365
+
+```sh
+m365 spfx project upgrade --output text
+```
+
+Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using PowerShell
+
+```sh
+m365 spfx project upgrade --shell powershell --output text
+```
+
+Get instructions to upgrade the current SharePoint Framework project to the latest version of SharePoint Framework and save the findings in a [CodeTour](https://aka.ms/codetour) file
+
+```sh
+m365 spfx project upgrade --output tour
+```
+
+## Response
+
+When upgrading an SPFx project built using version 1.15.0 to SPFx version 1.15.2, you'll get output similar to following (output is truncated):
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "description": "Upgrade SharePoint Framework dependency package @microsoft/sp-core-library",
+      "id": "FN001001",
+      "file": "./package.json",
+      "position": {
+        "line": 15,
+        "character": 5
+      },
+      "resolution": "npm i -SE @microsoft/sp-core-library@1.15.2",
+      "resolutionType": "cmd",
+      "severity": "Required",
+      "title": "@microsoft/sp-core-library"
+    },
+    {
+      "description": "Update version in .yo-rc.json",
+      "id": "FN010001",
+      "file": "./.yo-rc.json",
+      "position": {
+        "line": 5,
+        "character": 5
+      },
+      "resolution": "{\\\n  \"@microsoft/generator-sharepoint\": {\\\n    \"version\": \"1.15.2\"\\\n  }\\\n}",
+      "resolutionType": "json",
+      "severity": "Recommended",
+      "title": ".yo-rc.json version"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Execute in bash
+  -----------------------
+  npm i -SE @microsoft/sp-core-library@1.15.2
+
+  ./.yo-rc.json
+  -------------
+  Update version in .yo-rc.json:
+  {
+    "@microsoft/generator-sharepoint": {
+      "version": "1.15.2"
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ````md
+  # Upgrade project HelloWorld to v1.15.2
+
+  Date: 20/11/2022
+
+  ## Findings
+
+  Following is the list of steps required to upgrade your project to SharePoint Framework version 1.15.2. [Summary](#Summary) of the modifications is included at the end of the report.
+
+  ### FN001001 @microsoft/sp-core-library | Required
+
+  Upgrade SharePoint Framework dependency package @microsoft/sp-core-library
+
+  Execute the following command:
+
+  ```sh
+  npm i -SE @microsoft/sp-core-library@1.15.2
+  ```
+
+  File: [./package.json:17:5](./package.json)
+
+  ## Summary
+
+  ### Execute script
+
+  ```sh
+  npm i -SE @microsoft/sp-core-library@1.15.2
+  ```
+
+  ### Modify files
+
+  #### [./.yo-rc.json](./.yo-rc.json)
+
+  Update version in .yo-rc.json:
+
+  ```json
+  {
+    "@microsoft/generator-sharepoint": {
+      "version": "1.15.2"
+    }
+  }
+  ```
+  ````
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/spfx/spfx-doctor.mdx

@@ -0,0 +1,128 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spfx doctor
+
+Verifies environment configuration for using the specific version of the SharePoint Framework
+
+## Usage
+
+```sh
+m365 spfx doctor [options]
+```
+
+## Options
+
+```md definition-list
+`-e, --env [env]`
+: Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
+
+`-v, --spfxVersion [spfxVersion]`
+: Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
+
+`-h, --help`
+: output usage information
+
+`--query [query]`
+: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
+
+`-o, --output [output]`
+: Output type. `text`. Default `text`
+
+`--verbose`
+: Runs command with verbose logging
+
+`--debug`
+: Runs command with debug logging
+```
+
+## Remarks
+
+This commands helps you to verify if your environment meets all prerequisites for building solutions using a particular version of the SharePoint Framework.
+
+The command starts by detecting the version of SharePoint Framework that you want to use. First, it looks at the current project. If you didn't run the command in the context of a SharePoint Framework project, the command will try to determine the SharePoint Framework version based on the SharePoint Framework Yeoman generator that you have installed either in the current directory or globally.
+
+Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp CLI and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
+
+If you miss any required tools or use a version that doesn't meet the SharePoint Framework requirements, the command will give you a list of recommendation how to address these issues.
+
+Next to verifying the readiness of your environment to use a particular version of the SharePoint Framework, you can also check if the version of the SharePoint Framework that you use is compatible with the specific version of SharePoint. Supported versions are `sp2016`, `sp2019` and `spo`.
+
+:::info
+
+Checks ran by this command are based on what is officially supported by Microsoft. It's possible that using different package managers or packages versions will work just fine.
+
+:::
+
+:::info
+
+This command supports only text output.
+
+:::
+
+## Examples
+
+Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
+
+```sh
+m365 spfx doctor --output text
+```
+
+Verify if your environment meets the requirements to work with the SharePoint Framework and also if the version of the SharePoint Framework that you're using is compatible with SharePoint 2019
+
+```sh
+m365 spfx doctor --env sp2019 --output text
+```
+
+Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
+
+```sh
+m365 spfx doctor --spfxVersion 1.11.0 --output text
+```
+
+## Response
+
+### Response with no issues
+
+<Tabs>
+  <TabItem value="Text">
+
+  ```text
+  CLI for Microsoft 365 SharePoint Framework doctor
+  Verifying configuration of your system for working with the SharePoint Framework
+
+  √ SharePoint Framework v1.15.0
+  √ Node v16.13.0    
+  √ yo v4.3.0
+  √ gulp-cli v2.3.0
+  √ bundled typescript used
+  ```
+
+  </TabItem>
+</Tabs>
+
+### Response with issues reported
+
+When the installed version of Yeoman is lower than expected to run SharePoint Framework v1.15.0
+
+<Tabs>
+  <TabItem value="Text">
+
+  ```text
+  CLI for Microsoft 365 SharePoint Framework doctor
+  Verifying configuration of your system for working with the SharePoint Framework
+
+  √ SharePoint Framework v1.15.0
+  √ Node v16.16.0
+  × yo v3.1.1 found, v^4 required
+  √ gulp-cli v2.3.0
+  √ bundled typescript used
+
+  Recommended fixes:
+
+  - npm i -g yo@4
+  ```
+
+  </TabItem>
+</Tabs>
+