spinup-ts 0.1.0

package/template/docs/developer-guide/data-model.md

@@ -0,0 +1,25 @@
+---
+title: Data Model
+---
+
+# Data Model
+
+## Core Types
+
+Replace with your project's core TypeScript types and their relationships.
+
+```typescript
+// Example: your primary type
+export interface YourType {
+  id: string;
+  // ...
+}
+```
+
+## Relationships
+
+Describe how types relate to each other. Use a diagram if helpful.
+
+## Validation
+
+Describe how input validation works (Zod, custom validators, etc.).

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

@@ -0,0 +1,12 @@
+---
+title: Developer Guide
+---
+
+# Developer Guide
+
+This section is for developers working on __PROJECT_NAME__ itself.
+
+- [Architecture](./architecture) — high-level design
+- [Data Model](./data-model) — types and schema
+- [Testing](./testing) — test strategy and patterns
+- [Contributing](./contributing) — how to contribute

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

@@ -0,0 +1,40 @@
+---
+title: Testing
+---
+
+# Testing
+
+## Test Structure
+
+```
+src/
+└── __tests__/
+    ├── unit/
+    └── integration/
+```
+
+## Running Tests
+
+```bash
+pnpm test               # all tests
+pnpm test:coverage      # with coverage report
+pnpm test -- --watch    # watch mode
+```
+
+## Writing Tests
+
+```typescript
+import { describe, it, expect } from 'vitest';
+import { yourFunction } from '../src/index.js';
+
+describe('yourFunction', () => {
+  it('should do X when given Y', () => {
+    const result = yourFunction(input);
+    expect(result).toEqual(expected);
+  });
+});
+```
+
+## Testing Philosophy
+
+Replace with your project's specific testing approach and conventions.

package/template/docs/examples.md

@@ -0,0 +1,37 @@
+---
+title: Examples
+---
+
+# Examples
+
+## Basic Example
+
+```typescript
+import { yourExport } from '__PROJECT_NAME__';
+
+// Replace with a complete, copy-pasteable example
+const result = yourExport({ input: 'hello' });
+console.log(result);
+```
+
+## Advanced Example
+
+```typescript
+import { yourExport, AnotherExport } from '__PROJECT_NAME__';
+
+// Replace with a more complex but realistic usage example
+```
+
+## Real-World Patterns
+
+### Pattern 1: Replace with a common pattern name
+
+```typescript
+// Replace with real code
+```
+
+### Pattern 2: Another common use case
+
+```typescript
+// Replace with real code
+```

package/template/docs/getting-started.md

@@ -0,0 +1,42 @@
+---
+title: Getting Started
+---
+
+# Getting Started
+
+## 1. Install
+
+```bash
+pnpm add __PROJECT_NAME__
+```
+
+## 2. Basic Usage
+
+```typescript
+import { yourMainExport } from '__PROJECT_NAME__';
+
+// Replace with the simplest real usage example
+const result = yourMainExport({
+  // required options
+});
+```
+
+## 3. Configuration
+
+```typescript
+import { yourMainExport } from '__PROJECT_NAME__';
+
+const result = yourMainExport({
+  // common configuration options
+  option1: 'value',
+  option2: true,
+});
+```
+
+See the [Configuration reference](./reference/configuration) for all options.
+
+## Next Steps
+
+- [User Guide](./user-guide/) — in-depth feature documentation
+- [API Reference](./api) — auto-generated from TypeScript types
+- [Examples](./examples) — real-world usage patterns

package/template/docs/installation.md

@@ -0,0 +1,45 @@
+---
+title: Installation
+---
+
+# Installation
+
+## Requirements
+
+- Node.js `>= __NODE_VERSION__`
+- A package manager: pnpm (recommended), npm, or bun
+
+## Install
+
+**pnpm (recommended)**
+
+```bash
+pnpm add __PROJECT_NAME__
+```
+
+**npm**
+
+```bash
+npm install __PROJECT_NAME__
+```
+
+**bun**
+
+```bash
+bun add __PROJECT_NAME__
+```
+
+## Verify
+
+```typescript
+import { yourExport } from '__PROJECT_NAME__';
+// Replace with a real smoke-test import
+```
+
+## Peer Dependencies
+
+List any peer dependencies here. If none, remove this section.
+
+## Next Steps
+
+→ [Getting Started](./getting-started)

package/template/docs/intro.md

@@ -0,0 +1,60 @@
+---
+id: intro
+slug: /
+title: __PROJECT_NAME__
+description: __DESCRIPTION__
+---
+
+# __PROJECT_NAME__
+
+> **__DESCRIPTION__**
+
+[![npm](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)
+[![License: __LICENSE__](https://img.shields.io/badge/License-__LICENSE__-yellow.svg)](https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__/blob/main/LICENSE)
+
+---
+
+## Why __PROJECT_NAME__?
+
+:::tip The short version
+Replace this with your one-sentence value proposition. What does __PROJECT_NAME__ do that nothing else does?
+:::
+
+**The problem:** Describe the specific pain point your library solves. Be concrete — what does a developer have to do today without your library?
+
+**The solution:** __PROJECT_NAME__ solves this with a clean, TypeScript-first API. One import, zero configuration, full type safety.
+
+---
+
+## Features
+
+| | Feature | Description |
+|---|---------|-------------|
+| ⚡ | **Fast** | Replace with a real performance claim or benchmark |
+| 🔒 | **Type-safe** | Full TypeScript with strict types and IntelliSense |
+| 🧪 | **Well tested** | Comprehensive test suite with >90% coverage |
+| 📦 | **Lightweight** | Zero unnecessary dependencies |
+| 🔌 | **Extensible** | Replace with your extensibility story |
+
+---
+
+## Install Now
+
+```bash
+pnpm add __PROJECT_NAME__
+```
+
+```typescript
+import { yourExport } from '__PROJECT_NAME__';
+
+// Replace with the simplest possible usage example
+const result = yourExport({ input: 'value' });
+console.log(result);
+```
+
+**[Get Started →](./getting-started)** · **[API Reference →](./api)** · **[GitHub →](https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__)**
+
+---
+
+*Built with TypeScript. __LICENSE__ License. Made by [__AUTHOR__](https://github.com/__GITHUB_HANDLE__).*

package/template/docs/reference/cli.md

@@ -0,0 +1,32 @@
+---
+title: CLI Reference
+---
+
+# CLI Reference
+
+Remove this page if __PROJECT_NAME__ is not a CLI tool.
+
+## Commands
+
+### `__PROJECT_SLUG__ <command>`
+
+Replace with your actual CLI command structure.
+
+| Command | Description |
+|---------|-------------|
+| `init` | Replace with real command |
+| `run` | Replace with real command |
+
+## Global Flags
+
+| Flag | Description |
+|------|-------------|
+| `--help`, `-h` | Show help |
+| `--version`, `-v` | Show version |
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| `0` | Success |
+| `1` | Error |

package/template/docs/reference/configuration.md

@@ -0,0 +1,33 @@
+---
+title: Configuration Reference
+---
+
+# Configuration Reference
+
+## Full Config Schema
+
+```typescript
+interface Config {
+  // Replace with your actual Config interface
+  required: string;
+  optional?: boolean;
+}
+```
+
+## Options
+
+### `required`
+
+**Type:** `string` · **Required:** yes
+
+Description of this option.
+
+### `optional`
+
+**Type:** `boolean` · **Default:** `false`
+
+Description of this option.
+
+## Configuration Sources
+
+List where configuration can come from (constructor args, env vars, config file, etc.).

package/template/docs/reference/hooks.md

@@ -0,0 +1,27 @@
+---
+title: Hooks Reference
+---
+
+# Hooks Reference
+
+Remove this page if __PROJECT_NAME__ does not have a hooks/plugin system.
+
+## Available Hooks
+
+| Hook | When it fires | Arguments |
+|------|--------------|-----------|
+| `onInit` | Replace with real hook | `(config: Config) => void` |
+
+## Example
+
+```typescript
+import { createInstance } from '__PROJECT_NAME__';
+
+const instance = createInstance({
+  hooks: {
+    onInit: (config) => {
+      console.log('Initialized', config);
+    },
+  },
+});
+```

package/template/docs/research/competitor-analysis.md

@@ -0,0 +1,21 @@
+---
+title: Competitor Analysis
+---
+
+# Competitor Analysis
+
+## Comparison Table
+
+| Feature | __PROJECT_NAME__ | Alt A | Alt B |
+|---------|-----------------|-------|-------|
+| TypeScript-first | ✅ | ❌ | ⚠️ |
+| Bundle size | TBD | TBD | TBD |
+| Replace with real feature | | | |
+
+## Key Differentiators
+
+List what makes __PROJECT_NAME__ genuinely different, not just feature-matched.
+
+## Migration from Competitors
+
+If relevant, describe how to migrate from the most common competing library.

package/template/docs/research/real-world-demand.md

@@ -0,0 +1,21 @@
+---
+title: Real-World Demand
+---
+
+# Real-World Demand
+
+## Problem Evidence
+
+Replace with evidence that the problem your library solves is real and common.
+Links to Stack Overflow questions, GitHub issues, forum posts, etc.
+
+## Existing Solutions
+
+| Solution | Approach | Gap |
+|----------|----------|-----|
+| Competitor A | How they solve it | What's missing |
+| Competitor B | How they solve it | What's missing |
+
+## Our Position
+
+Why __PROJECT_NAME__ fills the gap better than existing solutions.

package/template/docs/user-guide/configuration.md

@@ -0,0 +1,32 @@
+---
+title: Configuration
+---
+
+# Configuration
+
+## Configuration Object
+
+```typescript
+import type { Config } from '__PROJECT_NAME__';
+
+const config: Config = {
+  // Replace with your actual configuration options
+  option1: 'default-value',
+  option2: true,
+};
+```
+
+## Options Reference
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `option1` | `string` | `'default'` | Replace with real option description |
+| `option2` | `boolean` | `true` | Replace with real option description |
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `__PROJECT_SLUG___OPTION` | Replace with real env var if applicable |
+
+Replace or remove this section if your library doesn't use environment variables.

package/template/docs/user-guide/features.md

@@ -0,0 +1,21 @@
+---
+title: Features
+---
+
+# Features
+
+## Feature 1: Replace with your feature name
+
+Describe what this feature does and why it's useful.
+
+```typescript
+// Show a code example of using this feature
+```
+
+## Feature 2: Another feature
+
+Describe the second major feature.
+
+## Feature 3: Third feature
+
+Add as many feature sections as you have features.

package/template/docs/user-guide/how-it-works.md

@@ -0,0 +1,29 @@
+---
+title: How It Works
+---
+
+# How It Works
+
+Replace this section with your project's core concepts and mental model.
+
+## Core Concepts
+
+### Concept 1
+
+Explain the first key concept. Use analogies where helpful.
+
+### Concept 2
+
+Explain the second key concept.
+
+## Data Flow
+
+Describe how data flows through your library from input to output.
+
+```
+Input → [Step 1] → [Step 2] → Output
+```
+
+## Key Design Decisions
+
+Explain any non-obvious design choices that affect how users interact with the library.

package/template/docs/user-guide/index.md

@@ -0,0 +1,11 @@
+---
+title: User Guide
+---
+
+# User Guide
+
+Welcome to the __PROJECT_NAME__ User Guide. This section covers everything you need to use __PROJECT_NAME__ effectively.
+
+- [How It Works](./how-it-works) — core concepts and mental model
+- [Configuration](./configuration) — all configuration options
+- [Features](./features) — feature-by-feature documentation

package/template/docusaurus.config.ts

@@ -0,0 +1,93 @@
+import type { Config } from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+const config: Config = {
+  title: '__PROJECT_NAME__',
+  tagline: '__DESCRIPTION__',
+  favicon: 'img/logo.svg',
+
+  url: 'https://__GITHUB_HANDLE__.github.io',
+  baseUrl: '/__PROJECT_NAME__/',
+  organizationName: '__GITHUB_HANDLE__',
+  projectName: '__PROJECT_NAME__',
+  trailingSlash: false,
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  plugins: [
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        entryPoints: ['./src/index.ts'],
+        tsconfig: './tsconfig.json',
+        out: 'api',
+        sidebar: {
+          categoryLabel: 'API Reference',
+        },
+      },
+    ],
+    [
+      'docusaurus-plugin-llms',
+      {
+        generateLLMsTxt: true,
+        generateMarkdownFiles: true,
+      },
+    ],
+  ],
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          sidebarPath: './sidebars.ts',
+          editUrl: 'https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__/edit/main/',
+          routeBasePath: '/',
+        },
+        blog: false,
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    navbar: {
+      title: '__PROJECT_NAME__',
+      items: [
+        {
+          type: 'docSidebar',
+          sidebarId: 'mainSidebar',
+          position: 'left',
+          label: 'Docs',
+        },
+        {
+          href: 'https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      copyright: `Copyright © __YEAR__ __AUTHOR__. Built with <a href="https://docusaurus.io">Docusaurus</a>.`,
+    },
+    colorMode: {
+      defaultMode: 'light',
+      disableSwitch: false,
+      respectPrefersColorScheme: true,
+    },
+    // Algolia DocSearch — apply at https://docsearch.algolia.com/apply/
+    // algolia: {
+    //   appId: 'YOUR_APP_ID',
+    //   apiKey: 'YOUR_SEARCH_API_KEY',
+    //   indexName: '__PROJECT_SLUG__',
+    // },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

package/template/eslint.config.mjs

@@ -0,0 +1,66 @@
+import tseslint from 'typescript-eslint';
+import unicorn from 'eslint-plugin-unicorn';
+import sonarjs from 'eslint-plugin-sonarjs';
+import importX from 'eslint-plugin-import-x';
+import noSecrets from 'eslint-plugin-no-secrets';
+
+export default tseslint.config(
+  ...tseslint.configs.strictTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+  unicorn.configs['flat/recommended'],
+  sonarjs.configs.recommended,
+  importX.flatConfigs.recommended,
+  importX.flatConfigs.typescript,
+  {
+    plugins: { 'no-secrets': noSecrets },
+    languageOptions: {
+      parserOptions: {
+        project: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/no-misused-promises': ['error', { checksVoidReturn: { attributes: false } }],
+      '@typescript-eslint/require-await': 'error',
+      '@typescript-eslint/no-unnecessary-condition': 'error',
+      '@typescript-eslint/consistent-type-imports': ['error', { prefer: 'type-imports', fixStyle: 'inline-type-imports' }],
+      '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true, allowTypedFunctionExpressions: true, allowHigherOrderFunctions: true }],
+      '@typescript-eslint/restrict-template-expressions': ['error', { allowNumber: true }],
+      '@typescript-eslint/consistent-type-assertions': ['error', { assertionStyle: 'as', objectLiteralTypeAssertions: 'never' }],
+      'sonarjs/cognitive-complexity': ['error', 10],
+      'sonarjs/no-duplicate-string': ['error', { threshold: 3 }],
+      'max-lines-per-function': ['warn', { max: 80, skipBlankLines: true, skipComments: true, IIFEs: true }],
+      'max-lines': ['warn', { max: 400, skipBlankLines: true, skipComments: true }],
+      'max-params': ['error', { max: 5 }],
+      'max-depth': ['error', { max: 5 }],
+      'max-statements': ['warn', { max: 20 }, { ignoreTopLevelFunctions: true }],
+      'no-empty': ['error', { allowEmptyCatch: false }],
+      'unicorn/error-message': 'error',
+      'unicorn/catch-error-name': 'error',
+      'unicorn/custom-error-definition': 'error',
+      'import-x/no-relative-parent-imports': 'error',
+      'import-x/no-cycle': ['error', { maxDepth: 10 }],
+      'import-x/order': 'off',
+      'import-x/no-duplicates': 'off',
+      'no-secrets/no-secrets': ['error', { tolerance: 4.5 }],
+      '@typescript-eslint/no-magic-numbers': ['warn', { ignore: [-1, 0, 1, 2, 10, 100, 1000], ignoreArrayIndexes: true, ignoreDefaultValues: true, ignoreClassFieldInitialValues: true, ignoreEnums: true, ignoreNumericLiteralTypes: true, ignoreReadonlyClassProperties: true, enforceConst: true }],
+      'unicorn/prevent-abbreviations': ['error', { replacements: { props: false, ref: false, ctx: false, req: false, res: false, err: false, db: false, id: false, env: false, fn: false, dir: false, src: false, dest: false, tmp: false, config: false, args: false } }],
+      'unicorn/no-null': 'off',
+      'unicorn/filename-case': ['error', { case: 'kebabCase', multipleFileExtensions: true }],
+      'unicorn/no-process-exit': 'off',
+    },
+  },
+  {
+    // Typed ESLint covers `src` only; tests are formatted/linted by Biome and
+    // type-checked by `tsc`/Vitest (keeps `pnpm lint` green out of the box).
+    ignores: [
+      'node_modules/**',
+      'dist/**',
+      'tests/**',
+      'coverage/**',
+      '*.config.mjs',
+      'vitest.config.ts',
+    ],
+  },
+);