feat: Switch project tooling from npm to bun and add enhanced pre-commit
checks - Replace npm commands with bun/bunx in scripts, docs, and CI - Add enhanced pre-commit checks with parallel execution - Document pre-commit hook behavior in PRE_COMMIT_HOOKS.md - Update .gitignore/.dockerignore for bun-debug.log - Refine ESLint config for bun and Prettier integration - Add scripts/type-check-staged.sh for fast staged type checks - Improve developer workflow and code quality automation
This commit is contained in:
William Valentin
@@ -114,7 +114,7 @@ jobs:
|
||||
- name: Run security audit
|
||||
run: |
|
||||
# Install and run security audit tools
|
||||
npm audit --audit-level moderate || true
|
||||
bun audit || true
|
||||
|
||||
- name: Scan Docker image for vulnerabilities
|
||||
uses: aquasecurity/trivy-action@master
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -6,6 +6,7 @@ yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
lerna-debug.log*
|
||||
bun-debug.log*
|
||||
|
||||
node_modules
|
||||
dist
|
||||
|
||||
@@ -1,4 +1,12 @@
|
||||
# Run lint-staged for file-specific checks
|
||||
npm run pre-commit
|
||||
|
||||
echo "✅ Pre-commit checks passed!"
|
||||
|
||||
# Enhanced pre-commit checks
|
||||
# Set FAST_COMMIT=1 to skip enhanced checks and run only basic formatting
|
||||
if [ "$FAST_COMMIT" = "1" ]; then
|
||||
echo "🏃♂️ Fast commit mode - running basic checks only..."
|
||||
bun run pre-commit
|
||||
echo "✅ Basic pre-commit checks passed!"
|
||||
else
|
||||
echo "🔧 Running enhanced pre-commit checks..."
|
||||
./scripts/pre-commit-checks.sh
|
||||
fi
|
||||
|
||||
@@ -3,6 +3,7 @@ node_modules
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
bun-debug.log*
|
||||
|
||||
# Build output
|
||||
dist
|
||||
|
||||
@@ -23,7 +23,7 @@ make deploy
|
||||
|
||||
# For development
|
||||
export APP_NAME="DevMeds"
|
||||
npm run dev
|
||||
bun run dev
|
||||
|
||||
# For Docker build
|
||||
APP_NAME="CustomApp" docker build -t myapp .
|
||||
@@ -95,8 +95,8 @@ APP_NAME=StagingApp
|
||||
|
||||
### Development Mode
|
||||
|
||||
1. `npm run predev` → Processes `index.html.template` → `index.html`
|
||||
2. `npm run dev` → Starts development server
|
||||
1. `bun run predev` → Processes `index.html.template` → `index.html`
|
||||
2. `bun run dev` → Starts development server
|
||||
|
||||
### Production Build
|
||||
|
||||
|
||||
212
docs/PRE_COMMIT_HOOKS.md
Normal file
212
docs/PRE_COMMIT_HOOKS.md
Normal file
@@ -0,0 +1,212 @@
|
||||
# Pre-commit Hooks Documentation
|
||||
|
||||
This project uses enhanced pre-commit hooks to ensure code quality while maintaining fast commit speeds. The hooks run automatically before each commit and can be configured for different scenarios.
|
||||
|
||||
## Overview
|
||||
|
||||
The pre-commit hooks perform the following checks on **staged files only**:
|
||||
|
||||
- ✅ **Code Formatting** (Prettier)
|
||||
- ✅ **Code Linting** (ESLint with auto-fix)
|
||||
- ✅ **Type Checking** (TypeScript)
|
||||
- ✅ **Markdown Linting** (markdownlint-cli2)
|
||||
- ✅ **Secret Scanning** (secretlint)
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Normal Commits (Enhanced Checks)
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Your commit message"
|
||||
```
|
||||
|
||||
The enhanced pre-commit hooks will run automatically.
|
||||
|
||||
### Fast Commits (Basic Checks Only)
|
||||
|
||||
For quick commits when you're in a hurry:
|
||||
|
||||
```bash
|
||||
FAST_COMMIT=1 git commit -m "Quick fix"
|
||||
```
|
||||
|
||||
This runs only Prettier formatting, skipping other checks.
|
||||
|
||||
## What Gets Checked
|
||||
|
||||
### JavaScript/TypeScript Files (_.js, _.jsx, _.ts, _.tsx)
|
||||
|
||||
- **Prettier**: Auto-formats code style
|
||||
- **ESLint**: Lints and auto-fixes code issues
|
||||
- **TypeScript**: Type checks (TypeScript files only)
|
||||
|
||||
### Markdown Files (\*.md)
|
||||
|
||||
- **Prettier**: Formats markdown
|
||||
- **markdownlint**: Checks markdown style and fixes issues
|
||||
|
||||
### Other Files (_.json, _.yaml, _.yml, _.css, _.scss, _.html)
|
||||
|
||||
- **Prettier**: Auto-formats files
|
||||
- **secretlint**: Scans for potential secrets
|
||||
|
||||
## Performance Optimizations
|
||||
|
||||
The hooks are designed to be fast:
|
||||
|
||||
1. **Staged Files Only**: Only checks files you're actually committing
|
||||
2. **Parallel Execution**: Multiple checks run simultaneously
|
||||
3. **Smart Filtering**: Skips checks if no relevant files are staged
|
||||
4. **Incremental TypeScript**: Uses optimized TypeScript checking
|
||||
5. **Fast Mode**: Available for urgent commits
|
||||
|
||||
## Configuration Files
|
||||
|
||||
### Prettier (`.prettierrc`)
|
||||
|
||||
- Semi-colons enabled
|
||||
- Single quotes for JS/TS/JSX
|
||||
- 80 character line width
|
||||
- 2-space indentation
|
||||
- Special rules for markdown and JSON
|
||||
|
||||
### ESLint (`eslint.config.cjs`)
|
||||
|
||||
- TypeScript ESLint rules
|
||||
- React Hooks rules
|
||||
- Code quality enforcement
|
||||
- Auto-fixing enabled
|
||||
|
||||
### Secretlint (`.secretlintrc.json`)
|
||||
|
||||
- Scans for API keys, tokens, and secrets
|
||||
- Prevents accidental secret commits
|
||||
|
||||
### Markdownlint (`.markdownlint.json`)
|
||||
|
||||
- Consistent markdown formatting
|
||||
- Documentation quality checks
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Type Check Failures
|
||||
|
||||
```bash
|
||||
# See detailed type errors
|
||||
bun run type-check
|
||||
|
||||
# Fix common issues
|
||||
bun run lint:fix
|
||||
```
|
||||
|
||||
#### Formatting Issues
|
||||
|
||||
```bash
|
||||
# Auto-format all files
|
||||
bun run format
|
||||
|
||||
# Check what needs formatting
|
||||
bun run format:check
|
||||
```
|
||||
|
||||
#### Secret Detection
|
||||
|
||||
If secrets are detected:
|
||||
|
||||
1. Remove the secrets from your code
|
||||
2. Add them to environment variables or config files
|
||||
3. Update `.secretlintrc.json` if it's a false positive
|
||||
|
||||
#### Hook Not Running
|
||||
|
||||
```bash
|
||||
# Reinstall hooks
|
||||
bun run prepare
|
||||
|
||||
# Check if hooks are installed
|
||||
ls -la .husky/
|
||||
```
|
||||
|
||||
### Bypassing Hooks (Emergency Only)
|
||||
|
||||
```bash
|
||||
# Skip all pre-commit hooks (NOT RECOMMENDED)
|
||||
git commit --no-verify -m "Emergency commit"
|
||||
|
||||
# Better: Use fast mode
|
||||
FAST_COMMIT=1 git commit -m "Quick fix"
|
||||
```
|
||||
|
||||
## Manual Commands
|
||||
|
||||
Run individual checks manually:
|
||||
|
||||
```bash
|
||||
# Format code
|
||||
bun run format
|
||||
|
||||
# Lint and fix
|
||||
bun run lint:fix
|
||||
|
||||
# Type check
|
||||
bun run type-check
|
||||
|
||||
# Check markdown
|
||||
bun run lint:markdown:fix
|
||||
|
||||
# Scan for secrets
|
||||
bun run check:secrets
|
||||
|
||||
# Run all pre-commit checks manually
|
||||
bun run pre-commit:enhanced
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
### Enhanced Pre-commit Script
|
||||
|
||||
- **Location**: `scripts/pre-commit-checks.sh`
|
||||
- **Purpose**: Orchestrates all checks with parallel execution
|
||||
- **Features**: Colored output, parallel processing, detailed error reporting
|
||||
|
||||
### Fast TypeScript Checking
|
||||
|
||||
- **Location**: `scripts/type-check-staged.sh`
|
||||
- **Purpose**: Optimized TypeScript checking for staged files only
|
||||
- **Features**: Temporary tsconfig, fallback checking, fast execution
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `FAST_COMMIT=1`: Enable fast commit mode (basic checks only)
|
||||
- `NO_VERIFY=1`: Skip all hooks (use `git commit --no-verify` instead)
|
||||
|
||||
## Tips for Fast Commits
|
||||
|
||||
1. **Use Fast Mode**: `FAST_COMMIT=1` for urgent fixes
|
||||
2. **Stage Selectively**: Only stage files you want to commit
|
||||
3. **Fix Issues Early**: Run `bun run lint:fix` before committing
|
||||
4. **Keep Changes Small**: Smaller commits = faster checks
|
||||
5. **Use IDE Integration**: Configure your editor to run formatters on save
|
||||
|
||||
## Contributing
|
||||
|
||||
When modifying the pre-commit hooks:
|
||||
|
||||
1. Test with various file types
|
||||
2. Ensure parallel execution works
|
||||
3. Maintain backward compatibility
|
||||
4. Update this documentation
|
||||
5. Consider performance impact
|
||||
|
||||
## Related bun Scripts
|
||||
|
||||
- `bun run pre-commit`: Basic lint-staged checks
|
||||
- `bun run pre-commit:enhanced`: Full enhanced checks
|
||||
- `bun run lint`: ESLint check
|
||||
- `bun run lint:fix`: ESLint auto-fix
|
||||
- `bun run format`: Prettier format all
|
||||
- `bun run format:check`: Check formatting
|
||||
- `bun run type-check`: TypeScript check all files
|
||||
@@ -242,5 +242,5 @@ If you encounter TypeScript project configuration errors:
|
||||
bun run type-check
|
||||
|
||||
# Check ESLint configuration
|
||||
npx eslint --print-config index.tsx
|
||||
bunx eslint --print-config index.tsx
|
||||
```
|
||||
|
||||
@@ -26,7 +26,7 @@ module.exports = [
|
||||
'react-hooks': reactHooksPlugin,
|
||||
},
|
||||
rules: {
|
||||
// TypeScript ESLint recommended rules
|
||||
// TypeScript ESLint rules
|
||||
'@typescript-eslint/no-unused-vars': [
|
||||
'error',
|
||||
{ argsIgnorePattern: '^_' },
|
||||
@@ -34,30 +34,23 @@ module.exports = [
|
||||
'@typescript-eslint/no-explicit-any': 'warn',
|
||||
'@typescript-eslint/explicit-function-return-type': 'off',
|
||||
'@typescript-eslint/explicit-module-boundary-types': 'off',
|
||||
'@typescript-eslint/no-inferrable-types': 'error',
|
||||
'@typescript-eslint/no-empty-function': 'warn',
|
||||
'@typescript-eslint/prefer-const': 'error',
|
||||
'@typescript-eslint/no-var-requires': 'error',
|
||||
|
||||
// React Hooks rules
|
||||
'react-hooks/rules-of-hooks': 'error',
|
||||
'react-hooks/exhaustive-deps': 'error',
|
||||
'react-hooks/exhaustive-deps': 'warn',
|
||||
|
||||
// General JavaScript/TypeScript rules
|
||||
// General rules
|
||||
'no-console': ['warn', { allow: ['warn', 'error'] }],
|
||||
'no-debugger': 'error',
|
||||
'no-duplicate-imports': 'error',
|
||||
'no-unused-expressions': 'error',
|
||||
'prefer-template': 'error',
|
||||
'prefer-const': 'error',
|
||||
'no-var': 'error',
|
||||
'object-shorthand': 'error',
|
||||
'prefer-destructuring': ['error', { object: true, array: false }],
|
||||
|
||||
// Code style (handled by Prettier, but good to have)
|
||||
'comma-dangle': ['error', 'es5'],
|
||||
quotes: ['error', 'single', { avoidEscape: true }],
|
||||
semi: ['error', 'always'],
|
||||
// Code style (handled by Prettier)
|
||||
'comma-dangle': 'off',
|
||||
quotes: 'off',
|
||||
semi: 'off',
|
||||
},
|
||||
},
|
||||
{
|
||||
|
||||
@@ -29,6 +29,7 @@
|
||||
"check:editorconfig": "eclint check .",
|
||||
"fix:editorconfig": "eclint fix .",
|
||||
"pre-commit": "lint-staged",
|
||||
"pre-commit:enhanced": "./scripts/pre-commit-checks.sh",
|
||||
"prepare": "husky",
|
||||
"setup": "./scripts/setup.sh",
|
||||
"deploy": "./scripts/deploy.sh",
|
||||
|
||||
170
scripts/pre-commit-checks.sh
Executable file
170
scripts/pre-commit-checks.sh
Executable file
@@ -0,0 +1,170 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Enhanced pre-commit checks with parallel execution for speed
|
||||
# This script runs multiple checks efficiently on staged files only
|
||||
|
||||
set -e
|
||||
|
||||
echo "🚀 Running pre-commit checks..."
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Function to print colored output
|
||||
print_status() {
|
||||
echo -e "${BLUE}[PRE-COMMIT]${NC} $1"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}✅${NC} $1"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}❌${NC} $1"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}⚠️${NC} $1"
|
||||
}
|
||||
|
||||
# Check if there are any staged files
|
||||
STAGED_FILES=$(git diff --cached --name-only)
|
||||
if [ -z "$STAGED_FILES" ]; then
|
||||
print_warning "No staged files found"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
print_status "Found $(echo "$STAGED_FILES" | wc -l) staged files"
|
||||
|
||||
# Create temporary directory for parallel job management
|
||||
TEMP_DIR=$(mktemp -d)
|
||||
trap "rm -rf $TEMP_DIR" EXIT
|
||||
|
||||
# Function to run a command and capture its output
|
||||
run_check() {
|
||||
local name="$1"
|
||||
local command="$2"
|
||||
local output_file="$TEMP_DIR/$name.out"
|
||||
local error_file="$TEMP_DIR/$name.err"
|
||||
|
||||
{
|
||||
echo "Running: $command"
|
||||
eval "$command" > "$output_file" 2> "$error_file"
|
||||
echo $? > "$TEMP_DIR/$name.exit"
|
||||
} &
|
||||
|
||||
echo $! > "$TEMP_DIR/$name.pid"
|
||||
}
|
||||
|
||||
# Start parallel checks
|
||||
print_status "Starting parallel checks..."
|
||||
|
||||
# 1. Prettier formatting (fast, runs on all relevant files)
|
||||
run_check "prettier" "bun run pre-commit"
|
||||
|
||||
# 2. ESLint on staged JS/TS files only
|
||||
STAGED_JS_TS_FILES=$(echo "$STAGED_FILES" | grep -E '\.(js|jsx|ts|tsx)$' || true)
|
||||
if [ -n "$STAGED_JS_TS_FILES" ]; then
|
||||
run_check "eslint" "bunx eslint --fix --max-warnings 0 $STAGED_JS_TS_FILES"
|
||||
else
|
||||
echo "0" > "$TEMP_DIR/eslint.exit"
|
||||
echo "No JS/TS files to lint" > "$TEMP_DIR/eslint.out"
|
||||
fi
|
||||
|
||||
# 3. TypeScript type checking on staged files
|
||||
STAGED_TS_FILES=$(echo "$STAGED_FILES" | grep -E '\.(ts|tsx)$' || true)
|
||||
if [ -n "$STAGED_TS_FILES" ]; then
|
||||
run_check "typecheck" "./scripts/type-check-staged.sh"
|
||||
else
|
||||
echo "0" > "$TEMP_DIR/typecheck.exit"
|
||||
echo "No TypeScript files to check" > "$TEMP_DIR/typecheck.out"
|
||||
fi
|
||||
|
||||
# 4. Markdown linting on staged markdown files
|
||||
STAGED_MD_FILES=$(echo "$STAGED_FILES" | grep -E '\.md$' || true)
|
||||
if [ -n "$STAGED_MD_FILES" ]; then
|
||||
run_check "markdown" "bunx markdownlint-cli2 --fix $STAGED_MD_FILES || echo 'Markdown linting failed but continuing...'"
|
||||
else
|
||||
echo "0" > "$TEMP_DIR/markdown.exit"
|
||||
echo "No markdown files to lint" > "$TEMP_DIR/markdown.out"
|
||||
fi
|
||||
|
||||
# 5. Secret scanning on staged files (optional check)
|
||||
if command -v secretlint > /dev/null; then
|
||||
run_check "secrets" "bunx secretlint $STAGED_FILES || echo 'Secret scanning failed but continuing...'"
|
||||
else
|
||||
echo "0" > "$TEMP_DIR/secrets.exit"
|
||||
echo "secretlint not available, skipping secret scanning" > "$TEMP_DIR/secrets.out"
|
||||
fi
|
||||
|
||||
# Wait for all jobs to complete and collect results
|
||||
print_status "Waiting for checks to complete..."
|
||||
|
||||
FAILED_CHECKS=()
|
||||
ALL_CHECKS=("prettier" "eslint" "typecheck" "markdown" "secrets")
|
||||
|
||||
for check in "${ALL_CHECKS[@]}"; do
|
||||
if [ -f "$TEMP_DIR/$check.pid" ]; then
|
||||
wait $(cat "$TEMP_DIR/$check.pid") 2>/dev/null || true
|
||||
fi
|
||||
|
||||
exit_code=$(cat "$TEMP_DIR/$check.exit" 2>/dev/null || echo "1")
|
||||
|
||||
if [ "$exit_code" = "0" ]; then
|
||||
print_success "$check passed"
|
||||
else
|
||||
# For some checks, failure is not critical
|
||||
if [ "$check" = "secrets" ] || [ "$check" = "markdown" ]; then
|
||||
print_warning "$check had issues (non-critical)"
|
||||
if [ -f "$TEMP_DIR/$check.out" ] && [ -s "$TEMP_DIR/$check.out" ]; then
|
||||
echo -e "${YELLOW}$check output:${NC}"
|
||||
cat "$TEMP_DIR/$check.out"
|
||||
fi
|
||||
else
|
||||
print_error "$check failed"
|
||||
FAILED_CHECKS+=("$check")
|
||||
|
||||
# Show error output
|
||||
if [ -f "$TEMP_DIR/$check.err" ] && [ -s "$TEMP_DIR/$check.err" ]; then
|
||||
echo -e "${RED}$check errors:${NC}"
|
||||
cat "$TEMP_DIR/$check.err"
|
||||
fi
|
||||
if [ -f "$TEMP_DIR/$check.out" ] && [ -s "$TEMP_DIR/$check.out" ]; then
|
||||
echo -e "${YELLOW}$check output:${NC}"
|
||||
cat "$TEMP_DIR/$check.out"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
# Re-stage any files that were modified by formatters
|
||||
git add $STAGED_FILES 2>/dev/null || true
|
||||
|
||||
# Final result
|
||||
if [ ${#FAILED_CHECKS[@]} -eq 0 ]; then
|
||||
print_success "All critical pre-commit checks passed! 🎉"
|
||||
echo ""
|
||||
echo "Summary of checks:"
|
||||
echo " ✅ Code formatting (Prettier)"
|
||||
echo " ✅ Code linting (ESLint)"
|
||||
echo " ✅ Type checking (TypeScript)"
|
||||
echo " ⚠️ Markdown linting (non-critical)"
|
||||
echo " ⚠️ Secret scanning (optional)"
|
||||
echo ""
|
||||
exit 0
|
||||
else
|
||||
print_error "The following critical checks failed: ${FAILED_CHECKS[*]}"
|
||||
echo ""
|
||||
echo "💡 Tips to fix:"
|
||||
echo " - Run 'bun run lint:fix' to auto-fix linting issues"
|
||||
echo " - Run 'bun run format' to fix formatting issues"
|
||||
echo " - Run 'bun run type-check' to see detailed type errors"
|
||||
echo ""
|
||||
echo "🚨 Critical failures prevent commit. Fix these issues first."
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
@@ -20,12 +20,12 @@ fi
|
||||
|
||||
# Install browser binaries
|
||||
echo "🌐 Installing browser binaries..."
|
||||
npx playwright install
|
||||
bunx playwright install
|
||||
|
||||
# Install system dependencies (Linux)
|
||||
if [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
||||
echo "🐧 Installing system dependencies for Linux..."
|
||||
npx playwright install-deps
|
||||
bunx playwright install-deps
|
||||
fi
|
||||
|
||||
# Create .gitignore entries for Playwright
|
||||
@@ -40,7 +40,7 @@ fi
|
||||
|
||||
# Verify installation
|
||||
echo "✅ Verifying Playwright installation..."
|
||||
npx playwright --version
|
||||
bunx playwright --version
|
||||
|
||||
echo ""
|
||||
echo "🎉 Playwright setup complete!"
|
||||
|
||||
@@ -66,7 +66,7 @@ echo -e "${YELLOW}Running initial code formatting...${NC}"
|
||||
if command -v bun &> /dev/null; then
|
||||
bun run format
|
||||
elif command -v npm &> /dev/null; then
|
||||
npm run format
|
||||
bun run format
|
||||
fi
|
||||
|
||||
# Run initial linting
|
||||
@@ -74,7 +74,7 @@ echo -e "${YELLOW}Running initial linting...${NC}"
|
||||
if command -v bun &> /dev/null; then
|
||||
bun run lint:fix
|
||||
elif command -v npm &> /dev/null; then
|
||||
npm run lint:fix
|
||||
bun run lint:fix
|
||||
fi
|
||||
|
||||
# Run initial markdown linting
|
||||
@@ -82,7 +82,7 @@ echo -e "${YELLOW}Running initial markdown linting...${NC}"
|
||||
if command -v bun &> /dev/null; then
|
||||
bun run lint:markdown:fix || echo "Markdown linting completed with warnings"
|
||||
elif command -v npm &> /dev/null; then
|
||||
npm run lint:markdown:fix || echo "Markdown linting completed with warnings"
|
||||
bun run lint:markdown:fix || echo "Markdown linting completed with warnings"
|
||||
fi
|
||||
|
||||
# Fix EditorConfig issues
|
||||
@@ -90,7 +90,7 @@ echo -e "${YELLOW}Fixing EditorConfig issues...${NC}"
|
||||
if command -v bun &> /dev/null; then
|
||||
bun run fix:editorconfig || echo "EditorConfig fixes completed"
|
||||
elif command -v npm &> /dev/null; then
|
||||
npm run fix:editorconfig || echo "EditorConfig fixes completed"
|
||||
bun run fix:editorconfig || echo "EditorConfig fixes completed"
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}✅ NodeJS-native pre-commit hooks and code formatters have been set up successfully!${NC}"
|
||||
|
||||
52
scripts/type-check-staged.sh
Executable file
52
scripts/type-check-staged.sh
Executable file
@@ -0,0 +1,52 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Fast TypeScript type checking for staged files only
|
||||
# This script checks only the staged TypeScript files for type errors
|
||||
|
||||
set -e
|
||||
|
||||
# Get list of staged TypeScript files
|
||||
STAGED_TS_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\.(ts|tsx)$' || true)
|
||||
|
||||
if [ -z "$STAGED_TS_FILES" ]; then
|
||||
echo "📝 No TypeScript files staged, skipping type check"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "🔍 Type checking staged TypeScript files..."
|
||||
|
||||
# Check if we have a tsconfig.json
|
||||
if [ ! -f "tsconfig.json" ]; then
|
||||
echo "⚠️ No tsconfig.json found, skipping type check"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Try using the project's existing TypeScript setup
|
||||
# First, try a quick check with noEmit
|
||||
if bunx tsc --noEmit --skipLibCheck --incremental false > /dev/null 2>&1; then
|
||||
echo "✅ TypeScript type check passed"
|
||||
exit 0
|
||||
else
|
||||
echo "⚠️ Full type check failed, checking individual staged files..."
|
||||
|
||||
# Fallback: check each staged file individually with minimal config
|
||||
FAILED_FILES=()
|
||||
|
||||
for file in $STAGED_TS_FILES; do
|
||||
if [ -f "$file" ]; then
|
||||
# Basic syntax check without full type checking
|
||||
if ! bunx tsc --noEmit --skipLibCheck --allowJs --jsx preserve "$file" > /dev/null 2>&1; then
|
||||
FAILED_FILES+=("$file")
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
if [ ${#FAILED_FILES[@]} -eq 0 ]; then
|
||||
echo "✅ TypeScript syntax check passed for staged files"
|
||||
exit 0
|
||||
else
|
||||
echo "❌ TypeScript errors found in: ${FAILED_FILES[*]}"
|
||||
echo "💡 Run 'bun run type-check' for detailed errors"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
@@ -64,8 +64,8 @@ tests/e2e/
|
||||
|
||||
```bash
|
||||
# Install Playwright and browsers
|
||||
npm install -D @playwright/test
|
||||
npx playwright install
|
||||
bun add -D @playwright/test
|
||||
bunx playwright install
|
||||
```
|
||||
|
||||
### 2. Update Package.json
|
||||
@@ -87,40 +87,40 @@ npx playwright install
|
||||
|
||||
```bash
|
||||
# Run all E2E tests
|
||||
npm run test:e2e
|
||||
bun run test:e2e
|
||||
|
||||
# Run tests in UI mode (interactive)
|
||||
npm run test:e2e:ui
|
||||
bun run test:e2e:ui
|
||||
|
||||
# Run specific test file
|
||||
npx playwright test auth.spec.ts
|
||||
bunx playwright test auth.spec.ts
|
||||
|
||||
# Run tests in debug mode
|
||||
npm run test:e2e:debug
|
||||
bun run test:e2e:debug
|
||||
```
|
||||
|
||||
### Browser-Specific Testing
|
||||
|
||||
```bash
|
||||
# Run on specific browser
|
||||
npx playwright test --project=chromium
|
||||
npx playwright test --project=firefox
|
||||
npx playwright test --project=webkit
|
||||
bunx playwright test --project=chromium
|
||||
bunx playwright test --project=firefox
|
||||
bunx playwright test --project=webkit
|
||||
|
||||
# Run on mobile browsers
|
||||
npx playwright test --project="Mobile Chrome"
|
||||
npx playwright test --project="Mobile Safari"
|
||||
bunx playwright test --project="Mobile Chrome"
|
||||
bunx playwright test --project="Mobile Safari"
|
||||
```
|
||||
|
||||
### Test Reporting
|
||||
|
||||
```bash
|
||||
# Generate and view HTML report
|
||||
npm run test:e2e:report
|
||||
bun run test:e2e:report
|
||||
|
||||
# Run with specific reporter
|
||||
npx playwright test --reporter=line
|
||||
npx playwright test --reporter=json
|
||||
bunx playwright test --reporter=line
|
||||
bunx playwright test --reporter=json
|
||||
```
|
||||
|
||||
## Test Configuration
|
||||
@@ -196,23 +196,23 @@ test('should add medication', async ({ adminPage }) => {
|
||||
|
||||
```bash
|
||||
# Debug specific test
|
||||
npx playwright test auth.spec.ts --debug
|
||||
bunx playwright test auth.spec.ts --debug
|
||||
|
||||
# Run with headed browser
|
||||
npx playwright test --headed
|
||||
bunx playwright test --headed
|
||||
|
||||
# Slow down execution
|
||||
npx playwright test --slow-mo=1000
|
||||
bunx playwright test --slow-mo=1000
|
||||
```
|
||||
|
||||
### CI/CD Integration
|
||||
|
||||
```bash
|
||||
# Run in CI mode
|
||||
CI=true npx playwright test
|
||||
CI=true bunx playwright test
|
||||
|
||||
# Generate artifacts for CI
|
||||
npx playwright test --reporter=github
|
||||
bunx playwright test --reporter=github
|
||||
```
|
||||
|
||||
## Adding New Tests
|
||||
@@ -273,13 +273,13 @@ export class NewFeatureHelpers {
|
||||
|
||||
```bash
|
||||
# Show browser developer tools
|
||||
npx playwright test --debug
|
||||
bunx playwright test --debug
|
||||
|
||||
# Record test execution
|
||||
npx playwright codegen localhost:8080
|
||||
bunx playwright codegen localhost:8080
|
||||
|
||||
# Trace viewer
|
||||
npx playwright show-trace trace.zip
|
||||
bunx playwright show-trace trace.zip
|
||||
```
|
||||
|
||||
## Continuous Integration
|
||||
@@ -295,9 +295,9 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
- run: npm ci
|
||||
- run: npx playwright install --with-deps
|
||||
- run: npm run test:e2e
|
||||
- run: bun install
|
||||
- run: bunx playwright install --with-deps
|
||||
- run: bun run test:e2e
|
||||
- uses: actions/upload-artifact@v3
|
||||
if: always()
|
||||
with:
|
||||
|
||||
Reference in New Issue
Block a user