Install the dependencies:
pnpm installBuild the library:
pnpm run buildBuild for the web
pnpm run build:docsBuild the library in watch mode:
pnpm run devBuild the library with Web in watch mode:
pnpm run dev:docsRun tests:
pnpm run testRun tests in watch mode:
pnpm run test:watchThis template uses Biome as the default formatter.
The .vscode/settings.json sets Biome as the formatter for this project only.
This does not affect your global VSCode configuration or other projects.
If you use Prettier globally, it will continue to work for other projects.
Separate tsconfig files for different purposes:
tsconfig.node.json- Bundlertsconfig.rslib.json- Library bundlingtsconfig.rsbuild.json- Demo/documentation sitetsconfig.rstest.json- Testing
Performance note: exclude patterns should include nested directories and hidden files for optimal type-checking performance: https://github.com/microsoft/TypeScript/wiki/Performance#misconfigured-include-and-exclude
If your team wants to enforce linting pre-commit, consider setting up husky and lint-staged:
pnpm add -D husky lint-staged
npx husky installThen add a pre-commit file to the .husky directory with:
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
pnpm exec lint-stagedAlternatively, you can create it with:
npx husky add .husky/pre-commit "pnpm exec lint-staged"This template has "private": true in package.json as a default safety measure.
Before publishing to npm:
- Change
"private": false - Ensure your package name is unique and correct
- Review your
package.jsonmetadata (description, keywords, repository, etc.)
This prevents accidental npm publishes during development.
When using this template, follow the checklist to update your info properly.
- Change the author name in LICENSE
- Update package name and metadata in
package.json - Change
umdNameinrslib.config.ts - Set
"private": false(currentlytrueas a safety measure) - Review and adapt
AGENTS.mdfor your project conventions - Clean up the READMEs
- Publish your project.
©2026 by Logue. Licensed under the MIT License.