Skip to content

Commit

Permalink
feat: docs for library config
Browse files Browse the repository at this point in the history
  • Loading branch information
@mshanemc
mshanemc committed Jan 26, 2023
1 parent 6288f33 commit 3e18912
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 132 deletions.
78 changes: 40 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,48 +48,50 @@ module.exports = {

💼 Configurations enabled in.\
⚠️ Configurations set to warn in.\
📚 Set in the `library` configuration.\
✈️ Set in the `migration` configuration.\
✅ Set in the `recommended` configuration.\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

| Name                           | Description | 💼 | ⚠️ | 🔧 | 💡 |
| :----------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ | :---------------------- | :--- | :- | :- |
| [command-example](docs/rules/command-example.md) | Ensure commands have a summary, description, and examples | | ✈️ ✅ | | |
| [command-summary](docs/rules/command-summary.md) | Ensure commands have a summary | ✈️ ✅ | | 🔧 | |
| [dash-o](docs/rules/dash-o.md) | Warn on a flag that uses -o | | ✈️ ✅ | | |
| [encourage-alias-deprecation](docs/rules/encourage-alias-deprecation.md) | Commands and flags aliases probably want to deprecate their old names to provide more warnings to users | | ✈️ | 🔧 | 💡 |
| [flag-case](docs/rules/flag-case.md) | Enforce lowercase kebab-case flag names | ✈️ ✅ | | 🔧 | |
| [flag-cross-references](docs/rules/flag-cross-references.md) | Enforce flag cross references for dependOn,exclusive,exactlyOne | ✈️ ✅ | | | |
| [flag-min-max-default](docs/rules/flag-min-max-default.md) | Enforce that flags with min/max values have a default value | | ✈️ ✅ | | |
| [flag-summary](docs/rules/flag-summary.md) | Enforce that flags have a summary property and that longDescription is renamed to description | ✈️ ✅ | | 🔧 | |
| [get-connection-with-version](docs/rules/get-connection-with-version.md) | Calls to getConnection should pass in a version | | ✈️ ✅ | | |
| [id-flag-suggestions](docs/rules/id-flag-suggestions.md) | Create better salesforceId flags with length and startsWith properties | | ✈️ ✅ | 🔧 | 💡 |
| [no-builtin-flags](docs/rules/no-builtin-flags.md) | Handling for sfdxCommand's flags.builtin | ✈️ | | 🔧 | |
| [no-deprecated-properties](docs/rules/no-deprecated-properties.md) | Removes non-existent properties left over from SfdxCommand | ✈️ | | 🔧 | |
| [no-duplicate-short-characters](docs/rules/no-duplicate-short-characters.md) | Prevent duplicate use of short characters or conflicts between aliases and flags | ✈️ ✅ | | | |
| [no-filepath-flags](docs/rules/no-filepath-flags.md) | Change filepath flag to file flag | | | 🔧 | |
| [no-h-short-char](docs/rules/no-h-short-char.md) | Do not allow creation of a flag with short char -h | ✈️ ✅ | | | |
| [no-hardcoded-messages-commands](docs/rules/no-hardcoded-messages-commands.md) | Use loaded messages and separate files for messages | | ✈️ ✅ | | |
| [no-hardcoded-messages-flags](docs/rules/no-hardcoded-messages-flags.md) | Use loaded messages and separate files for messages | | ✈️ ✅ | | |
| [no-id-flags](docs/rules/no-id-flags.md) | Change Id flag to salesforceId | ✈️ | | 🔧 | |
| [no-json-flag](docs/rules/no-json-flag.md) | Do not allow creation of json flag | ✈️ ✅ | | | |
| [no-missing-messages](docs/rules/no-missing-messages.md) | Checks core Messages usage for correct usage of named messages and message tokens | ![badge-library][] ✈️ ✅ | | | |
| [no-number-flags](docs/rules/no-number-flags.md) | Change number flag to integer | | | 🔧 | |
| [no-oclif-flags-command-import](docs/rules/no-oclif-flags-command-import.md) | Change import of flags and Command from oclif to use sf-plugins-core | ✈️ ✅ | | 🔧 | |
| [no-sfdx-command-import](docs/rules/no-sfdx-command-import.md) | Change import and base class from SfdxCommand to sfCommand | ✈️ | | 🔧 | |
| [no-split-examples](docs/rules/no-split-examples.md) | Arrays of messags should use getMessages instead of getMessage followed by EOL splitting | ✈️ ✅ | | 🔧 | |
| [no-this-flags](docs/rules/no-this-flags.md) | Fix references to this.org (property on SfdxCommand) | ✈️ | | 🔧 | 💡 |
| [no-this-org](docs/rules/no-this-org.md) | Fix references to this.org (property on SfdxCommand) | ✈️ | | 🔧 | 💡 |
| [no-this-ux](docs/rules/no-this-ux.md) | SfCommand does not have a ux property | ✈️ | | 🔧 | |
| [no-time-flags](docs/rules/no-time-flags.md) | Migrate time flags to Flags.duration | ✈️ | | 🔧 | |
| [no-unnecessary-aliases](docs/rules/no-unnecessary-aliases.md) | Mark when an alias is unnecessary because its only an order permutation, not really a different name | ✈️ ✅ | | 🔧 | |
| [no-unnecessary-properties](docs/rules/no-unnecessary-properties.md) | Boolean properties are false by default, so they should not be set to false | | ✈️ ✅ | 🔧 | |
| [no-username-properties](docs/rules/no-username-properties.md) | Convert requiresUsername and supportusername to username flags | ✈️ | | 🔧 | |
| [read-only-properties](docs/rules/read-only-properties.md) | Class-level static properties, like flags or descriptions, should be marked read-only | | ✈️ ✅ | 🔧 | |
| [run-matches-class-type](docs/rules/run-matches-class-type.md) | The return type of the run method should match the Type passed to sfCommand | ✈️ ✅ | | 🔧 | |
| [sfdx-flags-property](docs/rules/sfdx-flags-property.md) | Change flag definitions to SfCommand version | ✈️ | | 🔧 | |
| [should-parse-flags](docs/rules/should-parse-flags.md) | The run method should call this.parse when there are flags | ✈️ | | 🔧 | |
| [use-sf-command-flags](docs/rules/use-sf-command-flags.md) | Use Flags export from sf-plugins-core | ✈️ | | 🔧 | |
| Name                               | Description | 💼 | ⚠️ | 🔧 | 💡 |
| :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ | :------ | :--- | :- | :- |
| [command-example](docs/rules/command-example.md) | Ensure commands have a summary, description, and examples | | ✈️ ✅ | | |
| [command-summary](docs/rules/command-summary.md) | Ensure commands have a summary | ✈️ ✅ | | 🔧 | |
| [dash-o](docs/rules/dash-o.md) | Warn on a flag that uses -o | | ✈️ ✅ | | |
| [encourage-alias-deprecation](docs/rules/encourage-alias-deprecation.md) | Commands and flags aliases probably want to deprecate their old names to provide more warnings to users | | ✈️ | 🔧 | 💡 |
| [flag-case](docs/rules/flag-case.md) | Enforce lowercase kebab-case flag names | ✈️ ✅ | | 🔧 | |
| [flag-cross-references](docs/rules/flag-cross-references.md) | Enforce flag cross references for dependOn,exclusive,exactlyOne | ✈️ ✅ | | | |
| [flag-min-max-default](docs/rules/flag-min-max-default.md) | Enforce that flags with min/max values have a default value | | ✈️ ✅ | | |
| [flag-summary](docs/rules/flag-summary.md) | Enforce that flags have a summary property and that longDescription is renamed to description | ✈️ ✅ | | 🔧 | |
| [get-connection-with-version](docs/rules/get-connection-with-version.md) | Calls to getConnection should pass in a version | | ✈️ ✅ | | |
| [id-flag-suggestions](docs/rules/id-flag-suggestions.md) | Create better salesforceId flags with length and startsWith properties | | ✈️ ✅ | 🔧 | 💡 |
| [no-args-parse-without-strict-false](docs/rules/no-args-parse-without-strict-false.md) | If you parse args/argv, the class should have strict set to false | ✈️ ✅ | | 🔧 | |
| [no-builtin-flags](docs/rules/no-builtin-flags.md) | Handling for sfdxCommand's flags.builtin | ✈️ | | 🔧 | |
| [no-deprecated-properties](docs/rules/no-deprecated-properties.md) | Removes non-existent properties left over from SfdxCommand | ✈️ | | 🔧 | |
| [no-duplicate-short-characters](docs/rules/no-duplicate-short-characters.md) | Prevent duplicate use of short characters or conflicts between aliases and flags | ✈️ ✅ | | | |
| [no-filepath-flags](docs/rules/no-filepath-flags.md) | Change filepath flag to file flag | | | 🔧 | |
| [no-h-short-char](docs/rules/no-h-short-char.md) | Do not allow creation of a flag with short char -h | ✈️ ✅ | | | |
| [no-hardcoded-messages-commands](docs/rules/no-hardcoded-messages-commands.md) | Use loaded messages and separate files for messages | | ✈️ ✅ | | |
| [no-hardcoded-messages-flags](docs/rules/no-hardcoded-messages-flags.md) | Use loaded messages and separate files for messages | | ✈️ ✅ | | |
| [no-id-flags](docs/rules/no-id-flags.md) | Change Id flag to salesforceId | ✈️ | | 🔧 | |
| [no-json-flag](docs/rules/no-json-flag.md) | Do not allow creation of json flag | ✈️ ✅ | | | |
| [no-missing-messages](docs/rules/no-missing-messages.md) | Checks core Messages usage for correct usage of named messages and message tokens | 📚 ✈️ ✅ | | | |
| [no-number-flags](docs/rules/no-number-flags.md) | Change number flag to integer | | | 🔧 | |
| [no-oclif-flags-command-import](docs/rules/no-oclif-flags-command-import.md) | Change import of flags and Command from oclif to use sf-plugins-core | ✈️ ✅ | | 🔧 | |
| [no-sfdx-command-import](docs/rules/no-sfdx-command-import.md) | Change import and base class from SfdxCommand to sfCommand | ✈️ | | 🔧 | |
| [no-split-examples](docs/rules/no-split-examples.md) | Arrays of messags should use getMessages instead of getMessage followed by EOL splitting | ✈️ ✅ | | 🔧 | |
| [no-this-flags](docs/rules/no-this-flags.md) | Fix references to this.org (property on SfdxCommand) | ✈️ | | 🔧 | 💡 |
| [no-this-org](docs/rules/no-this-org.md) | Fix references to this.org (property on SfdxCommand) | ✈️ | | 🔧 | 💡 |
| [no-this-ux](docs/rules/no-this-ux.md) | SfCommand does not have a ux property | ✈️ | | 🔧 | |
| [no-time-flags](docs/rules/no-time-flags.md) | Migrate time flags to Flags.duration | ✈️ | | 🔧 | |
| [no-unnecessary-aliases](docs/rules/no-unnecessary-aliases.md) | Mark when an alias is unnecessary because its only an order permutation, not really a different name | ✈️ ✅ | | 🔧 | |
| [no-unnecessary-properties](docs/rules/no-unnecessary-properties.md) | Boolean properties are false by default, so they should not be set to false | | ✈️ ✅ | 🔧 | |
| [no-username-properties](docs/rules/no-username-properties.md) | Convert requiresUsername and supportusername to username flags | ✈️ | | 🔧 | |
| [read-only-properties](docs/rules/read-only-properties.md) | Class-level static properties, like flags or descriptions, should be marked read-only | | ✈️ ✅ | 🔧 | |
| [run-matches-class-type](docs/rules/run-matches-class-type.md) | The return type of the run method should match the Type passed to sfCommand | ✈️ ✅ | | 🔧 | |
| [sfdx-flags-property](docs/rules/sfdx-flags-property.md) | Change flag definitions to SfCommand version | ✈️ | | 🔧 | |
| [should-parse-flags](docs/rules/should-parse-flags.md) | The run method should call this.parse when there are flags | ✈️ | | 🔧 | |
| [use-sf-command-flags](docs/rules/use-sf-command-flags.md) | Use Flags export from sf-plugins-core | ✈️ | | 🔧 | |

<!-- end auto-generated rules list -->
2 changes: 1 addition & 1 deletion docs/rules/no-missing-messages.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Checks core Messages usage for correct usage of named messages and message tokens (`sf-plugin/no-missing-messages`)

💼 This rule is enabled in the following configs: `library`, ✈️ `migration`, ✅ `recommended`.
💼 This rule is enabled in the following configs: 📚 `library`, ✈️ `migration`, ✅ `recommended`.

<!-- end auto-generated rule header -->
4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@
"lint": "yarn eslint .",
"test": "jest --coverage",
"test:watch": "jest --watch",
"docs": "eslint-doc-generator --config-emoji migration,✈️ --config-emoji library,📖",
"docs:init": "eslint-doc-generator --config-emoji migration,✈️ --config-emoji library,📖 --init-rule-docs"
"docs": "eslint-doc-generator --config-emoji migration,✈️ --config-emoji library,📚",
"docs:init": "eslint-doc-generator --config-emoji migration,✈️ --config-emoji library📚, --init-rule-docs"
},
"homepage": "https://github.com/salesforcecli/eslint-plugin-sf-plugin",
"publishConfig": {
Expand Down
Loading

0 comments on commit 3e18912

Please sign in to comment.