search

chiubaka / genesis

Creates standardized monorepos and pre-configured project scaffolding for Chiubaka Technologies projects.
2 stars 0 forks source link

Clean `genesis` workspace generates empty JSDoc comments #169

Open chiubaka opened 1 year ago

chiubaka commented 1 year ago

It's doing this because the JSDoc missing comment rule is fixable, though it probably shouldn't be, since an empty comment just to satisfy the rule is essentially useless.

Options are:

  1. See if I can disable the autofixing for this rule (https://github.com/chiubaka/eslint/issues/54)
  2. Change the JSDoc linting rule to a warning rather than an error (https://github.com/chiubaka/eslint/issues/53)
  3. Generate real, full-featured JSDoc comments with genesis sample code so there is no linting error to auto-fix

I think a mixture of options 1 and 2 is realistic right now. I don't want to mess with option 3 until https://github.com/chiubaka/eslint/issues/52 is resolved and the doc format is a little more stable.

chiubaka commented 1 year ago

Bumping this so that it doesn't appear stale for import into Linear.