Rstack Library starter template

Setup

Install the dependencies:

pnpm install

Get started

Build the library:

pnpm run build

Build for the web demo.

pnpm run build:demo

Buidl for the documentation site.

pnpm run build:docs

Build the library in watch mode:

pnpm run dev

Build the documentation in watch mode:

pnpm run dev:docs

Run tests:

pnpm run test

Run tests in watch mode:

pnpm run test:watch

Run build analysis. (Rsdoctor)

pnpm run analyze

TypeScript Configuration

Separate tsconfig files for different purposes:

• tsconfig.node.json - Bundler
• tsconfig.rslib.json - Library bundling
• tsconfig.rsbuild.json - Demo
• tsconfig.rspress.json - documentation site
• tsconfig.rstest.json - Testing

Optional: 🪝 Git Hooks (Recommended for Teams)

Use rstack hooks: https://rstack.rs/guide/cli/hooks

🔒️ Safety Measures

This template has "private": true in package.json as a default safety measure.

Before publishing to npm:

1. Change "private": false
2. Ensure your package name is unique and correct
3. Review your package.json metadata (description, keywords, repository, etc.)

This prevents accidental npm publishes during development.

📝 Checklist

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 umdName in rstack.config.ts
• When outputting a documentation site, if the package name in rstack.config.ts differs from the repository name, modify the base value in define.doc as needed. (By default, the base path is the package name with the @ namespace removed.)
• Set "private": false (currently true as a safety measure)
• Review and adapt AGENTS.md for your project conventions
• Clean up the READMEs
• Publish your project.

License

©2026 by Logue. Licensed under the MIT License.