Merge pull request #203 from laststance/fix/template-files-path

Author: ryota-murakami

.cursor/rules/01-project-overview.mdc

@@ -0,0 +1,21 @@
+---
+description: 
+globs: 
+alwaysApply: true
+---
+# Project Overview
+
+The `prettier-husky-lint-staged-installer` is a CLI tool that automatically sets up Prettier, Husky, and lint-staged in a project to enable automatic code formatting on pre-commit.
+
+## Key Components
+
+- [bin/cli.js](mdc:bin/cli.js) - The main CLI entry point that performs the installation
+- [package.json](mdc:package.json) - Project configuration and dependencies
+
+## Main Features
+
+- Detects package manager (npm, pnpm, or bun) automatically
+- Installs Prettier, Husky, and lint-staged as dev dependencies
+- Sets up a pre-commit hook that runs Prettier on staged files
+- Configures lint-staged to run Prettier on all file types
+- Copies default Prettier configuration files to the project

.cursor/rules/02-installation-workflow.mdc

@@ -0,0 +1,17 @@
+---
+description: 
+globs: 
+alwaysApply: true
+---
+# Installation Workflow
+
+The installer follows a specific workflow to set up the formatting tools:
+
+1. **Detection** - Checks which package manager is used (npm, pnpm, or bun) by looking for lock files
+2. **Installation** - Installs husky, lint-staged, and prettier as dev dependencies
+3. **Husky Setup** - Initializes husky
+4. **Configuration** - Sets up lint-staged in package.json
+5. **File Setup** - Copies .prettierrc and .prettierignore files
+6. **Hook Setup** - Configures the pre-commit hook to run lint-staged
+
+This process is handled in [bin/cli.js](mdc:bin/cli.js) with detailed steps for each package manager.

.cursor/rules/03-dependencies.mdc

@@ -0,0 +1,21 @@
+---
+description: 
+globs: 
+alwaysApply: true
+---
+# Project Dependencies
+
+## Runtime Dependencies
+
+- **@clack/prompts** - Terminal UI library for user interactions
+- **execa** - Process execution library for running commands
+
+## DevDependencies
+
+- **eslint** with various plugins - For code linting
+- **prettier** - Code formatting
+- **husky** - Git hooks management
+- **lint-staged** - Run linters on staged files
+- **typescript** - Type checking
+
+The [package.json](mdc:package.json) file contains the complete list of dependencies.

.cursor/rules/04-package-managers.mdc

@@ -0,0 +1,42 @@
+---
+description: 
+globs: 
+alwaysApply: true
+---
+# Package Manager Handling
+
+The installer supports three package managers automatically:
+
+## Detection Logic
+
+The CLI detects which package manager is being used by checking for lock files:
+- `package-lock.json` → npm
+- `pnpm-lock.yaml` → pnpm 
+- `bun.lockb` → bun
+
+## Manager-Specific Commands
+
+Each package manager requires different commands:
+
+### npm
+```javascript
+precommitFileBody = 'npx lint-staged'
+await $`npm install --save-dev husky lint-staged prettier`
+await $`npx husky init`
+```
+
+### pnpm
+```javascript
+precommitFileBody = 'pnpm lint-staged'
+await $`pnpm install --save-dev husky lint-staged prettier`
+await $`pnpm exec husky init`
+```
+
+### bun
+```javascript
+precommitFileBody = 'bunx lint-staged'
+await $`bun install -D husky lint-staged prettier`
+await $`bunx husky init`
+```
+
+This detection and execution logic is implemented in [bin/cli.js](mdc:bin/cli.js).

.cursor/rules/05-coding-standards.mdc

@@ -0,0 +1,37 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Coding Standards
+
+This project follows specific coding standards enforced by its own tools:
+
+## Prettier Configuration
+
+The project uses a standard Prettier configuration defined in [.prettierrc](mdc:.prettierrc):
+
+```json
+{
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all"
+}
+```
+
+## ESLint Configuration
+
+The project uses ESLint with TypeScript support as defined in [.eslintrc.cjs](mdc:.eslintrc.cjs).
+
+## Git Hooks
+
+The project uses Husky to manage Git hooks:
+- Pre-commit hook runs Prettier on staged files via lint-staged
+
+## Scripts
+
+Common development scripts are available in [package.json](mdc:package.json):
+- `npm run prettier` - Run Prettier on all files
+- `npm run lint` - Run ESLint
+- `npm run lint:fix` - Run ESLint with auto-fix

.cursor/rules/06-contribution-guidelines.mdc

@@ -0,0 +1,29 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Contribution Guidelines
+
+This project welcomes contributions from the community. The contribution process is documented in:
+
+- [CONTRIBUTING.md](mdc:CONTRIBUTING.md) - General contribution guidelines
+- [CODE_OF_CONDUCT.md](mdc:CODE_OF_CONDUCT.md) - Community code of conduct
+
+## Development Workflow
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Ensure the code passes linting and formatting rules
+5. Create a pull request
+
+## Release Process
+
+The project uses [release-it](mdc:https:/github.com/release-it/release-it) for managing releases, configured in [.release-it.json](mdc:.release-it.json).
+
+Run `npm run release` to create a new release, which will:
+1. Bump the version
+2. Create a git tag
+3. Push to GitHub
+4. Publish to npm

.cursor/rules/07-usage-examples.mdc

@@ -0,0 +1,51 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Usage Examples
+
+The `prettier-husky-lint-staged-installer` can be run using different package managers.
+
+## Running with npx (npm)
+
+```bash
+npx prettier-husky-lint-staged-installer
+```
+
+## Running with pnpm
+
+```bash
+pnpm dlx prettier-husky-lint-staged-installer
+```
+
+## Running with bun
+
+```bash
+bunx prettier-husky-lint-staged-installer
+```
+
+## What Gets Installed
+
+After running the installer, your project will have:
+
+1. Husky, lint-staged, and Prettier installed as dev dependencies
+2. A pre-commit hook that runs Prettier on staged files
+3. A `.prettierrc` config file with sensible defaults
+4. A `.prettierignore` file
+5. Package.json scripts for running Prettier manually
+
+## Resulting Configuration
+
+The installer adds this to your package.json:
+
+```json
+"lint-staged": {
+  "*": "prettier --ignore-unknown --write"
+},
+"scripts": {
+  "prettier": "prettier --ignore-unknown --write ."
+}
+```
+
+And creates a pre-commit hook to run lint-staged.

.github/actions/prepare/action.yml

@@ -4,10 +4,10 @@ name: Prepare
 
 runs:
   steps:
-    - uses: pnpm/action-setup@v2
+    - uses: pnpm/action-setup@v4
       with:
-        version: 9
-    - uses: actions/setup-node@v3
+        version: 10
+    - uses: actions/setup-node@v4
       with:
         cache: pnpm
         node-version: '20'

.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/prepare
+      - name: Run tests
+        run: pnpm test

.prettierrc

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json.schemastore.org/prettierrc",
+  "$schema": "https://json.schemastore.org/prettierrc",
   "singleQuote": true,
   "semi": false
 }