The project requires pnpm 9 and Node.js 18 (or above). Run pnpm install to install dependencies of all workspace packages.
There are 3 parts to this repo:
- packages/* - The published npm packages, including
publint - site - The website for https://publint.dev
- analysis - The automation script that lints popular npm packages for displaying their results on the website
All npm packages here follow a similar directory format. src contains the source code, and tests contains the unit tests.
The root files of src are the entrypoints and types for the package. Within src, there are browser, node, and shared directories used to split code for different environments.
browser- Code that only works in the browser or only used by the browser entrypoint.node- Code that only works in Node.js or only used by the Node.js entrypoint.shared- Code that works in both environments and used by thebrowserandnodedirectory files.
The site workspace is a Vite & Svelte multiple page application. It powers https://publint.dev.
It has a packfix command (pnpm packfix) which packages up fixtures from packages/publint/tests/fixtures. Once packed, when running the dev server, you can search for the fixture name, e.g. publint-test-1, and it'll load the package locally. This can be used for quick testing.
The analysis workspace contains a simple index.js script that runs publint on popular npm packages. Run pnpm start to run the script to compute the results. The downloaded package tarballs and results are cached in the cache directory, so subsequent runs are faster. Even so, the script will fetch npm to check the latest package versions, if you want to bypass this on subsequent runs as well, use the --cache flag. The final results are written to cache/_results.json and also loaded by the site locally.
The pnpm gist command uploads and stores the results to a GitHub gist. It is then proxied and served by https://publint.dev/analysis.json. This is automated to run on CI and by (@bluwy) only.
There's also an additional pnpm bench command that solely benchmarks the time it takes to lint the poplar packages. This can be used to test performance improvements. The caching mechanism is the same as pnpm start, and also supports the --cache flag.
You can run the unit tests with pnpm test in the root to run all packages' tests.
NOTE 1: For packages/pack, it has a test setup that uses corepack and bun to test certain packing behaviors. corepack is installed by default but may not be enabled, its tests will temporarily enable it if not and disable again after its test is done. (In rare cases where corepack is not properly teared down, you may need to manually run corepack disable and corepack disable npm if you prefer to not use it). You may also optionally install bun (>=1.1.42) to run its bun-specific tests (automatically skipped if bun is not installed).
NOTE 2: As packages/pack uses corepack, it also requires a network connection to install the package manager binaries. If you've run the tests at least once, the binaries are cached and you can run the tests offline later.
Pull request titles should preferably use the format of <Verb> <something>. First word is capitalized and singular. Examples:
- Fix docs styles
- Support JSX
- Update core options
The repo also uses Changesets to automate releases, where you can run pnpm changeset at the root of the repo to create a changeset for a npm package, which will ultimately be part of the CHANGELOG.md. Changeset description should also follow the same format as pull request titles and can be more descriptive if needed. See .changeset/README.md for more information.
Perfect PR titles and changesets are optional! You're free to ignore the conventions, but before merging, the maintainers may update them for you.
For commit messages, feel free to use your own convention and commit as many as needed. The pull request will be squashed merged into a single commit based on the pull request title.