search

allegro / typescript-strict-plugin

Typescript plugin that allows turning on strict mode in specific files or directories.
MIT License
332 stars 29 forks source link

Idea: use jest-docblock for parsing comments #51

Open phungtuanhoang1996 opened 1 year ago

phungtuanhoang1996 commented 1 year ago

Hi, I am trying to migrate to Typescript + strict mode on a legacy codebase and very interested in this project

This idea is pretty similar in concept to Prettier's --require-pragma (https://prettier.io/docs/en/options.html#require-pragma)

Prettier is using jest-docblock internally to parse its pragma and supports multiple comment types

// @format or /** @format */ or even

/** 
 * @format
 * @some-other-pragmas
 */

would be great if we can put the @ts-strict or @ts-strict-ignore in the docblock as well, so all so-called pragmas are grouped in 1 docblock at the top of a file.

kamkry commented 1 year ago

Thank you for considering the idea. If we decide to implement this change, it would mean making adjustments to our migration script, which includes altering existing comments rather than just adding or removing them. If you believe this could be beneficial, please feel free to create a pull request with the suggested changes. Your input and contribution would be highly appreciated!