absolute-version / commit-and-tag-version

Fork of the excellent standard-version. Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org :trophy:
ISC License
385 stars 36 forks source link

chore: add jsdoc types #79

Open helmturner opened 1 year ago

helmturner commented 1 year ago

Here is the current progress on my light-weight refactor with JSDoc types, as mentioned in #29

TimothyJones commented 1 year ago

This is a nice set of changes.

Are the typescript and @types dependencies needed? I guess you need those to parse tsdoc?

What does this need to be out of draft?

helmturner commented 1 year ago

Yeah,TS is still doing all the work - it's just pulling types from the comments, instead.

I put it up as a draft because I wasn't sure if I should leave it as is (i.e. leave the errors and skip type checking during CI) or wait until I make the refractors necessary to eliminate the errors.

helmturner commented 1 year ago

No idea what I was thinking using "style" for one commit but "chore" for the rest 😅

codecov-commenter commented 1 year ago

Codecov Report

Merging #79 (b8f30e4) into master (2e3f60a) will decrease coverage by 0.08%. The diff coverage is 85.00%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master      #79      +/-   ##
==========================================
- Coverage   97.57%   97.50%   -0.08%     
==========================================
  Files          31       31              
  Lines        1280     1281       +1     
==========================================
  Hits         1249     1249              
- Misses         31       32       +1     
Impacted Files Coverage Δ
lib/configuration.js 94.73% <ø> (ø)
lib/detect-package-manager.js 100.00% <ø> (ø)
lib/format-commit-message.js 100.00% <ø> (ø)
lib/latest-semver-tag.js 100.00% <ø> (ø)
lib/lifecycles/commit.js 96.96% <ø> (ø)
lib/preset-loader.js 100.00% <ø> (ø)
lib/run-exec.js 100.00% <ø> (ø)
lib/run-execFile.js 81.81% <ø> (ø)
lib/stringify-package.js 100.00% <ø> (ø)
lib/updaters/index.js 71.79% <0.00%> (-1.89%) :arrow_down:
... and 10 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

TimothyJones commented 1 year ago

My thinking is the best strategy would be to merge in small changes that are solid improvements - under that strategy, I think working type checking enabled in CI is a stronger change (even if only for a few files). What do you think?