DefinitelyTyped-tools

A monorepo for formerly disparate DefinitelyTyped-related tools:

• definitions-parser: the part of microsoft/types-publisher that reads DefinitelyTyped repository data
• dtslint: microsoft/dtslint, make sure a package is correct for DT
• dtslint-runner: DefinitelyTyped/dtslint-runner, test all packages, or all changed packages, on DT with dtslint
• eslint-plugin: provides DT-specific lint rules
• dts-critic: DefinitelyTyped/dts-critic, issue errors when a types packages mismatches its original Javascript package.
• header-parser: microsoft/definitelytyped-header-parser, check and extract DT-related info from package.json
• publisher: the rest of microsoft/types-publisher
• retag: DefinitelyTyped/dt-retag, script to add ATA tags to @types packages. Run weekly.
• typescript-versions: the part of definitelytyped-header-parser that tracked which TypeScript versions are published to npm and supported on DefinitelyTyped
• utils: shared utilities, mostly extracted from microsoft/types-publisher

Disclaimer

These tools are not intended for public consumption, so we may break the API whenever convenient for us.

Development

This is a monorepo managed with pnpm workspaces and published with changesets. After cloning, run pnpm install to install dependencies for each package and link them to each other.

Testing

All packages use Node.js's test runner. Tests run from compiled JavaScript, so build from the monorepo root before running them:

pnpm build
pnpm test

Pass a package or test-file path to select tests, and use Node.js's test-runner flags to filter test names or update snapshots:

pnpm test packages/utils
pnpm test packages/utils --test-name-pattern=ProgressBar
pnpm test packages/utils --test-update-snapshots

Rebuild after changing source files or tests.

Publishing/deploying

types-publisher runs in GitHub Actions using all monorepo packages built from source on master.

The public packages are published to npm using changesets. When making changes to any publishable package, run pnpm changeset (ideally as part of the related feature PR) to mark the changed packages for eventual version bumping and release. When that PR is merged, another PR will be automatically opened (or updated) updating package versions and CHANGELOGs. What that PR is merged, a workflow will publish the changed packages to npm.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.