Skip to content

Commit 42f5e58

Browse files
authored
Update UseCompatibleTypes docs with more info
- Fix typo in example configuration - Add table explaining configuration keys for rule configuration
1 parent 7874b55 commit 42f5e58

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

RuleDocumentation/UseCompatibleTypes.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,21 @@ If a type is not present in the union profile, it is assumed to be locally creat
6767
Otherwise, if a type is present in the union profile but not present in a target,
6868
it is deemed to be incompatible with that target.
6969

70+
## Configuration settings
71+
72+
| Configuration key | Meaning | Accepted values | Mandatory | Example |
73+
| ----------------- | ------- | --------------- | --------- | ------- |
74+
| `Enable` | Activates the rule | bool (`$true`/`$false`) | No (default: `$false`) | `$true` |
75+
| `TargetProfiles` | The list of PowerShell profiles to target | string[]: absolute paths to profile files or names of profiles in the profile directory | No (default: `@()`) | `@('ubuntu_x64_18.04_6.1.3_x64_4.0.30319.42000_core', 'win-48_x64_10.0.17763.0_5.1.17763.316_x64_4.0.30319.42000_framework')` |
76+
| `ProfileDirPath` | The location to search for profiles by name and use for union profile generation | string: absolute path to new profile dir | No (defaults to `compatibility_profiles` directory in PSScriptAnalyzer module | `C:\Users\me\Documents\pssaCompatProfiles` |
77+
| `IgnoreTypes` | Full names of types or type accelerators to ignore compatibility of in scripts | string[]: names of types to ignore | No (default: `@()`) | `@('System.Collections.ArrayList','string')` |
78+
7079
An example configuration might look like:
7180

7281
```PowerShell
7382
@{
7483
Rules = @{
75-
UseCompatibleTypes = @{
84+
PSUseCompatibleTypes = @{
7685
Enable = $true
7786
TargetProfiles = @(
7887
'ubuntu_x64_18.04_6.1.3_x64_4.0.30319.42000_core'

0 commit comments

Comments
 (0)