Skip to content

velonone/CodePulse

Repository files navigation

CodePulse

Production-grade TypeScript project template with 4-layer automated quality pipeline. One click "Use this template" on GitHub — instant professional project setup.

What You Get

Your New Project/
├── .vscode/                    ← VS Code: auto-fix on save, 11 tasks, 9 extensions
├── .clinerules/                ← AI rules for Cline / Continue.dev (5 files)
├── .github/
│   ├── workflows/qa.yml        ← CI/CD: lint → build → test + coverage
│   └── instructions/           ← GitHub Copilot rules
├── git-hooks/pre-commit        ← Auto-format + CSS lint on commit
├── scripts/
│   ├── onboard.ts              ← First-run bootstrap (human + AI)
│   ├── health-check.ts         ← System diagnostics (read-only)
│   └── setup-git-hooks.js      ← Auto-install hooks on pnpm install
├── src/
│   ├── index.ts                ← Entry point
│   └── index.test.ts           ← Example test
├── .stylelintrc.json           ← CSS quality rules
├── .cursorrules                ← Cursor IDE rules
├── CLAUDE.md                   ← Claude Code rules
├── AGENTS.md                   ← Universal AI agent rules
├── ONBOARD.md                  ← Getting started guide
├── knip.json                   ← Dead code detection config
├── tsconfig.json               ← TypeScript strict mode
└── package.json                ← All scripts pre-configured

Quick Start

From GitHub (Recommended)

  1. Click "Use this template" → Create a new repository
  2. Clone your new repo
  3. Run:
pnpm onboard

Done. Everything is configured.

Manual

git clone https://github.com/YOUR_USERNAME/codepulse my-project
cd my-project
rm -rf .git && git init
pnpm onboard

4-Layer Quality Architecture

Write Code → Ctrl+S
  ↓ Layer 1: Auto-format + CSS fix              (0.1s, zero effort)

git commit
  ↓ Layer 2: Pre-commit hook auto-lint           (3s, zero effort)

Want full check?
  ↓ Layer 3: pnpm qa                             (1-3min, one command)

Push / PR
  ↓ Layer 4: GitHub Actions CI full pipeline      (3-5min, zero effort)

99% of the time you just press Ctrl+S. Everything else is automatic.

Commands

Daily Use (remember these 3)

Command What It Does Time
pnpm fix Auto-fix all fixable issues ~5s
pnpm qa Full quality check (lint + test + coverage) ~1-3min
pnpm qa:full Auto-fix first, then full check ~1-3min

All Commands

Command Purpose
pnpm onboard First-run bootstrap
pnpm onboard:ai Bootstrap for AI agents (JSON output)
pnpm dev Start development
pnpm build TypeScript compile
pnpm lint oxlint check
pnpm lint:css Stylelint check
pnpm test Run tests
pnpm test:watch Tests in watch mode
pnpm test:coverage Tests with V8 coverage
pnpm health Full system diagnostics
pnpm health:fast Quick diagnostics
pnpm dead-code Find unused code (knip)

AI Agent Support

This template has rules for every major AI coding assistant:

AI Tool Rule File Auto-Loaded
Claude Code CLAUDE.md Yes
Cursor .cursorrules Yes
GitHub Copilot .github/instructions/copilot-instructions.md Yes
Cline / Continue.dev .clinerules/ Yes
Any AI AGENTS.md Manual

AI Agent First Command

Run `pnpm onboard --ai` and read the output.
Then read CLAUDE.md and .clinerules/ directory.
Report the project status and ask me what to work on.

The Key Insight: Plugins Find, AI Fixes

┌────────────────────────────────────────┐
│  pnpm qa (plugins do the finding)       │
│                                         │
│  oxlint ───→ TS/JS issues    ┐          │
│  Stylelint ──→ CSS issues     ├─ FREE   │
│  knip ───────→ dead code      │          │
│  vitest ─────→ test failures ┘          │
│                                         │
│  Output: problem list                    │
└─────────────┬──────────────────────────┘
              ▼
┌────────────────────────────────────────┐
│  AI Agent reads the list and fixes      │
│  (saves tokens — no scanning needed)    │
└─────────────┬──────────────────────────┘
              ▼
┌────────────────────────────────────────┐
│  pnpm qa (plugins verify the fix)       │
│  0 errors → commit                      │
└────────────────────────────────────────┘

Tech Stack

Tool Version Purpose
TypeScript 5.9+ Language (strict mode)
Node.js 22+ Runtime
pnpm 10+ Package manager
oxlint 1.43+ TypeScript linting (fast)
oxfmt 0.28+ Code formatting (fast)
Stylelint 17+ CSS linting
Vitest 4+ Testing + V8 coverage
knip 5+ Dead code detection

VS Code Extensions (Auto-Recommended)

Open the project in VS Code → it will prompt you to install:

  • Vitest Explorer — run tests from sidebar
  • Coverage Gutters — see coverage inline
  • Error Lens — see errors inline
  • SonarLint — deep code analysis
  • GitLens — git history
  • Stylelint — CSS linting
  • Color Highlight — color preview
  • axe Linter — accessibility checking
  • Import Cost — package size

Customization

Change Project Name

Edit package.jsonname field and CLAUDE.md → project description.

Add i18n Support

Add to .vscode/extensions.json:

"lokalise.i18n-ally",
"intellsmi.comment-translate"

Add More AI Rules

Copy a .clinerules/ file and customize for your domain.

Remove CSS Linting

If your project has no CSS:

  1. Remove stylelint* from devDependencies
  2. Remove .stylelintrc.json
  3. Remove lint:css scripts

Third-Party Tools Disclaimer

CodePulse is a configuration template that references and configures the following third-party open-source tools. It does NOT include or redistribute their source code:

Tool License Usage
TypeScript Apache-2.0 Language compiler
oxlint MIT Code linting
oxfmt MIT Code formatting
Stylelint MIT CSS linting
Vitest MIT Testing framework
knip ISC Dead code detection
Zod MIT Runtime validation
pnpm MIT Package manager

VS Code extensions referenced in .vscode/extensions.json are installed separately by the user through the VS Code Marketplace and are subject to their own licenses.

All tools are used as devDependencies or recommended extensions only. CodePulse itself contains no third-party code — only configuration files, rule documents, and utility scripts authored by VelonLabs.

Acknowledgments

CodePulse stands on the shoulders of outstanding open-source projects. We are deeply grateful to the maintainers and contributors of:

  • TypeScript by Microsoft — the foundation of type-safe JavaScript
  • oxc (oxlint, oxfmt) by Boshen & contributors — blazing-fast linting and formatting
  • Stylelint — keeping CSS clean and consistent
  • Vitest by Anthony Fu & team — modern, fast testing
  • knip by Lars Kappert — finding unused code so projects stay lean
  • Zod by Colin McDonnell — runtime type safety made simple
  • pnpm by Zoltan Kochan & team — fast, disk-efficient package management
  • VS Code by Microsoft — the editor that ties it all together

VS Code extension authors:

Thank you to everyone who builds and maintains open-source tools. Your work makes projects like CodePulse possible.

License

MIT — see LICENSE

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors