spinup-ts 0.1.0

package/template/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.biome": "explicit",
+    "source.organizeImports.biome": "explicit",
+    "source.fixAll.eslint": "explicit"
+  },
+  "[typescript]": { "editor.defaultFormatter": "biomejs.biome" },
+  "[javascript]": { "editor.defaultFormatter": "biomejs.biome" },
+  "[json]": { "editor.defaultFormatter": "biomejs.biome" }
+}

package/template/AGENTS.md

@@ -0,0 +1 @@
+@CLAUDE.md

package/template/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial release

package/template/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+## Development Setup
+
+```bash
+git clone https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__
+cd __PROJECT_NAME__
+pnpm install
+```
+
+## Workflow
+
+1. Create a feature branch: `git checkout -b feat/my-feature`
+2. Make your changes
+3. Run checks: `pnpm check`
+4. Run tests: `pnpm test`
+5. Commit: `git commit -m "feat: my feature"`
+6. Open a pull request
+
+## Code Style
+
+This project uses Biome for formatting and ESLint for linting. Run `pnpm lint:fix` to auto-fix issues.

package/template/Dockerfile

@@ -0,0 +1,21 @@
+FROM node:__NODE_VERSION__-alpine AS base
+RUN corepack enable pnpm
+
+FROM base AS deps
+WORKDIR /app
+COPY package.json pnpm-lock.yaml ./
+RUN pnpm install --frozen-lockfile --prod
+
+FROM base AS builder
+WORKDIR /app
+COPY package.json pnpm-lock.yaml ./
+RUN pnpm install --frozen-lockfile
+COPY . .
+RUN pnpm build
+
+FROM node:__NODE_VERSION__-alpine AS runner
+WORKDIR /app
+COPY --from=builder /app/dist ./dist
+COPY --from=deps /app/node_modules ./node_modules
+COPY package.json ./
+CMD ["node", "dist/index.js"]

package/template/LICENSE.Apache-2.0

@@ -0,0 +1,17 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+Copyright __YEAR__ __AUTHOR__
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/template/LICENSE.BSD-3-Clause

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) __YEAR__, __AUTHOR__
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/template/LICENSE.GPL-3.0

@@ -0,0 +1,17 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) __YEAR__ __AUTHOR__
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.

package/template/LICENSE.ISC

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) __YEAR__ __AUTHOR__
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/template/LICENSE.MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) __YEAR__ __AUTHOR__
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/template/README.md

@@ -0,0 +1,62 @@
+# __PROJECT_NAME__
+
+> __DESCRIPTION__
+
+[![npm version](https://img.shields.io/npm/v/__PROJECT_NAME__?color=blue)](https://npmjs.com/package/__PROJECT_NAME__)
+[![CI](https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__/actions/workflows/ci.yml/badge.svg)](https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/__GITHUB_HANDLE__/__PROJECT_NAME__/graph/badge.svg)](https://codecov.io/gh/__GITHUB_HANDLE__/__PROJECT_NAME__)
+[![Docs](https://img.shields.io/badge/docs-online-informational)](https://__GITHUB_HANDLE__.github.io/__PROJECT_NAME__)
+[![License: __LICENSE__](https://img.shields.io/badge/License-__LICENSE__-yellow.svg)](LICENSE)
+[![Node](https://img.shields.io/node/v/__PROJECT_NAME__)](https://nodejs.org)
+
+## What is __PROJECT_NAME__?
+
+Replace this paragraph with a 2–3 sentence description. What does it do? Who is it for?
+Why should someone choose it over alternatives?
+
+## Features
+
+| | Feature | Description |
+|---|---------|-------------|
+| ⚡ | **Fast** | Replace with a real performance claim |
+| 🔒 | **Type-safe** | Full TypeScript with strict types |
+| 🧪 | **Well tested** | Comprehensive test suite with coverage |
+| 📦 | **Lightweight** | Minimal dependencies |
+
+## Installation
+
+```bash
+# pnpm
+pnpm add __PROJECT_NAME__
+
+# npm
+npm install __PROJECT_NAME__
+
+# bun
+bun add __PROJECT_NAME__
+```
+
+## Quick Start
+
+```typescript
+import { yourExport } from '__PROJECT_NAME__';
+
+// Replace with the simplest possible working example
+const result = yourExport({ input: 'value' });
+```
+
+## Documentation
+
+Full documentation at **[__GITHUB_HANDLE__.github.io/__PROJECT_NAME__](https://__GITHUB_HANDLE__.github.io/__PROJECT_NAME__)**
+
+- [Getting Started](https://__GITHUB_HANDLE__.github.io/__PROJECT_NAME__/getting-started)
+- [User Guide](https://__GITHUB_HANDLE__.github.io/__PROJECT_NAME__/user-guide/)
+- [API Reference](https://__GITHUB_HANDLE__.github.io/__PROJECT_NAME__/api)
+
+## Contributing
+
+See [CONTRIBUTING](https://__GITHUB_HANDLE__.github.io/__PROJECT_NAME__/contributing) for development setup and PR guidelines.
+
+## License
+
+[__LICENSE__](LICENSE) © __YEAR__ [__AUTHOR__](https://github.com/__GITHUB_HANDLE__)

package/template/biome.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "organizeImports": { "enabled": true },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 100
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingCommas": "all",
+      "semicolons": "always",
+      "arrowParentheses": "always"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedVariables": "error",
+        "noUnusedImports": "error",
+        "useExhaustiveDependencies": "off"
+      },
+      "style": {
+        "useConst": "error",
+        "noNonNullAssertion": "warn",
+        "useTemplate": "error",
+        "useNamingConvention": {
+          "level": "error",
+          "options": { "strictCase": false }
+        }
+      },
+      "suspicious": {
+        "noExplicitAny": "error",
+        "noConsole": "warn"
+      },
+      "complexity": {
+        "noExcessiveCognitiveComplexity": "warn"
+      }
+    }
+  },
+  "files": {
+    "ignore": ["node_modules", "dist", "coverage", "*.generated.ts"]
+  }
+}

package/template/docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  app:
+    build: .
+    ports:
+      - "3000:3000"
+    environment:
+      - NODE_ENV=production

package/template/docs/architecture/api-layer.md

@@ -0,0 +1,44 @@
+---
+title: API Layer
+---
+
+# API Layer
+
+## Overview
+
+Describe the API layer of __PROJECT_NAME__ — how it exposes functionality to consumers.
+
+## Public API Surface
+
+Everything exported from `src/index.ts` is part of the public API and subject to semver.
+
+```typescript
+// Example: primary exports
+export { yourMainExport } from './core.js';
+export type { Config, Result } from './types.js';
+```
+
+## API Design Principles
+
+- **Minimal surface** — only expose what consumers need; keep internals private
+- **Type-safe** — every parameter and return type is fully typed; no `any`
+- **Stable** — breaking changes require a major version bump
+
+## Request / Response Flow
+
+Describe how a call flows from consumer → public API → internal implementation → return value.
+
+```
+Consumer → yourMainExport(input)
+         → validate(input)
+         → process(validated)
+         → Result
+```
+
+## Error Handling
+
+Describe how errors surface to callers (thrown exceptions, returned error objects, Result types, etc.).
+
+## Versioning
+
+Describe your semver strategy and how you signal deprecations before breaking changes.

package/template/docs/architecture/constitution.md

@@ -0,0 +1,24 @@
+---
+title: Constitution
+---
+
+# Constitution
+
+The non-negotiable architectural principles for __PROJECT_NAME__.
+
+## Core Principles
+
+1. **TypeScript-first** — every public API is fully typed; no `any` in source code
+2. **Zero runtime dependencies** — replace or remove if your project has deps
+3. **Immutability** — replace with your principle
+4. **Replace with your principle** — describe it
+
+## Constraints
+
+- Node.js `>= __NODE_VERSION__` — minimum runtime requirement
+- ESM-only — no CommonJS output
+- Add other constraints relevant to your project
+
+## What This Is Not
+
+Describe what __PROJECT_NAME__ explicitly does NOT do. Scope boundaries matter.

package/template/docs/architecture/data-model.md

@@ -0,0 +1,24 @@
+---
+title: Data Model
+---
+
+# Data Model
+
+## Type Hierarchy
+
+Replace with your project's type hierarchy diagram or description.
+
+```
+RootType
+├── SubTypeA
+│   └── LeafType
+└── SubTypeB
+```
+
+## Source of Truth
+
+The canonical types are defined in `src/types.ts`. Replace with your actual types file.
+
+## Versioning
+
+Describe how breaking changes to types are handled.

package/template/docs/architecture/index.md

@@ -0,0 +1,15 @@
+---
+title: Architecture
+---
+
+# Architecture
+
+This section documents the architectural decisions, constraints, and structure of __PROJECT_NAME__.
+
+- [Constitution](./constitution) — principles and non-negotiable constraints
+- [Data Model](./data-model) — schema and type hierarchy
+- [Project Structure](./project) — file and module layout
+- [API Layer](./api-layer) — public API surface, request/response flow, versioning
+- [UI](./ui) — component structure, state management, styling
+- [Quality Checks](./quality-checks) — linting, typing, testing gates
+- [Testing Plan](./testing-plan) — test strategy and coverage goals

package/template/docs/architecture/project.md

@@ -0,0 +1,24 @@
+---
+title: Project Structure
+---
+
+# Project Structure
+
+```
+__PROJECT_NAME__/
+├── src/
+│   ├── index.ts          # public API exports
+│   └── ...               # replace with your structure
+├── docs/                 # documentation source
+├── dist/                 # build output (gitignored)
+└── package.json
+```
+
+## Module Boundaries
+
+Describe the internal module structure and how modules relate.
+
+## Public API
+
+Everything exported from `src/index.ts` is part of the public API and subject to semver.
+Everything else is internal and may change without notice.

package/template/docs/architecture/quality-checks.md

@@ -0,0 +1,28 @@
+---
+title: Quality Checks
+---
+
+# Quality Checks
+
+## On Every Commit (pre-commit hook)
+
+- Biome format + lint
+- ESLint strict mode
+
+## On Every Push / PR (CI)
+
+- `pnpm typecheck` — TypeScript strict mode, zero errors allowed
+- `pnpm lint` — Biome CI + ESLint with `--max-warnings=0`
+- `pnpm test:coverage` — Vitest with v8 coverage
+- `pnpm depcheck` — no unused dependencies
+- `pnpm docs:build` — Docusaurus + TypeDoc build (docs branch only)
+- Dependency Review — blocks PRs with known-vulnerable dependencies (CVE severity: moderate+)
+
+## Gates
+
+| Gate | Threshold |
+|------|-----------|
+| Test coverage | Replace with your target (e.g., 80%) |
+| TypeScript errors | 0 |
+| ESLint warnings | 0 |
+| Dependency vulnerabilities | 0 moderate+ |

package/template/docs/architecture/testing-plan.md

@@ -0,0 +1,35 @@
+---
+title: Testing Plan
+---
+
+# Testing Plan
+
+## Test Strategy
+
+Replace with your project's testing strategy. For a library:
+- **Unit tests** — every exported function, edge cases, error paths
+- **Integration tests** — key workflows end-to-end
+- No mocking of internal implementation details
+
+## Coverage Goals
+
+| Metric | Target |
+|--------|--------|
+| Line coverage | > 80% (replace with your target) |
+| Branch coverage | > 75% |
+| Function coverage | > 90% |
+
+## Test File Conventions
+
+```
+src/
+├── myModule.ts
+└── __tests__/
+    └── myModule.test.ts   # co-located with source
+```
+
+## What We Do Not Test
+
+- Third-party library internals
+- Build tooling (TypeScript, Biome)
+- Generated files

package/template/docs/architecture/ui.md

@@ -0,0 +1,37 @@
+---
+title: UI
+---
+
+# UI
+
+Remove this section if __PROJECT_NAME__ has no user interface.
+
+## Overview
+
+Describe the UI layer — component structure, rendering approach, and how it connects to the core library.
+
+## Component Structure
+
+```
+src/
+└── ui/
+    ├── components/     # reusable primitives
+    ├── views/          # page-level compositions
+    └── index.ts        # public UI exports
+```
+
+## State Management
+
+Describe how UI state is managed (local component state, context, external store, etc.) and how it stays in sync with library state.
+
+## Theming & Styling
+
+Describe the styling approach (CSS Modules, Tailwind, CSS-in-JS, etc.) and how consumers can customize the appearance.
+
+## Accessibility
+
+Describe your accessibility baseline (WCAG level, ARIA patterns, keyboard navigation support).
+
+## Design Decisions
+
+Document any non-obvious UI architecture choices — e.g., why a headless component pattern was chosen, or why rendering is decoupled from logic.

package/template/docs/changelog.md

@@ -0,0 +1,9 @@
+---
+title: Changelog
+---
+
+# Changelog
+
+All notable changes are tracked in [CHANGELOG.md](https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__/blob/main/CHANGELOG.md) on GitHub.
+
+Releases are automated via [release-please](https://github.com/googleapis/release-please).

package/template/docs/contributing.md

@@ -0,0 +1,46 @@
+---
+title: Contributing
+---
+
+# Contributing
+
+Thank you for your interest in contributing to __PROJECT_NAME__!
+
+## Development Setup
+
+```bash
+git clone https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__.git
+cd __PROJECT_NAME__
+pnpm install
+```
+
+## Running Tests
+
+```bash
+pnpm test          # run tests
+pnpm test:coverage # run with coverage
+```
+
+## Code Quality
+
+```bash
+pnpm check         # typecheck + lint
+pnpm lint:fix      # auto-fix linting issues
+```
+
+## Submitting a Pull Request
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feat/your-feature`
+3. Make your changes and add tests
+4. Ensure all checks pass: `pnpm check && pnpm test`
+5. Commit using [Conventional Commits](https://www.conventionalcommits.org/):
+   - `feat: add new feature`
+   - `fix: correct a bug`
+   - `docs: update documentation`
+6. Open a pull request
+
+## Release Process
+
+Releases are automated via [release-please](https://github.com/googleapis/release-please).
+Merging a release PR automatically publishes to npm and deploys the docs.

package/template/docs/developer-guide/architecture.md

@@ -0,0 +1,22 @@
+---
+title: Architecture Overview
+---
+
+# Architecture Overview
+
+See the [Architecture section](../architecture/) for detailed documentation.
+
+## Quick Summary
+
+Describe your architecture in 2-3 sentences for developers scanning this guide.
+
+## Key Files
+
+| File | Responsibility |
+|------|----------------|
+| `src/index.ts` | Public API exports |
+| `src/core.ts` | Replace with your core module |
+
+## Extension Points
+
+Describe how the library can be extended or customized.

package/template/docs/developer-guide/contributing.md

@@ -0,0 +1,30 @@
+---
+title: Contributing (Dev)
+---
+
+# Contributing — Developer Notes
+
+This covers technical details for contributors. See the [user-facing contributing guide](../contributing) for the PR workflow.
+
+## Project Setup
+
+```bash
+git clone https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__.git
+cd __PROJECT_NAME__
+pnpm install
+pnpm build
+pnpm test
+```
+
+## Code Conventions
+
+- TypeScript strict mode — no `any`, no `@ts-ignore`
+- Biome for formatting — `pnpm lint:fix` before committing
+- Conventional commits — required for release-please automation
+
+## Release Process
+
+Releases are fully automated:
+1. Commit with conventional commit messages
+2. release-please opens a versioned PR automatically
+3. Merge the PR → release created → npm published → docs deployed