Improve: Overhaul tests, export types, perf work #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Replaced all `@ts-check` uses with tsconfig enforced checking - Added tsconfig and configured to emit types from JSDoc JS - Add jsconfig for separate __tests__ directory - Split up global augmentation vs types - Improve type-safety (`noImplicitAny`, plus refactors) - Move to `/dist` folder for specifying included files - Had to refactor filelist-handler to class instead of IIFE - JSDoc / TS has a hard time with exporting the type of the inner constructor, without a bunch of manual (and messy) workarounds - Easier to just rewrite to ES2015 / ES6 class
- Tests no longer run in source code directory! Now run in sys temp - Refactors a lot of the code around test setup - Cleanup how paths are handled; always use forward slashes internally - This also makes testing more flexible and repeatable - General test cleanup - Closes #6 - Renamed some options
- Add bulk file test script to gather some simple stats on speed - Fix some minor type issues - Add tsc check script entry (`--noEmit`)
- Switch over child_process.exec to .spawn, for speed - Rewrite getTimestampsFromFile to be optimized for bulk files - This is now `getTimestampsFromFilesBulk` - Use new spawn wrapper - Optimize some git commands - Misc type fixes, cleanup, etc. - Add some extra logging to tests
- Recent performance tweak caused cache to be completely overwritten with new results on each run, instead of merged with new values - Fix cache update code, and add test to verify
- Was throwing fatal error (ENOENT) early in scrape, if a requested file in the input options does not exist - Fix allows scrape to continue running, noting error, and extracting results for the rest of the files that *do* exist - Also fix badge URLs in README
- Exclude local tarball builds from git - Update TSConfig to mirror Node10 recommendation - More descriptive getStamps JSDoc comment
Codecov Report
@@ Coverage Diff @@
## main #8 +/- ##
==========================================
+ Coverage 89.31% 90.48% +1.17%
==========================================
Files 5 6 +1
Lines 393 452 +59
==========================================
+ Hits 351 409 +58
- Misses 42 43 +1
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR will merge some major improvements to this package, as well as fix some minor bugs.
Improvements:
@ts-checkwith real TSC setup