Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AreTheTypesWrong (attw) CLI to continuously validate package types #1083

Merged
merged 5 commits into from Jul 28, 2023

Conversation

ericcornelissen
Copy link
Owner

@ericcornelissen ericcornelissen commented Jul 28, 2023

Closes #1084
Relates to #1082

Summary

Add AreTheTypesWrong (attw) CLI to continuously validate package types.

Added the dependency, added script to run attw, run attw in CI.

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.
@github-actions github-actions bot added ci/cd Relates to ci/cd dependencies Changes to the project's dependencies meta Relates to the project or repository itself labels Jul 28, 2023
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 how `attw` is run from a solo thing to a followup to publint.
This should make commands a bit predictable (there won't be two separate
checks that might start complaining about the package manifest). Notably
this changes to CI to only run `attw` when the package manifest actually
changes (see the `config-npm.yml` workflow).
@ericcornelissen ericcornelissen added the bug Something isn't working label Jul 28, 2023
@ericcornelissen ericcornelissen merged commit a7e6ce4 into main Jul 28, 2023
35 checks passed
@ericcornelissen ericcornelissen deleted the try-attw branch July 28, 2023 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci/cd Relates to ci/cd dependencies Changes to the project's dependencies meta Relates to the project or repository itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TypeScript type definition for shescape/testing are outdated
1 participant