Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Enable eslint rule equivalent to ts-lint `completed-docs` rule

See original GitHub issue

Context

We require JSDoc comments on all public members of Excalibur in order to properly generate our API documentation. While we always intend to manually review any new comments, this would prevent anything from slipping through without a comment.

Proposal

Enable completed-docs TSLint rule.

"completed-docs": [
  {
    "classes": {"visibilities": ["exported"]},
    "enums": {"visibilities": ["exported"]},
    "enum-members": {"visibilities": ["exported"]},
    "interfaces": {"visibilities": ["exported"]},
    "functions": {"visibilities": ["exported"]},
    "methods": {"privacies": ["public", "protected"]},
    "properties": {"privacies": ["public", "protected"]}
  }
]

This should be implemented in this PR as a warning not an error until we address all outstanding issues it finds (we will open a separate core team PR).

Issue Analytics

State:
Created 9 years ago
Comments:10 (6 by maintainers)

Top GitHub Comments

1reaction

eonarheimcommented, Oct 5, 2019

Hi @chris-bingham, I’ve made some updates to the branch feature/1212-tslint-to-eslint, there was some more work to be done on this PRhttps://github.com/excaliburjs/Excalibur/pull/1217 apologies if this adds some more challenge.

I did a little more digging, I think this plugin may be what you need to complete this story, it looks like it has all the things that we want 👍 https://www.npmjs.com/package/eslint-plugin-jsdoc https://github.com/gajus/eslint-plugin-jsdoc

0reactions

chris-binghamcommented, Nov 25, 2019

@eonarheim I do still intend to do this, but have been absolulely stacked since i took it on. If anyone else wants the ticket they’re welcome to it but if its not been done when I get some time I’ll do it 😃

Top Results From Across the Web

Migrate from TSLint to ESLint - Visual Studio Code

A guide to migrating extension projects from the TSLint linter to ESLint. ... That means that ESLint rules can use semantic information, for...

Missing Merger · Issue #343 · typescript-eslint/tslint-to ... - GitHub

CLI Output ✨ 120 rules replaced with their ESLint equivalents. ✨ ❗ 9 ESLint rules behave differently from their TSLint counterparts ...

Migrating a TSLint Rule to ESLint with @typescript-eslint

These options to configure your rules can be compared with the static metadata property of a TSLint rule and its apply methods.

@algoan/eslint-config - npm

Start using @algoan/eslint-config in your project by running `npm i ... It is the ESLint equivalent for @yelloan/tslint rules.

TSLint core rules - Palantir Open Source

TSLint core rules. Lint rules encode logic for syntactic & semantic checks of TypeScript source code. TypeScript-specific. These rules find errors related ...