Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

complete-docs on type member #4396

Closed
jdmichaud opened this issue Dec 18, 2018 · 3 comments
Closed

complete-docs on type member #4396

jdmichaud opened this issue Dec 18, 2018 · 3 comments

Comments

@jdmichaud
Copy link

Bug Report

  • TSLint version: 5.12.0
  • TypeScript version: 3.2.2
  • Running TSLint via: CLI

TypeScript code being linted

class Foo {
  private someField?: { bar(): void };
}

with tslint.json configuration:

    "completed-docs": [
      true,
      {
        "classes": true,
        "enums": true,
        "functions": {
          "visibilities": [
            "exported"
          ]
        },
        "methods": {
          "privacies": [
            "public"
          ]
        },
        "interfaces": true,
        "namespaces": true
      }
    ],

Actual behavior

Documentation must exist for methods.

on the bar function.

Expected behavior

The type is not an interface but a type. I don't expect tslint to complain about it.

@JoshuaKGoldberg
Copy link
Contributor

JoshuaKGoldberg commented Dec 26, 2018

@buu700 mentioned in #4398:

Edit: Adding "locations": "all" to "methods" and "properties" fixed this. Is this expected?

I don't think so?

@JoshuaKGoldberg
Copy link
Contributor

💀 It's time! 💀

TSLint is deprecated and no longer accepting pull requests other than security fixes. See #4534. ☠️
We recommend you instead use typescript-eslint to lint your TypeScript code with ESLint. ✅

👋 It was a pleasure open sourcing with you!

@JoshuaKGoldberg
Copy link
Contributor

🤖 Beep boop! 👉 TSLint is deprecated 👈 (#4534) and you should switch to typescript-eslint! 🤖

🔒 This issue is being locked to prevent further unnecessary discussions. Thank you! 👋

@palantir palantir locked and limited conversation to collaborators Mar 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants