@iamandersonp/prettier-staged 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.4.0](https://github.com/iamandersonp/prettier-staged.git/compare/v0.3.1...v0.4.0) (2026-04-07)
+
+### Features
+
+- :sparkles: copy .env.example file ([645d873](https://github.com/iamandersonp/prettier-staged.git/commits/645d873068b79627a132fb9faf6da0f6c8a8ac7e))
+
 ### [0.3.1](https://github.com/iamandersonp/prettier-staged.git/compare/v0.3.0...v0.3.1) (2026-04-07)
 
 ### Bug Fixes

package/README.md

@@ -84,7 +84,10 @@ If no `.env` file exists, the default values will be used:
 
 #### Setting up your .env file
 
-1. Copy the example configuration:
+**The easy way** (recommended):
+When you install prettier-staged, a `.env.example` file is automatically copied to your project root!
+
+1. Copy the example to create your configuration:
 
    ```bash
    cp .env.example .env
@@ -105,13 +108,23 @@ If no `.env` file exists, the default values will be used:
    EXTENSIONS=vue,svelte,astro          # Framework-specific
    ```
 
+**Manual setup** (if needed):
+If the `.env.example` file wasn't created automatically, you can create your own `.env` file with the configuration above.
+
 ### What gets installed
 
-- A `{HOOKS_DIR}/pre-commit` file that:
+When installed as a dependency, prettier-staged automatically copies:
+
+- **Pre-commit hook**: A `{HOOKS_DIR}/pre-commit` file that:
   - Skips formatting during merge conflicts
   - Formats staged files with Prettier
   - Re-stages formatted files automatically
 
+- **Configuration template**: A `.env.example` file in your project root with:
+  - Default `HOOKS_DIR` and `EXTENSIONS` settings
+  - Example configurations for different project types
+  - Ready-to-use template for customization
+
 ### How to use the copied hook
 
 After installation, run this command in your project root to use the copied hook:
@@ -130,8 +143,9 @@ git config core.hooksPath your-custom-directory
 
 ### Hook behavior
 
-- ✅ **Safe**: Only copies if `{HOOKS_DIR}/pre-commit` doesn't exist (won't overwrite)
+- ✅ **Safe**: Only copies files if they don't exist (won't overwrite)
 - ✅ **Smart**: Only installs when added as a dependency, not during development
+- ✅ **Complete**: Copies both pre-commit hook AND configuration template
 - ✅ **Executable**: Automatically sets proper permissions (`chmod +x`)
 - ✅ **Configurable**: Hooks directory can be customized via `.env` file
 - ✅ **Auto-configured**: Git hooks path is set automatically during installation
@@ -213,14 +227,14 @@ fi
 
 2. **Optional: Configure your preferences**:
 
-   ```bash
-   # Create .env file with custom configuration
-   echo "HOOKS_DIR=.git-hooks" > .env
-   echo "EXTENSIONS=html,ts,scss,css,json,js" >> .env
+   A `.env.example` file is automatically copied to your project! Just:
 
-   # Or copy and edit the example
+   ```bash
+   # Copy the example configuration
    cp .env.example .env
-   # Edit .env to customize HOOKS_DIR and EXTENSIONS
+
+   # Edit .env to customize HOOKS_DIR and EXTENSIONS (optional)
+   # Defaults work great for most projects!
    ```
 
 3. **The hook is automatically set up!** No additional configuration needed.
@@ -230,6 +244,7 @@ fi
    ```bash
    git config core.hooksPath  # Should show your hooks directory
    ls -la .git-hooks/         # Should show the pre-commit hook
+   cat .env.example           # See available configuration options
    ```
 
 ## Testing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iamandersonp/prettier-staged",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "main": "src/index.js",
   "bin": {
     "prettier-staged": "src/index.js"

package/src/install-hooks.js

@@ -107,6 +107,40 @@ function copyPreCommitHook() {
   }
 }
 
+/**
+ * Copies the .env.example file to the target project's root directory
+ * if it doesn't already exist
+ */
+function copyEnvExample() {
+  try {
+    const targetProjectDir = getTargetProjectDir();
+    const targetEnvExamplePath = path.join(targetProjectDir, '.env.example');
+
+    // Check if .env.example already exists
+    if (fs.existsSync(targetEnvExamplePath)) {
+      console.log('✅ .env.example already exists, skipping copy');
+      return;
+    }
+
+    // Get source .env.example path
+    const sourceEnvExamplePath = path.join(__dirname, '..', '.env.example');
+
+    if (!fs.existsSync(sourceEnvExamplePath)) {
+      console.warn('⚠️ Source .env.example not found, skipping copy');
+      return;
+    }
+
+    // Copy the file
+    fs.copyFileSync(sourceEnvExamplePath, targetEnvExamplePath);
+
+    console.log('✅ Copied .env.example to project root');
+    console.log('💡 Configure your environment by copying .env.example to .env');
+  } catch (error) {
+    // Don't fail installation if .env.example copy fails
+    console.warn('⚠️ Failed to copy .env.example:', error.message);
+  }
+}
+
 /**
  * Sets up git hooks in the library's own .git-hooks directory
  * (existing functionality)
@@ -139,10 +173,11 @@ function installHooks() {
 
   // Only copy to target project if this is an external installation
   if (isExternalInstallation()) {
-    console.log('📦 Installing as dependency, copying pre-commit hook...');
+    console.log('📦 Installing as dependency, copying files...');
     copyPreCommitHook();
+    copyEnvExample();
   } else {
-    console.log('🏠 Running in development mode, skipping hook copy');
+    console.log('🏠 Running in development mode, skipping file copies');
   }
 
   console.log('✨ Setup complete!');
@@ -153,6 +188,7 @@ module.exports = {
   isExternalInstallation,
   getTargetProjectDir,
   copyPreCommitHook,
+  copyEnvExample,
   setupLibraryGitHooks,
   installHooks,
   getHooksDirFromEnv,

package/tests/install-hooks.test.js

@@ -10,6 +10,7 @@ const {
   isExternalInstallation,
   getTargetProjectDir,
   copyPreCommitHook,
+  copyEnvExample,
   setupLibraryGitHooks,
   installHooks,
   getHooksDirFromEnv,
@@ -230,6 +231,69 @@ describe('install-hooks', () => {
     });
   });
 
+  describe('copyEnvExample', () => {
+    const targetDir = '/target/project';
+    const targetEnvExample = path.join(targetDir, '.env.example');
+
+    beforeEach(() => {
+      process.env.INIT_CWD = targetDir;
+    });
+
+    it('should skip copy if .env.example already exists', () => {
+      fs.existsSync.mockReturnValue(true);
+
+      copyEnvExample();
+
+      expect(fs.copyFileSync).not.toHaveBeenCalled();
+      expect(consoleSpy).toHaveBeenCalledWith('✅ .env.example already exists, skipping copy');
+    });
+
+    it('should warn if source .env.example does not exist', () => {
+      fs.existsSync.mockImplementation((filePath) => {
+        if (filePath === targetEnvExample) return false;
+        if (filePath.includes('.env.example')) return false;
+        return true;
+      });
+
+      copyEnvExample();
+
+      expect(fs.copyFileSync).not.toHaveBeenCalled();
+      expect(warnSpy).toHaveBeenCalledWith('⚠️ Source .env.example not found, skipping copy');
+    });
+
+    it('should copy .env.example when conditions are met', () => {
+      // Mock file existence checks
+      fs.existsSync.mockImplementation((filePath) => {
+        if (filePath === targetEnvExample) return false; // Target doesn't exist
+        if (filePath.includes('.env.example')) return true; // Source exists
+        return false;
+      });
+
+      copyEnvExample();
+
+      expect(fs.copyFileSync).toHaveBeenCalled();
+      expect(consoleSpy).toHaveBeenCalledWith('✅ Copied .env.example to project root');
+      expect(consoleSpy).toHaveBeenCalledWith(
+        '💡 Configure your environment by copying .env.example to .env'
+      );
+    });
+
+    it('should handle copy errors gracefully', () => {
+      fs.existsSync.mockImplementation((filePath) => {
+        if (filePath === targetEnvExample) return false;
+        if (filePath.includes('.env.example')) return true;
+        return false;
+      });
+      fs.copyFileSync.mockImplementation(() => {
+        throw new Error('Permission denied');
+      });
+
+      copyEnvExample();
+
+      expect(warnSpy).toHaveBeenCalledWith('⚠️ Failed to copy .env.example:', 'Permission denied');
+    });
+  });
+
   describe('setupLibraryGitHooks', () => {
     it('should configure git hooks successfully', () => {
       execSync.mockImplementation(() => {});
@@ -270,7 +334,9 @@ describe('install-hooks', () => {
       installHooks();
 
       expect(consoleSpy).toHaveBeenCalledWith('🔧 Setting up prettier-staged hooks...');
-      expect(consoleSpy).toHaveBeenCalledWith('🏠 Running in development mode, skipping hook copy');
+      expect(consoleSpy).toHaveBeenCalledWith(
+        '🏠 Running in development mode, skipping file copies'
+      );
       expect(consoleSpy).toHaveBeenCalledWith('✨ Setup complete!');
     });
 
@@ -280,15 +346,15 @@ describe('install-hooks', () => {
       // Mock successful operations
       execSync.mockImplementation(() => {});
       fs.existsSync.mockImplementation((filePath) => {
-        return !!filePath.includes('.git-hooks/pre-commit-sample'); // Target doesn't exist
+        if (filePath.includes('.git-hooks/pre-commit-sample')) return true; // Source hook exists
+        if (filePath.includes('.env.example')) return true; // Source .env.example exists
+        return false; // Targets don't exist
       });
 
       installHooks();
 
       expect(consoleSpy).toHaveBeenCalledWith('🔧 Setting up prettier-staged hooks...');
-      expect(consoleSpy).toHaveBeenCalledWith(
-        '📦 Installing as dependency, copying pre-commit hook...'
-      );
+      expect(consoleSpy).toHaveBeenCalledWith('📦 Installing as dependency, copying files...');
       expect(consoleSpy).toHaveBeenCalledWith('✨ Setup complete!');
     });
   });