Skip to content

Commit

Permalink
Add AreTheTypesWrong CLI to continuously validate package types (#1083)
Browse files Browse the repository at this point in the history
* Add AreTheTypesWrong (attw) CLI to continuously validate package types

Added the dependency, update script/CI to run attw.

Also, add Licensee exception for the package `(at)andrewbranch/untar.js`
which does not specify its license in its manifest but has a LICENSE
file specifying the (already approved) MIT license.

* Create type declarations for "shescape/testing" module

Create a new `.d.ts` file with type declarations for the module
"shescape/testing". Following the module name `testing.js`, this
declaration file is called `testing.d.ts`. Like `index.d.ts` it's a
collection of manually maintained type definitions for the exports of
the module it represents. The export details in the project manifest
have been updated accordingly, so has the `.npmignore` allowlist.

Furthermore, other configuration files have been updated in accordance
with this change. The "generated" `.d.cts` file should be properly
ignored and cleaned up.

* Update the changelog
  • Loading branch information
ericcornelissen authored Jul 28, 2023
1 parent 46966ec commit a7e6ce4
Show file tree
Hide file tree
Showing 9 changed files with 370 additions and 5 deletions.
1 change: 1 addition & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -742,3 +742,4 @@ ignorePatterns:
- index.cjs
- index.d.cts
- testing.cjs
- testing.d.cts
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ crash-*
index.cjs
index.d.cts
testing.cjs
testing.d.cts

# ESLint
.eslintcache
Expand Down
1 change: 1 addition & 0 deletions .licensee.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
]
},
"packages": {
"@andrewbranch/untar.js": "1.0.2",
"deep-freeze": "0.0.1",
"filter-iterator": "0.0.1",
"identity-function": "1.0.0"
Expand Down
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@
!README.md
!SECURITY.md
!testing.cjs
!testing.d.cts
!testing.d.ts
!testing.js
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Versioning].

## [Unreleased]

- Fix TypeScript type declarations for `"shescape/testing"`. ([#1083])
- Fix TypeScript type exports for CommonJS use. ([#1082])

## [1.7.2] - 2023-07-07
Expand Down Expand Up @@ -283,6 +284,7 @@ Versioning].
[#1022]: https://github.com/ericcornelissen/shescape/pull/1022
[#1023]: https://github.com/ericcornelissen/shescape/pull/1023
[#1082]: https://github.com/ericcornelissen/shescape/pull/1082
[#1083]: https://github.com/ericcornelissen/shescape/pull/1083
[552e8ea]: https://github.com/ericcornelissen/shescape/commit/552e8eab56861720b1d4e5474fb65741643358f9
[keep a changelog]: https://keepachangelog.com/en/1.0.0/
[semantic versioning]: https://semver.org/spec/v2.0.0.html
Loading

0 comments on commit a7e6ce4

Please sign in to comment.