docs: add CLAUDE.md with project conventions and architecture (#2)

* docs: add CLAUDE.md with project conventions and architecture

* fix(ci): add build step before lint in CI workflow

The lint job imports @pleaseai/eslint-config which requires built
dist/ files. Without building first, ESLint fails with
ERR_PACKAGE_PATH_NOT_EXPORTED.

* style: apply lint auto-fixes across packages

- Reorder package.json properties per eslint-plugin-package-json
- Fix indentation in eslint-config/src/index.ts
- Fix import ordering in eslint-config/src/index.ts
- Add trailing newlines to perttier-config files

Author: amondnet

.github/workflows/ci.yml

@@ -19,6 +19,9 @@ jobs:
       - name: Install dependencies
         run: bun install
 
+      - name: Build packages
+        run: bun run build
+
       - name: Cache ESLint
         uses: actions/cache@v4
         with:

CLAUDE.md

@@ -0,0 +1,47 @@
+# @pleaseai/code-style
+
+Monorepo providing shared code style configurations for PleaseAI projects.
+
+## Tech Stack
+
+- Package manager: bun (>=1.3.10)
+- Build orchestration: Turborepo
+- Module system: ESM only (`"type": "module"`)
+- Node: >=22.0.0
+- TypeScript target: ES2022, moduleResolution: bundler
+
+## Packages
+
+| Package | Path | Build |
+|---------|------|-------|
+| `@pleaseai/eslint-config` | `packages/eslint-config` | tsdown |
+| `@pleaseai/prettier-config` | `packages/perttier-config` | none (JSON only) |
+| `@pleaseai/editorconfig` | `packages/editorconfig` | none (static file) |
+
+## Commands
+
+- `bun install` - Install dependencies
+- `bun run build` - Build all packages via Turborepo
+- `bun run lint` - Lint repo (dogfoods own eslint-config)
+- `bun run lint:fix` - Lint with auto-fix
+
+## Architecture
+
+- `packages/eslint-config` wraps `@antfu/eslint-config` with PleaseAI defaults (2-space indent, single quotes, no semi)
+- `packages/eslint-config/src/package-json.ts` exports `eslint-plugin-package-json` configs
+- Root `eslint.config.ts` dogfoods `@pleaseai/eslint-config`
+
+## Code Style
+
+- Follow @antfu/eslint-config conventions: no semicolons, single quotes, 2-space indent
+- ESM imports only, no CommonJS
+
+## Release
+
+- Uses release-please (Google) for automated versioning and changelogs
+- Config: `release-please-config.json` + `.release-please-manifest.json`
+- Publishing: GitHub Actions workflow publishes to npm on release
+
+## Gotchas
+
+- `packages/perttier-config` directory is intentionally(?) misspelled — do not rename without coordinating release-please config, CI workflows, and npm package name

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@pleaseai/code-style-monorepo",
+  "type": "module",
   "version": "0.0.1",
   "private": true,
-  "type": "module",
+  "packageManager": "bun@1.3.10",
   "description": "code-style for PleaseAI",
   "repository": {
     "type": "git",
     "url": "https://github.com/pleaseai/code-style.git"
   },
-  "packageManager": "bun@1.3.10",
   "engines": {
     "node": ">=22.0.0",
     "bun": ">=1.3.10"

packages/eslint-config/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pleaseai/eslint-config",
-  "version": "0.0.1",
   "type": "module",
+  "version": "0.0.1",
   "description": "ESLint config for PleaseAI projects",
   "exports": {
     ".": {
@@ -21,13 +21,13 @@
   "scripts": {
     "build": "tsdown"
   },
+  "peerDependencies": {
+    "eslint": "^9.10.0 || ^10.0.0"
+  },
   "dependencies": {
     "@antfu/eslint-config": "^7.7.0",
     "eslint-plugin-package-json": "^0.30.0"
   },
-  "peerDependencies": {
-    "eslint": "^9.10.0 || ^10.0.0"
-  },
   "devDependencies": {
     "eslint": "^10.0.3",
     "tsdown": "^0.12.0",

packages/eslint-config/src/index.ts

@@ -1,5 +1,5 @@
-import antfu from '@antfu/eslint-config'
 import type { OptionsConfig, TypedFlatConfigItem } from '@antfu/eslint-config'
+import antfu from '@antfu/eslint-config'
 
 export function pleaseai(
   options: OptionsConfig = {},
@@ -14,9 +14,9 @@ export function pleaseai(
       },
       typescript: true,
       gitignore: true,
-        rules: {
-            'test/prefer-lowercase-title': 'off',
-        },
+      rules: {
+        'test/prefer-lowercase-title': 'off',
+      },
       ...options,
     },
     ...userConfigs,

packages/eslint-config/tsconfig.json

@@ -4,7 +4,7 @@
     "module": "ESNext",
     "moduleResolution": "bundler",
     "strict": true,
-    "skipLibCheck": true,
-    "declaration": true
+    "declaration": true,
+    "skipLibCheck": true
   }
 }

packages/perttier-config/index.json

@@ -10,4 +10,4 @@
   "bracketSameLine": false,
   "printWidth": 120,
   "trailingComma": "all"
-}
+}

packages/perttier-config/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pleaseai/prettier-config",
   "main": "index.json",
-  "devDependencies": {
-    "prettier": "^3.8.1"
-  },
   "peerDependencies": {
     "prettier": "^2.8.8 || ^3.0.0"
+  },
+  "devDependencies": {
+    "prettier": "^3.8.1"
   }
-}
+}