diff --git a/.coderabbit.yaml b/.coderabbit.yaml
index a3ddd6b..ffa2831 100644
--- a/.coderabbit.yaml
+++ b/.coderabbit.yaml
@@ -42,6 +42,13 @@ reviews:
# Auto-generate PR title following Conventional Commits
auto_title_instructions: "Generate the PR title following the Conventional Commits specification (e.g., 'feat:', 'fix:', 'chore:', 'docs:'). Keep it concise and descriptive."
+ # Path-specific instructions for generated content
+ path_instructions:
+ - path: "docs/testing/**"
+ instructions: "Place all test documentation, summaries, and generated test reports here."
+ - path: "*.md"
+ instructions: "Root-level markdown files should only contain essential project documentation (README, CHANGELOG, etc.). Generated documentation belongs in docs/."
+
chat:
# Enable conversational bot on PRs
auto_reply: true
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index b169bd7..f9bdc8f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -21,7 +21,7 @@ jobs:
- uses: oven-sh/setup-bun@v2
with:
- bun-version: 1.3.5
+ bun-version: 1.3.7
- name: Cache Bun dependencies
uses: actions/cache@v4
@@ -41,7 +41,7 @@ jobs:
run: bun run format:check
- name: Type check
- run: bun run type-check
+ run: bun run typecheck
- name: Run tests
run: bun test
@@ -55,7 +55,7 @@ jobs:
- uses: oven-sh/setup-bun@v2
with:
- bun-version: 1.3.5
+ bun-version: 1.3.7
- name: Cache Bun dependencies
uses: actions/cache@v4
diff --git a/.github/workflows/generate-demo.yml b/.github/workflows/generate-demo.yml
index 3ff65e7..24555b3 100644
--- a/.github/workflows/generate-demo.yml
+++ b/.github/workflows/generate-demo.yml
@@ -25,7 +25,7 @@ jobs:
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
- bun-version: 1.3.5
+ bun-version: 1.3.7
- name: Install dependencies
run: bun install --frozen-lockfile
diff --git a/.vscode/snake-evolution.code-workspace b/.vscode/snake-evolution.code-workspace
index 9593cdf..e6f6fc8 100644
--- a/.vscode/snake-evolution.code-workspace
+++ b/.vscode/snake-evolution.code-workspace
@@ -1,33 +1,37 @@
{
"folders": [
{
- "name": "ð root",
+ "name": "|___ð SNAKE",
"path": ".."
},
{
- "name": "ðŠ packages/cli",
+ "name": " |___ð WEB",
+ "path": "../apps/web"
+ },
+ {
+ "name": " |___â¡ API",
+ "path": "../apps/api"
+ },
+ {
+ "name": " |___ðŠ CLI",
"path": "../packages/cli"
},
{
- "name": "ðŠ packages/engine",
+ "name": " |___ðŠ ENGINE",
"path": "../packages/engine"
},
{
- "name": "ðŠ packages/renderer",
+ "name": " |___ðŠ RENDER",
"path": "../packages/renderer"
},
{
- "name": "ðŠ packages/github",
+ "name": " |___ðŠ GITHUB",
"path": "../packages/github"
},
{
- "name": "ðŠ packages/types",
+ "name": " |___ðŠ TYPES",
"path": "../packages/types"
},
- {
- "name": "ð apps/web",
- "path": "../apps/web"
- },
{
"name": "â¡ apps/api",
"path": "../apps/api"
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 576f874..eb68d31 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,10 +13,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- **SVG Sanitization** - Replaced fragile regex-based sanitization with `isomorphic-dompurify` for robust, isomorphic SVG sanitization in both browser and server environments
- **ReDoS Fix** - Fixed polynomial regex vulnerability by replacing with O(1) string checks
+### Added
+
+- **README Files** - Added professional README.md documentation to all packages and directories:
+ - `packages/engine`, `packages/renderer`, `packages/github`, `packages/types`, `packages/ui`
+ - `packages/biome-config`, `packages/typescript-config`
+ - `apps/api`, `docker`, `scripts`
+
+### Breaking Changes
+
+- **Script & Turbo Task Changes (BREAKING)** - Consolidated root `package.json` scripts and removed Turbo tasks that may be referenced in local workflows and CI/CD pipelines:
+ - `format` + `format:check` merged into `lint` (Biome now handles both formatting and checks)
+ - `quality` + `precommit` consolidated into `check`
+ - `type-check` renamed to `typecheck`
+ - `clean:all` merged into `clean`
+ - Removed unused Turbo tasks from `turbo.json`: `test:watch`, `format`, `format:check`
+
+
+### Changed
+
+_No changes in this category for this release._
+
### Fixed
- Removed deprecated `@types/dompurify` package (dompurify has built-in types)
- Fixed test for empty format string to correctly expect "svg" default
+- Removed duplicate `SECURITY.md` from root (using `.github/SECURITY.md`)
### Removed
diff --git a/README.md b/README.md
index d1b4c96..ca7aa51 100644
--- a/README.md
+++ b/README.md
@@ -2,31 +2,17 @@
- Turn your GitHub contributions into an animated snake that devours them! -
-- Quick Start ⢠- Themes ⢠- GitHub Action ⢠- CLI ⢠- PvP Mode + Turn your GitHub contributions into an animated snake that devours them!
---- -
+
+
-
-
-
-
-
-
-
-
-
-
- Built with ð by @miccy -
+ diff --git a/RELEASE_SETUP.md b/RELEASE_SETUP.md new file mode 100644 index 0000000..e67dc6b --- /dev/null +++ b/RELEASE_SETUP.md @@ -0,0 +1,51 @@ +# Release Setup & Process + +This document outlines the steps to release new versions of Snake Evolution packages. + +## Prerequisites + +- **GitHub Repository Settings**: Ensure `Allow auto-merge` is enabled. +- **Secrets**: `NPM_TOKEN` must be set in GitHub Actions secrets. +- **Permissions**: You need write access to the repository and npm organization. + +## Step 1: Create Changesets + +When making changes, generate a changeset file to document them: + +```bash +bun changeset +``` + +Select the affected packages and write a summary. + +## Step 2: Push Changes + +Commit the changeset file along with your code changes. + +```bash +git add . +git commit -m "feat: my cool feature" +git push +``` + +## Step 3: Create Release Pull Request + +When `main` has new changesets, the "Release" GitHub Action will automatically create a "Release Packages" PR. + +## Step 4: Verify Release + +1. Review the Release PR. +2. Ensure tests pass in CI. +3. Check the CHANGELOG updates. + +## Step 5: Merge and Publish + +Merge the Release PR. The GitHub Action will detect the merge, create a git tag for the release, build the packages, and publish them to npm. + +*Key actions:* `git tag`, `release` workflow. + +## Verification Checklist + +- [ ] All tests passed +- [ ] Documentation updated +- [ ] Changelog is correct diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 0172c41..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,43 +0,0 @@ -# Security Policy - -## Supported Versions - -| Version | Supported | -| ------- | ------------------ | -| 1.x.x | :white_check_mark: | -| < 1.0 | :x: | - -## Reporting a Vulnerability - -If you discover a security vulnerability, please report it by: - -1. **DO NOT** open a public GitHub issue -2. Email us at:- â Star the repo to show support and stay updated! -
- -- ð Request a Feature ⢠- ð¬ Discussions -
- ---- - -**Last Updated:** December 18, 2024 -**Maintained By:** [@miccy](https://github.com/miccy) diff --git a/package.json b/package.json index 447bf84..c2e759c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "snake-evolution", "private": true, - "version": "1.2.4", + "version": "1.3.0", "description": "Transform your GitHub contribution graph into an epic snake animation", "repository": { "type": "git", @@ -16,45 +16,39 @@ "dev:api": "turbo run dev --filter=@snake-evolution/api", "build": "turbo run build", "build:web": "turbo run build --filter=@snake-evolution/web", - "build:api": "turbo run build --filter=@snake-evolution/api", "build:cli": "turbo run build --filter=@snake-evolution/cli", "test": "turbo run test", - "test:watch": "turbo run test:watch", - "lint": "biome check . && bun run lint:md", - "lint:fix": "biome check --fix . && bun run lint:md:fix", - "lint:md": "markdownlint-cli2 '*.md' 'docs/**/*.md' '.github/**/*.md' --config .markdownlint.jsonc", - "lint:md:fix": "markdownlint-cli2 --fix '*.md' 'docs/**/*.md' '.github/**/*.md' --config .markdownlint.jsonc", + "lint": "biome check . && markdownlint-cli2 '*.md' 'docs/**/*.md' '.github/**/*.md' 'apps/*/src/**/*.md' 'apps/*/*.md' 'packages/*/*.md' 'packages/*/src/**/*.md' 'docker/*.md' 'scripts/*.md' '__tests__/*.md' --config .markdownlint.jsonc", + "lint:fix": "biome check --write . && markdownlint-cli2 --fix '*.md' 'docs/**/*.md' '.github/**/*.md' 'apps/*/src/**/*.md' 'apps/*/*.md' 'packages/*/*.md' 'packages/*/src/**/*.md' 'docker/*.md' 'scripts/*.md' '__tests__/*.md' --config .markdownlint.jsonc", "format": "biome format --write .", "format:check": "biome format .", - "type-check": "tsc --noEmit && turbo run type-check --filter=@snake-evolution/web", - "clean": "turbo run clean && rm -rf .turbo", - "clean:all": "turbo run clean && rm -rf node_modules .turbo bun.lock && find . -name 'node_modules' -type d -prune -exec rm -rf {} + 2>/dev/null || true", - "reinstall": "bun run clean:all && bun install", - "fix": "bun run lint:fix && bun run format", - "check": "bun run lint && bun run format:check && bun run type-check", - "quality": "bun run check && bun run test", - "precommit": "bun run check", + "typecheck": "tsc --noEmit && turbo run type-check --filter='!//'", + "check": "bun run lint && bun run typecheck", + "fix": "bun run lint:fix", + "clean": "turbo run clean && rm -rf .turbo node_modules", + "reinstall": "bun run clean && bun install", "snake": "bun run packages/cli/src/index.ts", "generate": "bun run packages/cli/src/index.ts generate", + "quality": "bun run lint:fix && bun run format && bun run typecheck && bun run test && bun run packages/cli/src/index.ts generate -u miccy -t github-dark -o dist/smoke-check.svg", "changeset": "changeset", "version": "changeset version", "release": "changeset publish" }, "devDependencies": { - "@biomejs/biome": "^2.3.10", + "@biomejs/biome": "^2.3.13", "@changesets/cli": "^2.29.8", - "@types/bun": "1.3.5", + "@types/bun": "1.3.7", "jsonc-parser": "^3.3.1", "markdownlint-cli2": "^0.20.0", - "turbo": "^2.7.1", + "turbo": "^2.8.0", "typescript": "5.9.3", "yaml": "2.8.2" }, "engines": { - "node": ">=22", + "node": ">=24", "bun": ">=1.3.0" }, - "packageManager": "bun@1.3.5", + "packageManager": "bun@1.3.7", "workspaces": [ "apps/*", "packages/*" diff --git a/packages/biome-config/README.md b/packages/biome-config/README.md new file mode 100644 index 0000000..d2d7e84 --- /dev/null +++ b/packages/biome-config/README.md @@ -0,0 +1,18 @@ +# @snake-evolution/biome-config + +Shared [Biome](https://biomejs.dev/) configuration for the Snake Evolution monorepo. + +## Usage + +Extend this configuration in your package's `biome.json`: + +## What's Included + +- **Linting** â TypeScript-aware rules +- **Formatting** â Consistent code style (tabs, 100 char width) +- **Import Sorting** â Automatic organization + +## Related + +- **Formatting** â Consistent code style (2-space indentation, LF line endings) +- [`@snake-evolution/typescript-config`](../typescript-config) â TypeScript settings diff --git a/packages/biome-config/biome.json b/packages/biome-config/biome.json index 172a490..fee9319 100644 --- a/packages/biome-config/biome.json +++ b/packages/biome-config/biome.json @@ -1,5 +1,5 @@ { - "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json", + "$schema": "https://biomejs.dev/schemas/2.3.13/schema.json", "root": false, "linter": { "enabled": true, diff --git a/packages/biome-config/package.json b/packages/biome-config/package.json index 745be29..a932715 100644 --- a/packages/biome-config/package.json +++ b/packages/biome-config/package.json @@ -1,6 +1,6 @@ { "name": "@snake-evolution/biome-config", - "version": "1.2.4", + "version": "1.3.0", "private": true, "license": "MIT", "description": "Shared Biome configuration for snake-evolution monorepo", diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 2b0c31c..3270eb9 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,11 @@ # @snake-evolution/cli +## 1.3.0 + +### Minor Changes + +- feat: Implemented matching 12-month rolling contribution window. Updated Node requirements to >=24.0.0. Added support for GIF sampling to reduce file size. Overhauled documentation. + ## 1.2.4 ### Security diff --git a/packages/cli/package.json b/packages/cli/package.json index 6f9c7e2..c2fbdda 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@snake-evolution/cli", - "version": "1.2.4", + "version": "1.3.0", "description": "Generate animated snake eating your GitHub contributions", "license": "MIT", "author": "Miccy