Skip to content

Commit

Permalink
Merge branch 'migrate-sf-plugin' into alpha
Browse files Browse the repository at this point in the history
  • Loading branch information
@nvuillam
nvuillam committed Sep 16, 2024
2 parents 391905e + af8fc67 commit b7fa633
Show file tree
Hide file tree
Showing 117 changed files with 1,485 additions and 1,489 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ We made many tests but risk zero do not exist, so if you see any bug, please rep
- Reorganize README content
- Add link to Dreamforce 24 session
- Deployment assistant: Improve documentation by adding examples of errors, and a standalone page for each tip
- Factorize the definition of DOC_ROOT_URL https://sfdx-hardis.cloudity.com
- Factorize the definition of DOC_ROOT_URL <https://sfdx-hardis.cloudity.com>

### Deprecations

Expand Down
272 changes: 136 additions & 136 deletions docs/commands.md
View file

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/hardis/auth/login.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ Login to salesforce org

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|devhub<br/>-h|boolean|Also connect associated DevHub||||
|flags-dir|option|undefined||||
|instanceurl<br/>-r|option|URL of org instance||||
|json|boolean|Format output as json.||||
|scratchorg<br/>-s|boolean|Scratch org||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:-------------------|:-------:|:--------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| devhub<br/>-h | boolean | Also connect associated DevHub | | | |
| flags-dir | option | undefined | | | |
| instanceurl<br/>-r | option | URL of org instance | | | |
| json | boolean | Format output as json. | | | |
| scratchorg<br/>-s | boolean | Scratch org | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:auth:login
sf hardis:auth:login
```


16 changes: 8 additions & 8 deletions docs/hardis/cache/clear.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ Clear cache generated by sfdx-hardis

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:-------------|:-------:|:--------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:cache:clear
sf hardis:cache:clear
```


18 changes: 9 additions & 9 deletions docs/hardis/config/get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Returns sfdx-hardis project config for a given level

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|level<br/>-l|option|project,branch or user|project||project<br/>branch<br/>user|
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:-------------|:-------:|:--------------------------------------------------------------|:-------:|:--------:|:---------------------------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| level<br/>-l | option | project,branch or user | project | | project<br/>branch<br/>user |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:project:deploy:sources:metadata
sf hardis:project:deploy:sources:metadata
```


18 changes: 9 additions & 9 deletions docs/hardis/doc/extract/permsetgroups.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Generate markdown files with project documentation

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|outputfile<br/>-o|option|Force the path and name of output report file. Must end with .csv||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:------------------|:-------:|:------------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| outputfile<br/>-o | option | Force the path and name of output report file. Must end with .csv | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:doc:extract:permsetgroups
sf hardis:doc:extract:permsetgroups
```


16 changes: 8 additions & 8 deletions docs/hardis/doc/plugin/generate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ At each merge into master/main branch, the GitHub Action build-deploy-docs will

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:-------------|:-------:|:--------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:doc:plugin:generate
sf hardis:doc:plugin:generate
```


28 changes: 14 additions & 14 deletions docs/hardis/lint/access.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,30 @@ This command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.co

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|elementsignored<br/>-e|option|Ignore specific elements separated by commas||||
|flags-dir|option|undefined||||
|folder<br/>-f|option|Root folder|force-app|||
|ignorerights<br/>-i|option|Ignore permission sets or profiles||||
|json|boolean|Format output as json.||||
|outputfile<br/>-o|option|Force the path and name of output report file. Must end with .csv||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:-----------------------|:-------:|:------------------------------------------------------------------|:---------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| elementsignored<br/>-e | option | Ignore specific elements separated by commas | | | |
| flags-dir | option | undefined | | | |
| folder<br/>-f | option | Root folder | force-app | | |
| ignorerights<br/>-i | option | Ignore permission sets or profiles | | | |
| json | boolean | Format output as json. | | | |
| outputfile<br/>-o | option | Force the path and name of output report file. Must end with .csv | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:lint:access
sf hardis:lint:access
```

```shell
$ sf hardis:lint:access -e "ApexClass:ClassA, CustomField:Account.CustomField"
sf hardis:lint:access -e "ApexClass:ClassA, CustomField:Account.CustomField"
```

```shell
$ sf hardis:lint:access -i "PermissionSet:permissionSetA, Profile"
sf hardis:lint:access -i "PermissionSet:permissionSetA, Profile"
```


18 changes: 9 additions & 9 deletions docs/hardis/lint/metadatastatus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ This command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.co

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|outputfile<br/>-o|option|Force the path and name of output report file. Must end with .csv||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:------------------|:-------:|:------------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| outputfile<br/>-o | option | Force the path and name of output report file. Must end with .csv | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:lint:metadatastatus
sf hardis:lint:metadatastatus
```


18 changes: 9 additions & 9 deletions docs/hardis/lint/missingattributes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Check if elements(custom fields) aren't description

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|outputfile<br/>-o|option|Force the path and name of output report file. Must end with .csv||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:------------------|:-------:|:------------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| outputfile<br/>-o | option | Force the path and name of output report file. Must end with .csv | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:lint:missingattributes
sf hardis:lint:missingattributes
```


18 changes: 9 additions & 9 deletions docs/hardis/lint/unusedmetadatas.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ This command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.co

## Parameters

|Name|Type|Description|Default|Required|Options|
|:---|:--:|:----------|:-----:|:------:|:-----:|
|debug<br/>-d|boolean|Activate debug mode (more logs)||||
|flags-dir|option|undefined||||
|json|boolean|Format output as json.||||
|outputfile<br/>-o|option|Force the path and name of output report file. Must end with .csv||||
|skipauth|boolean|Skip authentication check when a default username is required||||
|websocket|option|Websocket host:port for VsCode SFDX Hardis UI integration||||
| Name | Type | Description | Default | Required | Options |
|:------------------|:-------:|:------------------------------------------------------------------|:-------:|:--------:|:-------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| flags-dir | option | undefined | | | |
| json | boolean | Format output as json. | | | |
| outputfile<br/>-o | option | Force the path and name of output report file. Must end with .csv | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
$ sf hardis:lint:unusedmetadatas
sf hardis:lint:unusedmetadatas
```


Loading

0 comments on commit b7fa633

Please sign in to comment.