Skip to content

Commit 6b325e6

Browse files
priyanshu92claude
andcommitted
Add complete settings reference to README
- Surface all 18 user-facing settings from package.json in README, grouped by category (General, Copilot, PCF Debugging, Power Pages, Web Extension) with type, default, and description columns - Add README Maintenance section to Agents.md instructing agents to keep the settings table in sync when modifying package.json Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 22da2a0 commit 6b325e6

2 files changed

Lines changed: 51 additions & 9 deletions

File tree

Agents.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,8 @@ npm run test-web-integration # Web integration tests
120120
- Use `oneDSLoggerWrapper` for all telemetry events
121121
- Events defined in `src/common/OneDSLoggerTelemetry/telemetryConstants.ts`
122122
- Separate telemetry for desktop vs web experiences
123+
124+
### README Maintenance
125+
126+
- When adding, removing, or modifying a setting in the `configuration.properties` section of `package.json`, update the corresponding settings table in `README.md` under the **Configuration** section to keep it in sync.
127+
- Settings in the README are grouped by category: General, Copilot, PCF Debugging, Power Pages, and Web Extension. Place new settings in the appropriate group.

README.md

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,52 @@ This extension bundles the following extensions:
7878

7979
## Configuration
8080

81-
Key settings (available under `powerPlatform.*` in VS Code settings):
82-
83-
| Setting | Description |
84-
|---|---|
85-
| `powerPlatform.auth.cloud` | Target cloud environment (Public, USGov, USGovHigh, USGovDoD, China) |
86-
| `powerPlatform.experimental.copilotEnabled` | Enable/disable Copilot for Power Pages (default: true) |
87-
| `powerPlatform.experimental.enablePcfDebuggingFeatures` | Enable PCF debugging capabilities |
88-
| `powerPlatform.experimental.defaultUrl` | Default PowerApps instance URL for debugging |
89-
| `powerPlatform.experimental.browserFlavor` | Edge browser version for PCF debugging (Stable, Beta, Dev, Canary) |
81+
All settings are available under `powerPlatform.*` in VS Code settings.
82+
83+
### General
84+
85+
| Setting | Type | Default | Description |
86+
|---|---|---|---|
87+
| `powerPlatform.auth.cloud` | `string` | `Public` | Azure cloud to use for authentication. Options: `Public`, `USGov`, `USGovHigh`, `USGovDoD`, `China` |
88+
| `powerPlatform.generatorInstalled` | `boolean` | `false` | Whether the generator installation is complete |
89+
| `powerPlatform.experimental.disableActivityBarPanels` | `boolean` | `false` | Disable the Power Platform activity bar panels |
90+
| `powerPlatform.experimental.enableTelemetry` | `boolean` | `true` | Enable custom telemetry for Power Pages |
91+
92+
### Copilot
93+
94+
| Setting | Type | Default | Description |
95+
|---|---|---|---|
96+
| `powerPlatform.experimental.copilotEnabled` | `boolean` | `true` | Enable Copilot for Power Pages (desktop) |
97+
| `powerPlatform.experimental.enableWebCopilot` | `boolean` | `true` | Enable Copilot for Power Pages (web) |
98+
99+
### PCF Debugging
100+
101+
| Setting | Type | Default | Description |
102+
|---|---|---|---|
103+
| `powerPlatform.experimental.enablePcfDebuggingFeatures` | `boolean` | `false` | Enable debugger features for PCF controls |
104+
| `powerPlatform.experimental.defaultUrl` | `string` | `""` | URL to your PowerApps instance where the PCF control is located. Overrides `url` in launch.json |
105+
| `powerPlatform.experimental.port` | `number` | `9222` | Port to search for remote debuggable instances |
106+
| `powerPlatform.experimental.webRoot` | `string` | `""` | Absolute path to the webserver root. Supports `${workspaceFolder}`. Overrides `webRoot` in launch.json |
107+
| `powerPlatform.experimental.appId` | `string` | `00000000-...` | Model-driven app ID hosting the PCF control. Only required for full-screen controls. Overrides `appId` in launch.json |
108+
| `powerPlatform.experimental.userDataDir` | `string` | `""` | Custom Edge user profile path. Ignored if `useDefaultUserDataProfile` is true |
109+
| `powerPlatform.experimental.useDefaultUserDataProfile` | `boolean` | `false` | Use your default browser profile for debugging instead of a temporary one |
110+
| `powerPlatform.experimental.browserFlavor` | `string` | `Default` | Edge browser version: `Default`, `Stable`, `Beta`, `Dev`, `Canary` |
111+
| `powerPlatform.experimental.browserArgs` | `array` | `[]` | Custom Edge launch arguments (requires restarting VS Code) |
112+
113+
### Power Pages
114+
115+
| Setting | Type | Default | Description |
116+
|---|---|---|---|
117+
| `powerPlatform.pages.downloadSiteFolder` | `string` | `""` | Folder path for downloading Power Pages sites |
118+
| `powerPlatform.pages.confirmDifferentWebsiteComparison` | `boolean` | `true` | Prompt for confirmation when comparing a different website |
119+
120+
### Web Extension
121+
122+
| Setting | Type | Default | Description |
123+
|---|---|---|---|
124+
| `powerPlatform.experimental.enableVersionControl` | `boolean` | `true` | Enable version control on file save (web only) |
125+
| `powerPlatform.experimental.enableMultiFileFeature` | `boolean` | `true` | Enable multiple file view (web only) |
126+
| `powerPlatform.experimental.enableCoPresenceFeature` | `boolean` | `true` | Enable co-presence / collaboration view (web only) |
90127

91128
## Feedback & Questions
92129

0 commit comments

Comments
 (0)