Farfetch/blackout

Replace jsdoc with tsdoc

boliveira opened this issue · 1 comments

Motivation

As we are migrating the code to typescript, we need to change our usage of jsdoc to match the tsdoc specification, which does not require that we declare the types of parameters / return values of functions as they are already available on the typescript type declarations.

To make this work, we will need to replace our eslint-plugin-jsdoc with eslint-plugin-tsdoc.

You can get more information by checking the official tsdoc documentation page.

jsdoc & better-docs

We use better-docs to generate our documentation from the jsdoc. When migrating to tsdoc, the documentation might break. As it is not being used right now, it is not a major concern. However, there are some jsdoc tags that become unnecessary in tsdoc as they were specific for better-docs to generate some special output. By using the eslint-plugin-tsdoc plugin, these tags will give errors when linting, so we will need to remove them as well.

Dependencies

This issue should be tackled during (or after) the migration to typescript.

Implemented in #328.