From 0dea4d3a72416b5cee0ae1c4b011418d951c7a8f Mon Sep 17 00:00:00 2001 From: mshanemc Date: Wed, 15 Mar 2023 16:25:30 -0500 Subject: [PATCH] feat: disable nut double-quote rule --- README.md | 3 +++ docs/rules/no-classes-in-command-return-type.md | 7 +++++++ docs/rules/no-execcmd-double-quotes.md | 7 +++++++ docs/rules/no-messages-load.md | 7 +++++++ src/index.ts | 2 +- 5 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 docs/rules/no-classes-in-command-return-type.md create mode 100644 docs/rules/no-execcmd-double-quotes.md create mode 100644 docs/rules/no-messages-load.md diff --git a/README.md b/README.md index 4be7838c..909a083f 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,10 @@ module.exports = { | [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-classes-in-command-return-type](docs/rules/no-classes-in-command-return-type.md) | The return type of the run method should not contain a class. | ✈️ ✅ | | 🔧 | | | [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-execcmd-double-quotes](docs/rules/no-execcmd-double-quotes.md) | Do not use double quotes in NUT examples. They will not work on windows | 📚 ✈️ ✅ | | 🔧 | | | [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 | | ✈️ ✅ | | | @@ -77,6 +79,7 @@ module.exports = { | [no-hyphens-aliases](docs/rules/no-hyphens-aliases.md) | Mark when an alias starts with a hyphen, like -f or --foo | ✈️ ✅ | | 🔧 | | | [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-messages-load](docs/rules/no-messages-load.md) | Use Messages.loadMessages() instead of Messages.load() | 📚 ✈️ ✅ | | 🔧 | | | [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 | ✈️ ✅ | | 🔧 | | diff --git a/docs/rules/no-classes-in-command-return-type.md b/docs/rules/no-classes-in-command-return-type.md new file mode 100644 index 00000000..246ce650 --- /dev/null +++ b/docs/rules/no-classes-in-command-return-type.md @@ -0,0 +1,7 @@ +# The return type of the run method should not contain a class (`sf-plugin/no-classes-in-command-return-type`) + +💼 This rule is enabled in the following configs: ✈️ `migration`, ✅ `recommended`. + +🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). + + diff --git a/docs/rules/no-execcmd-double-quotes.md b/docs/rules/no-execcmd-double-quotes.md new file mode 100644 index 00000000..c8ff49ac --- /dev/null +++ b/docs/rules/no-execcmd-double-quotes.md @@ -0,0 +1,7 @@ +# Do not use double quotes in NUT examples. They will not work on windows (`sf-plugin/no-execcmd-double-quotes`) + +💼 This rule is enabled in the following configs: 📚 `library`, ✈️ `migration`, ✅ `recommended`. + +🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). + + diff --git a/docs/rules/no-messages-load.md b/docs/rules/no-messages-load.md new file mode 100644 index 00000000..6bc65ff9 --- /dev/null +++ b/docs/rules/no-messages-load.md @@ -0,0 +1,7 @@ +# Use Messages.loadMessages() instead of Messages.load() (`sf-plugin/no-messages-load`) + +💼 This rule is enabled in the following configs: 📚 `library`, ✈️ `migration`, ✅ `recommended`. + +🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). + + diff --git a/src/index.ts b/src/index.ts index 2f7a07f9..81ba9492 100644 --- a/src/index.ts +++ b/src/index.ts @@ -51,7 +51,7 @@ const library = { rules: { 'sf-plugin/no-missing-messages': 'error', 'sf-plugin/no-messages-load': 'error', - 'sf-plugin/no-execcmd-double-quotes': 'error', + 'sf-plugin/no-execcmd-double-quotes': 'off', }, };