Template
jmiller
19663b699d
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 15s
Universal: Changelog Validation / Validate CHANGELOG.md (pull_request) Failing after 5s
Generic: Repo Health / Access control (pull_request) Successful in 3s
Generic: Repo Health / Site Health (pull_request) Has been skipped
Generic: Project CI / Lint & Validate (pull_request) Successful in 26s
Generic: Standards Compliance / Secret Scanning (pull_request) Successful in 6s
Generic: Standards Compliance / License Header Validation (pull_request) Successful in 7s
Generic: Standards Compliance / Repository Structure Validation (pull_request) Failing after 6s
Generic: Standards Compliance / Coding Standards Check (pull_request) Successful in 7s
Generic: Standards Compliance / Documentation Quality Check (pull_request) Successful in 6s
Generic: Standards Compliance / Workflow Configuration Check (pull_request) Failing after 7s
Generic: Standards Compliance / README Completeness Check (pull_request) Failing after 5s
Generic: Standards Compliance / Git Repository Hygiene (pull_request) Successful in 5s
Generic: Standards Compliance / Line Length Check (pull_request) Successful in 5s
Generic: Standards Compliance / Script Integrity Validation (pull_request) Successful in 7s
Generic: Standards Compliance / File Naming Standards (pull_request) Successful in 5s
Generic: Standards Compliance / Insecure Code Pattern Detection (pull_request) Successful in 5s
Generic: Standards Compliance / Version Consistency Check (pull_request) Successful in 1m11s
Generic: Standards Compliance / Dead Code Detection (pull_request) Successful in 8s
Generic: Standards Compliance / File Size Limits (pull_request) Successful in 5s
Generic: Standards Compliance / Binary File Detection (pull_request) Successful in 7s
Generic: Standards Compliance / TODO/FIXME Tracking (pull_request) Successful in 6s
Generic: Standards Compliance / Code Duplication Detection (pull_request) Successful in 1m11s
Generic: Standards Compliance / Code Complexity Analysis (pull_request) Successful in 1m12s
Generic: Standards Compliance / Broken Link Detection (pull_request) Successful in 6s
Generic: Standards Compliance / API Documentation Coverage (pull_request) Successful in 7s
Generic: Standards Compliance / Accessibility Check (pull_request) Successful in 5s
Generic: Standards Compliance / Performance Metrics (pull_request) Successful in 4s
Generic: Standards Compliance / Unused Dependencies Check (pull_request) Successful in 59s
Generic: Standards Compliance / Dependency Vulnerability Scanning (pull_request) Successful in 1m3s
Generic: Standards Compliance / Terraform Configuration Validation (pull_request) Successful in 11s
Universal: Auto-Assign / Assign unassigned issues and PRs (pull_request_target) Successful in 2s
Generic: Standards Compliance / Enterprise Readiness Check (pull_request) Successful in 1m1s
Generic: Standards Compliance / Repository Health Check (pull_request) Successful in 1m3s
Generic: Project CI / Tests (pull_request) Has been cancelled
Generic: Repo Health / Scripts governance (pull_request) Has been cancelled
Generic: Repo Health / Repository health (pull_request) Has been cancelled
Generic: Repo Health / Report: Scripts Governance (pull_request) Has been cancelled
Generic: Repo Health / Report: Repository Health (pull_request) Has been cancelled
Generic: Standards Compliance / Compliance Summary (pull_request) Has been cancelled
Branch Policy Check / Verify merge target (pull_request) Has been cancelled
Universal: PR Check / Branch Policy (pull_request) Has been cancelled
Universal: PR Check / Secret Scan (pull_request) Has been cancelled
Universal: PR Check / Validate PR (pull_request) Has been cancelled
Branch Cleanup / Delete merged branch (pull_request) Has been cancelled
RC Revert / Rename rc/ back to dev/ (pull_request) Has been cancelled
Universal: PR Check / Build RC Package (pull_request) Has been cancelled
Universal: PR Check / Report Issues (pull_request) Has been cancelled
Add the canonical Moko exclusions matching the Template repos: .gemini/ alongside .claude/, the AI client-instructions block, and the local wiki clone block (wiki/, docs/). Update CLAUDE.md never-commit rule if present. Authored-by: Moko Consulting
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code when working with this repository.
|
|
|
|
## Project Overview
|
|
|
|
**Template-NPM** -- Template repository for creating MokoCLI-compliant MCP API servers
|
|
|
|
| Field | Value |
|
|
|---|---|
|
|
| **Platform** | mcp-server |
|
|
| **Language** | TypeScript |
|
|
| **Default branch** | main |
|
|
| **License** | GPL-3.0-or-later |
|
|
| **Wiki** | [Template-NPM Wiki](https://git.mokoconsulting.tech/MokoConsulting/Template-NPM/wiki) |
|
|
| **Standards** | [MokoCLI](https://git.mokoconsulting.tech/MokoConsulting/mokocli/wiki/Home) |
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
make build # Build the project
|
|
make lint # Run linters
|
|
make validate # Validate structure
|
|
make release # Full release pipeline
|
|
make minify # Minify CSS/JS assets
|
|
make clean # Clean build artifacts
|
|
```
|
|
|
|
```bash
|
|
npm install # Install dependencies
|
|
npm run build # Compile TypeScript
|
|
npm run dev # Development mode
|
|
```
|
|
|
|
## Architecture
|
|
|
|
This is an MCP (Model Context Protocol) server. Key files:
|
|
- `source/index.ts` -- server entry point and tool registration
|
|
- `source/config.ts` -- configuration loading
|
|
- `source/tools/` -- individual tool implementations
|
|
- `dist/` -- compiled output (gitignored)
|
|
|
|
## Rules
|
|
|
|
- **Workflow directory**: `.mokogit/` (not `.gitea/` or `.github/`)
|
|
|
|
- **Never commit** `.claude/`, `.gemini/`, `.mcp.json`, `TODO.md`, or `*.min.css`/`*.min.js`
|
|
- **Attribution**: use `Authored-by: Moko Consulting` in commits
|
|
- **Branch strategy**: develop on `dev`, merge to `main` for release
|
|
- **Minification**: handled at build time (CI) and runtime (MokoMinifyHelper for Joomla templates)
|
|
- **Wiki**: documentation lives in the MokoGIT wiki, not in `docs/` files
|
|
- **Standards**: this repo follows [MokoCLI](https://git.mokoconsulting.tech/MokoConsulting/mokocli/wiki/Home)
|