spinup-ts 0.1.0

package/template/justfile

@@ -0,0 +1,51 @@
+# List available recipes
+default:
+  @just --list
+
+# Install dependencies and set up hooks
+install:
+  pnpm install
+
+# Run all quality checks
+check:
+  pnpm typecheck && pnpm lint
+
+# Run tests
+test:
+  pnpm test
+
+# Run tests with coverage
+test-coverage:
+  pnpm test:coverage
+
+# Build the project
+build:
+  pnpm build
+
+# Clean build output
+clean:
+  rm -rf dist coverage
+
+# Build and publish to npm
+release: build
+  pnpm publish
+
+# Start docs dev server
+docs:
+  pnpm docs:start
+
+# Build docs
+docs-build:
+  pnpm docs:build
+
+# Serve built docs locally
+docs-serve:
+  pnpm docs:serve
+
+# Clear Docusaurus cache
+docs-clear:
+  pnpm docs:clear
+
+# Check for unused dependencies
+deps:
+  pnpm depcheck

package/template/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "__PROJECT_NAME__",
+  "version": "0.1.0",
+  "description": "__DESCRIPTION__",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/index.ts",
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest --coverage",
+    "lint": "biome ci . && eslint . --max-warnings=0",
+    "lint:fix": "biome check --write . && eslint --fix .",
+    "format": "biome format --write .",
+    "typecheck": "tsc --noEmit",
+    "check": "pnpm typecheck && pnpm lint",
+    "commit": "cz",
+    "depcheck": "depcheck",
+    "docs:start": "docusaurus start",
+    "docs:build": "docusaurus build",
+    "docs:serve": "docusaurus serve",
+    "docs:clear": "docusaurus clear",
+    "prepare": "husky",
+    "prepublishOnly": "pnpm build"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^3.0.0",
+    "depcheck": "^1.4.7",
+    "eslint": "^9.28.0",
+    "eslint-plugin-import-x": "^4.12.2",
+    "eslint-plugin-no-secrets": "^1.1.2",
+    "eslint-plugin-sonarjs": "^3.0.2",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "@commitlint/cli": "^21.0.2",
+    "@commitlint/config-conventional": "^21.0.2",
+    "commitizen": "^4.3.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.1",
+    "@docusaurus/core": "^3.8.0",
+    "@docusaurus/preset-classic": "^3.8.0",
+    "@docusaurus/types": "^3.8.0",
+    "docusaurus-plugin-llms": "^0.4.0",
+    "docusaurus-plugin-typedoc": "^1.2.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "typedoc": "^0.27.0",
+    "vitest": "^3.0.0"
+  },
+  "__lint-staged__": {
+    "*.{ts,js,json,md}": ["biome check --write --no-errors-on-unmatched --files-ignore-unknown=true"],
+    "*.ts": ["eslint --fix --max-warnings=0 --no-warn-ignored"]
+  },
+  "author": "__AUTHOR__ <__EMAIL__>",
+  "license": "__LICENSE__",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/__GITHUB_HANDLE__/__PROJECT_NAME__.git"
+  },
+  "engines": {
+    "node": ">=__NODE_VERSION__"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": ["@biomejs/biome", "core-js", "esbuild", "unrs-resolver"]
+  },
+  "depcheck": {
+    "ignores": ["react", "react-dom", "@docusaurus/types"]
+  }
+}

package/template/pnpm-workspace.yaml

@@ -0,0 +1,8 @@
+packages:
+  - '.'
+
+allowBuilds:
+  '@biomejs/biome': true
+  core-js: true
+  esbuild: true
+  unrs-resolver: true

package/template/sidebars.ts

@@ -0,0 +1,72 @@
+const sidebars = {
+  mainSidebar: [
+    {
+      type: 'category',
+      label: 'Getting Started',
+      collapsed: false,
+      items: ['intro', 'installation', 'getting-started', 'examples'],
+    },
+    {
+      type: 'category',
+      label: 'User Guide',
+      items: [
+        'user-guide/index',
+        'user-guide/how-it-works',
+        'user-guide/configuration',
+        'user-guide/features',
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Developer Guide',
+      items: [
+        'developer-guide/index',
+        'developer-guide/data-model',
+        'developer-guide/testing',
+        'developer-guide/contributing',
+        'developer-guide/architecture',
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Architecture',
+      items: [
+        'architecture/index',
+        'architecture/constitution',
+        'architecture/data-model',
+        'architecture/project',
+        'architecture/api-layer',
+        'architecture/ui',
+        'architecture/quality-checks',
+        'architecture/testing-plan',
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Reference',
+      items: ['reference/cli', 'reference/configuration', 'reference/hooks'],
+    },
+    {
+      type: 'autogenerated',
+      dirName: 'api',
+    },
+    {
+      type: 'category',
+      label: 'Research',
+      items: ['research/real-world-demand', 'research/competitor-analysis'],
+    },
+    {
+      type: 'category',
+      label: 'Post-mortems',
+      link: {
+        type: 'generated-index',
+        title: 'Post-mortems',
+        description: 'Retrospectives and incident analyses.',
+      },
+      items: [{ type: 'autogenerated', dirName: 'post-mortems' }],
+    },
+    'changelog',
+  ],
+};
+
+export default sidebars;

package/template/src/index.ts

@@ -0,0 +1,3 @@
+export function greet(name: string): string {
+  return `Hello, ${name}!`;
+}

package/template/static/img/logo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="200" height="200" viewBox="0 0 200 200">
+  <rect width="200" height="200" rx="24" fill="#3578e5"/>
+  <text x="100" y="138" font-family="monospace,sans-serif" font-size="96" font-weight="bold" fill="white" text-anchor="middle">TS</text>
+</svg>

package/template/tests/index.test.ts

@@ -0,0 +1,8 @@
+import { describe, expect, it } from 'vitest';
+import { greet } from '@/index.js';
+
+describe('greet', () => {
+  it('returns greeting with name', () => {
+    expect(greet('world')).toBe('Hello, world!');
+  });
+});

package/template/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}

package/template/vitest.config.ts

@@ -0,0 +1,19 @@
+import path from 'node:path';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      '@': path.resolve(import.meta.dirname, 'src'),
+    },
+  },
+  test: {
+    globals: true,
+    environment: 'node',
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'lcov', 'html'],
+      exclude: ['node_modules', 'dist', 'vitest.config.ts'],
+    },
+  },
+});