Plugins not added when specified by rule converters

[stkevintan]

🐛 Bug Report

• tslint-to-eslint-config version: 1.0.0
• ESLint version: 7.2.0
• Node version: 14.4.0

Actual Behavior

after converting, show serveral errors:

    1:1   error  Definition for rule '@typescript-eslint/class-name-casing' was not found      @typescript-eslint/class-name-casing
    1:1   error  Definition for rule '@typescript-eslint/interface-name-prefix' was not found  @typescript-eslint/interface-name-prefix
    1:1   error  Definition for rule 'import/order' was not found                              import/order
    1:1   error  Definition for rule 'jsdoc/check-alignment' was not found                     jsdoc/check-alignment
    1:1   error  Definition for rule 'jsdoc/check-indentation' was not found                   jsdoc/check-indentation
    1:1   error  Definition for rule 'jsdoc/newline-after-description' was not found           jsdoc/newline-after-description
    1:1   error  Definition for rule 'prefer-arrow/prefer-arrow-functions' was not found       prefer-arrow/prefer-arrow-functions

Expected Behavior

No Error

Reproduction

[KingDarBoja]

Hi @stkevintan

Some of these rules are either deprecated (like #596) or requires a plugin to be installed (like prefer-arrow/prefer-arrow-functions).

We will take a look at them to see which ones can be fixed on next release.

[stkevintan]

yeah, may be some stuff outdated, thanks!

[JoshuaKGoldberg]

Hi! Indeed, there might be some configuration you'll have to do to get the new config to work with all its rules. @stkevintan - would be up for posting your original tslint.json?

When you run tslint-to-eslint-config, it should print out a list of packages you'll need to install (npm install / yarn install). We'll want to check if that command is missing any packages you'll need.

[stkevintan]

@JoshuaKGoldberg Sure:

{
  "linterOptions": {
      "exclude": [
          "ref/**"
      ]
  },
  "rules": {
      "await-promise": [
        true,
        "Promise",
        "PromiseLike",
        "Thenable"
      ],
      "no-unused-expression": true,
      "no-duplicate-variable": true,
      "no-inferrable-types": true,
      "curly": true,
      "class-name": true,
      "comment-format": [
          true,
          "check-space"
      ],
      "eofline": true,
      "forin": false,
      "import-blacklist": [
          true,
          "__comment: Add this to avoid import index.ts",
          "..",
          "../..",
      ],
      "indent": [
          true,
          "spaces",
          4
      ],
      "interface-name": [
          true,
          "always-prefix"
      ],
      "jsdoc-format": true,
      "label-position": true,
      "max-line-length": [
          false
      ],
      "member-ordering": [
          false
      ],
      "no-arg": true,
      "no-bitwise": false,
      "no-console": true,
      "no-construct": true,
      "no-debugger": true,
      "no-default-export": false,
      "no-empty": [
          true,
          "allow-empty-functions"
      ],
      "no-eval": true,
      "no-string-literal": false,
      "no-switch-case-fall-through": true,
      "no-use-before-declare": false,
      "no-var-requires": false,
      "one-line": [
          true,
          "check-open-brace",
          "check-catch",
          "check-else",
          "check-whitespace"
      ],
      "only-arrow-functions": [
          true,
          "allow-declarations",
          "allow-named-functions"
      ],
      "ordered-imports": true,
      "object-literal-shorthand": true,
      "quotemark": [
          true,
          "single",
          "avoid-escape"
      ],
      "radix": true,
      "semicolon": [
          true,
          "always",
          "ignore-bound-class-methods"
      ],
      "trailing-comma": [
          true,
          {
              "multiline": "never",
              "singleline": "never"
          }
      ],
      "triple-equals": [
          true,
          "allow-null-check"
      ],
      "typedef": [
          true,
          "call-signature"
      ],
      "typedef-whitespace": [
          true,
          {
              "index-signature": "nospace",
              "parameter": "nospace",
              "property-declaration": "nospace",
              "variable-declaration": "nospace"
          },
          {
              "index-signature": "space",
              "parameter": "space",
              "property-declaration": "space",
              "variable-declaration": "space"
          }
      ],
      "variable-name": [
          true,
          "allow-leading-underscore"
      ],
      "whitespace": [
          true,
          "check-branch",
          "check-decl",
          "check-operator",
          "check-separator",
          "check-type"
      ]
  }
}

and all the recommanded packages are installed already

[alfonsoar]

I also hit this issue, the two rules below were easy to fix since they are now part of "@typescript-eslint/naming-convention".

@typescript-eslint/class-name-casing
@typescript-eslint/interface-name-prefix

Attaching my original tslint in case it helps.

Click to expand code snippet

{
"defaultSeverity": "error",
"extends": [
"tslint:recommended"
],
"jsRules":{
"object-literal-sort-keys": false
},
"rules": {
"trailing-comma": [ false ],
"no-console": false,
"object-literal-sort-keys": false
},
"rulesDirectory": []
}

[KingDarBoja]

I also hit this issue, the two rules below were easy to fix since they are now part of "@typescript-eslint/naming-convention".

@typescript-eslint/class-name-casing
@typescript-eslint/interface-name-prefix

Attaching my original tslint in case it helps.

Click to expand code snippet

Those rules are being fixed at #617

[JoshuaKGoldberg]

Just following up, I re-ran with the posted tslint settings and got this message:

✨ 43 rules replaced with their ESLint equivalents. ✨

❗ 5 ESLint rules behave differently from their TSLint counterparts ❗
  Check ./tslint-to-eslint-config.log for details.

❓ 2 rules are not known by tslint-to-eslint-config to have ESLint equivalents. ❓
  The "@typescript-eslint/tslint/config" section of ./.eslintrc.js configures eslint-plugin-tslint to run them in TSLint within ESLint.
  Check ./tslint-to-eslint-config.log for details.

☠ Prettier plugins are missing from your configuration. ☠
  We highly recommend running tslint-to-eslint-config --prettier to disable formatting ESLint rules.
  See https://github.com/typescript-eslint/tslint-to-eslint-config/blob/master/docs/FAQs.md#should-i-use-prettier.

♻ Consider using --comments to replace TSLint comment directives in your source files. ♻

⚡ 7 new packages are required for this ESLint configuration. ⚡
  npm install @typescript-eslint/eslint-plugin @typescript-eslint/eslint-plugin-tslint @typescript-eslint/parser eslint eslint-plugin-import eslint-plugin-jsdoc eslint-plugin-prefer-arrow --save-dev

✅ All is well! ✅

After installing those packages, running ESLint gives these complaints:

  1:1   error  Definition for rule 'import/order' was not found                         import/order
  1:1   error  Definition for rule 'jsdoc/check-alignment' was not found                jsdoc/check-alignment
  1:1   error  Definition for rule 'jsdoc/check-indentation' was not found              jsdoc/check-indentation
  1:1   error  Definition for rule 'jsdoc/newline-after-description' was not found      jsdoc/newline-after-description
  1:1   error  Definition for rule 'prefer-arrow/prefer-arrow-functions' was not found  prefer-arrow/prefer-arrow-functions       

So, yes, even with all our recent improvements, there are still some issues in the rule converters, it seems!