shakapacker 9.0.0.beta.6 → 9.0.0.beta.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65a49f86249eeb2035e56d7f21da2d8e4edbe5a26da50b0a63a9534a720a84cf
-  data.tar.gz: 153cb1df867355c881a3a7fe31b3aed526355ff30f7eaaacb497d231cb5f3bcc
+  metadata.gz: 6b968c57e16cafe6ddb6fb317b442db6b96682ee075498f3b8bc60f43f87d7bd
+  data.tar.gz: a3bf4f39a4c6b869e3301723423387577a78a0818403c1bb31efd42f9bc0ac7c
 SHA512:
-  metadata.gz: c237ee4221a14f19ae86067632ad00baaf1f05d3464c21804b8aa3fa7029429bc8d678d630f1762f940ea780f4ff81023c26d26342aa27380a461f1485f50b3d
-  data.tar.gz: b37633ed02a416c423bfb410b189b1ca7c508a162339e9def8401622c2ac198b4649ad0392795a9eb3301d6fc3d9858c2e39f1130b8c6bbd219887566126b91e
+  metadata.gz: ebfa33ceea921c0c66f9a9affb4eb1c736c981696d87523e4a55f82311e6779a28b3b9ca0b8b8a270fb00dbd04302be57928091f4b7c7b580ee66d2585c98f4f
+  data.tar.gz: 61a683b023eec46e7beb3a294db371b28ac1d8668744d7212ab938eb5a0a1fe53dba7763f5f9e90374ed329cb2f6ae07a232f3b0970e3bb4d504f4b79ea9eaeb

data/.eslintrc.fast.js

@@ -0,0 +1,40 @@
+// Fast ESLint config for quick development feedback
+// Skips type-aware rules that require TypeScript compilation
+
+const baseConfig = require("./.eslintrc.js")
+
+module.exports = {
+  ...baseConfig,
+  overrides: [
+    ...baseConfig.overrides.filter((o) => !o.files.includes("**/*.{ts,tsx}")),
+    {
+      files: ["**/*.{ts,tsx}"],
+      parser: "@typescript-eslint/parser",
+      parserOptions: {
+        // No project specified - disables type-aware linting
+        ecmaVersion: 2020,
+        sourceType: "module"
+      },
+      extends: [
+        "plugin:@typescript-eslint/recommended",
+        // Skip the "recommended-requiring-type-checking" preset
+        "plugin:prettier/recommended"
+      ],
+      plugins: ["@typescript-eslint"],
+      rules: {
+        // Same rules as main config minus type-aware ones
+        "import/no-unresolved": "off",
+        "import/no-extraneous-dependencies": "off",
+        "import/extensions": "off",
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-use-before-define": ["error"],
+        "@typescript-eslint/no-unused-vars": [
+          "error",
+          { argsIgnorePattern: "^_" }
+        ],
+        "@typescript-eslint/no-explicit-any": "error",
+        "@typescript-eslint/explicit-module-boundary-types": "off"
+      }
+    }
+  ]
+}

data/.eslintrc.js

@@ -1,11 +1,22 @@
 module.exports = {
+  root: true, // Prevent ESLint from looking in parent directories
   extends: ["airbnb", "plugin:prettier/recommended"],
   rules: {
+    // Webpack handles module resolution, not ESLint
     "import/no-unresolved": "off",
+    // Allow importing devDependencies in config/test files
     "import/no-extraneous-dependencies": "off",
+    // TypeScript handles extensions, not needed for JS imports
     "import/extensions": "off",
     indent: ["error", 2]
   },
+  settings: {
+    react: {
+      // Suppress "react package not installed" warning
+      // This project doesn't use React but airbnb config requires react-plugin
+      version: "999.999.999"
+    }
+  },
   env: {
     browser: true,
     node: true
@@ -31,6 +42,43 @@ module.exports = {
         "jest/prefer-strict-equal": "error",
         "jest/prefer-todo": "error"
       }
+    },
+    {
+      files: ["**/*.{ts,tsx}"],
+      parser: "@typescript-eslint/parser",
+      parserOptions: {
+        // Enables type-aware linting for better type safety
+        // Note: This can slow down linting on large codebases
+        // Consider using --cache flag with ESLint if performance degrades
+        project: "./tsconfig.eslint.json",
+        tsconfigRootDir: __dirname
+      },
+      extends: [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:prettier/recommended"
+      ],
+      plugins: ["@typescript-eslint"],
+      rules: {
+        // TypeScript compiler handles module resolution
+        "import/no-unresolved": "off",
+        // Allow importing devDependencies in TypeScript files
+        "import/no-extraneous-dependencies": "off",
+        // TypeScript handles file extensions via moduleResolution
+        "import/extensions": "off",
+        // Disable base rule in favor of TypeScript version
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-use-before-define": ["error"],
+        // Allow unused vars if they start with underscore (convention for ignored params)
+        "@typescript-eslint/no-unused-vars": [
+          "error",
+          { argsIgnorePattern: "^_" }
+        ],
+        // Strict: no 'any' types allowed - use 'unknown' or specific types instead
+        "@typescript-eslint/no-explicit-any": "error",
+        // Allow implicit return types - TypeScript can infer them
+        "@typescript-eslint/explicit-module-boundary-types": "off"
+      }
     }
   ]
 }

data/.github/workflows/generator.yml

@@ -64,4 +64,10 @@ jobs:
       - name: Build TypeScript
         run: yarn build
 
+      - name: Pack npm package for testing
+        run: |
+          TARBALL=$(npm pack)
+          echo "SHAKAPACKER_NPM_PACKAGE=$(pwd)/$TARBALL" >> $GITHUB_ENV
+          echo "Created package: $TARBALL"
+
       - run: bundle exec rake run_spec:generator

data/.gitignore

@@ -11,6 +11,7 @@ yarn-error.log*
 /log
 gemfiles/*.lock
 .DS_Store
+.eslintcache
 
 .yalc
 yalc.lock
@@ -25,12 +26,8 @@ package/**/*.js
 !package/index.d.ts
 !package/loaders.d.ts
 !package/webpack-types.d.ts
-!package/babel/preset.js
 !package/babel/preset-react.js
-!package/environments/*.js
-!package/rules/*.js
 !package/loaders/*.js
-!package/plugins/*.js
 !package/__mocks__/*.js
 !package/utils/get_style_rule.js
 !package/utils/node_modules.js

data/.npmignore

@@ -0,0 +1,56 @@
+# .npmignore
+# This file controls what gets published to npm
+# It overrides .gitignore for npm publishing
+
+# Exclude development and test files
+/.bundle
+/pkg
+/spec
+/test
+/gemfiles
+/.github
+/.circleci
+/.husky
+/.byebug_history
+.DS_Store
+yarn-debug.log*
+yarn-error.log*
+.yarn-integrity
+.yalc
+yalc.lock
+.yalcignore
+
+# Exclude Ruby files not needed for npm package
+Gemfile
+Gemfile.lock
+Rakefile
+*.gemspec
+.rubocop.yml
+.ruby-version
+
+# Exclude TypeScript config
+tsconfig.json
+
+# Exclude source maps (optional - remove these lines to include source maps)
+*.js.map
+*.d.ts.map
+
+# Exclude git and editor files
+.git
+.gitignore
+.gitattributes
+.editorconfig
+.vscode
+.idea
+
+# Exclude CI/CD files
+.travis.yml
+appveyor.yml
+
+# Exclude documentation source files (keep compiled docs if any)
+docs/
+
+# CRITICAL: Exclude TypeScript source files (must be at the end)
+# Only include compiled .js and .d.ts files
+*.ts
+!*.d.ts

data/CHANGELOG.md

@@ -9,7 +9,70 @@
 ## [Unreleased]
 Changes since the last non-beta release.
 
-## [v9.0.0-beta.4] - Unreleased
+### Added
+- **Phase 5 TypeScript Migration - Framework-Specific Modules** by [justin808](https://github.com/justin808)
+  - Converted framework-specific modules to TypeScript
+  - Migrated package/rspack/index.js to TypeScript
+  - Migrated package/swc/index.js to TypeScript
+  - Migrated package/esbuild/index.js to TypeScript
+  - Migrated package/babel/preset.js to TypeScript
+  - Added @types/babel__core for enhanced type safety
+  - All 130 tests passing
+- **Phase 6 TypeScript Migration - Final Cleanup** (by [justin808](https://github.com/justin808))
+  - Added TypeScript ESLint support with @typescript-eslint/parser and @typescript-eslint/eslint-plugin
+  - Configured TypeScript-specific linting rules for improved code quality
+  - Verified strict mode is enabled in TypeScript configuration
+  - Enhanced developer experience with TypeScript linting across the entire codebase
+
+## [v9.0.0-beta.7] - October 1, 2025
+
+### Added
+- **Phase 2 TypeScript Migration - Core Modules** ([PR 608](https://github.com/shakacode/shakapacker/pull/608) by [justin808](https://github.com/justin808))
+  - Converted core modules to TypeScript: config.ts, env.ts, and utilities
+  - Enhanced type safety across the codebase
+  - Better IDE support and autocomplete
+- **Phase 3 TypeScript Migration - Environment Files** ([PR 614](https://github.com/shakacode/shakapacker/pull/614) by [justin808](https://github.com/justin808))
+  - Converted all environment configuration files to TypeScript (development, production, test)
+  - Added centralized type exports for consumer use (import from "shakapacker/types")
+  - Created shared TypeScript interfaces for environment configurations
+  - Introduced structured error codes for programmatic error handling
+  - Exported shared types: WebpackConfig, RspackConfig, EnvironmentConfig
+- **Optional Peer Dependencies** ([PR 615](https://github.com/shakacode/shakapacker/pull/615) by [justin808](https://github.com/justin808))
+  - Restored peer dependencies as optional to improve package version tracking
+  - Added peerDependenciesMeta marking all peers as optional
+  - Moved webpack-merge to direct dependencies (required at runtime)
+  - Prevents installation warnings while maintaining upgrade visibility
+- **Migration Tooling Improvements** ([PR 613](https://github.com/shakacode/shakapacker/pull/613) by [justin808](https://github.com/justin808))
+  - Added SWC migration helper: rake shakapacker:migrate:to_swc
+  - Enhanced error messages for missing dependencies
+  - Improved doctor command output
+
+### Security
+- **Path Validation Utilities** ([PR 614](https://github.com/shakacode/shakapacker/pull/614) by [justin808](https://github.com/justin808))
+  - Added validation to prevent directory traversal attacks
+  - Implemented environment variable sanitization to prevent injection
+  - Enforced strict port validation (reject strings with non-digits)
+  - Added SHAKAPACKER_NPM_PACKAGE path validation (only .tgz/.tar.gz allowed)
+  - Path traversal security checks now run regardless of validation mode
+
+### Changed
+- **Build Process Improvements** ([PR 614](https://github.com/shakacode/shakapacker/pull/614) by [justin808](https://github.com/justin808))
+  - Environment JS files now generated during npm publish (not committed to git)
+  - Prevents TypeScript source and compiled JS from getting out of sync
+  - Auto-format compiled JavaScript during build process
+  - Enhanced .npmignore to exclude TypeScript sources, include compiled JS
+
+### Performance
+- **Validation Caching** ([PR 614](https://github.com/shakacode/shakapacker/pull/614) by [justin808](https://github.com/justin808))
+  - Implemented TTL-based validation caching (5s watch, 1min dev, infinite prod)
+  - Made cache TTL configurable via SHAKAPACKER_CACHE_TTL environment variable
+  - Lazy-loaded and cached watch mode detection
+
+### Fixed
+- Fixed clearValidationCache() to actually clear the cache ([PR 614](https://github.com/shakacode/shakapacker/pull/614) by [justin808](https://github.com/justin808))
+- Fixed private_output_path configuration edge cases ([PR 604](https://github.com/shakacode/shakapacker/pull/604) by [justin808](https://github.com/justin808))
+
+## [v9.0.0-beta.4] - September 15, 2025
 
 ### ⚠️ Breaking Changes
 

data/CONTRIBUTING.md

@@ -3,6 +3,7 @@
 Thank you for your interest in contributing to Shakapacker! We welcome all contributions that align with our project goals and values. To ensure a smooth and productive collaboration, please follow these guidelines.
 
 ## Contents
+
 - [Reporting Issues](#reporting-issues)
 - [Submitting Pull Requests](#submitting-pull-requests)
 - [Setting Up a Development Environment](#setting-up-a-development-environment)
@@ -10,44 +11,89 @@ Thank you for your interest in contributing to Shakapacker! We welcome all contr
 - [Testing the generator](#testing-the-generator)
 
 ## Reporting Issues
+
 If you encounter any issues with the project, please first check the existing issues (including closed ones). If the issues is not reported before, please opening an issue on our GitHub repository. Please provide a clear and detailed description of the issue, including steps to reproduce it. Creating a demo repository to demonstrate the issue would be ideal (and in some cases necessary).
 
 If looking to contribute to the project by fixing existing issues, we recommend looking at issues, particularly with the "[help wanted](https://github.com/shakacode/shakapacker/issues?q=is%3Aissue+label%3A%22help+wanted%22)" label.
 
 ## Submitting Pull Requests
+
 We welcome pull requests that fix bugs, add new features, or improve existing ones. Before submitting a pull request, please make sure to:
 
-  - Open an issue about what you want to propose before start working on.
-  - Fork the repository and create a new branch for your changes.
-  - Write clear and concise commit messages.
-  - Follow our code style guidelines.
-  - Write tests for your changes and [make sure all tests pass](#making-sure-your-changes-pass-all-tests).
-  - Update the documentation as needed.
-  - Update CHANGELOG.md if the changes affect public behavior of the project.
+- Open an issue about what you want to propose before start working on.
+- Fork the repository and create a new branch for your changes.
+- Write clear and concise commit messages.
+- Follow our code style guidelines.
+- Write tests for your changes and [make sure all tests pass](#making-sure-your-changes-pass-all-tests).
+- Update the documentation as needed.
+- Update CHANGELOG.md if the changes affect public behavior of the project.
 
 ---
+
+## Git Hooks (Optional)
+
+This project includes configuration for git hooks via `husky` and `lint-staged`, but they are **opt-in for contributors**.
+
+**Why are hooks optional?** As a library project, we don't enforce git hooks because:
+
+- Different contributors may have different workflows
+- Forcing hooks can interfere with contributor tooling
+- CI/CD handles the final validation
+
+To enable pre-commit hooks locally:
+
+```bash
+npx husky install
+npx husky add .husky/pre-commit "npx lint-staged"
+```
+
+---
+
+## Linting and Code Quality
+
+### Running Linters
+
+```bash
+# Full linting with type checking (slower but thorough)
+yarn lint
+
+# Fast linting without type checking (for quick feedback)
+yarn lint:fast
+
+# With caching for better performance
+yarn lint --cache
+```
+
+**Performance Note:** TypeScript ESLint uses type-aware linting for better type safety, which can be slower on large codebases. Use `yarn lint:fast` during development for quick feedback.
+
+---
+
 ## Setting Up a Development Environment
 
 1. Install [Yarn](https://classic.yarnpkg.com/)
 2. To test your changes on a Rails test project do the following steps:
+
    - For Ruby gem, update `Gemfile` and point the `shakapacker` to the locally developing Shakapacker project:
-      ```ruby
-      gem 'shakapacker', path: "relative_or_absolute_path_to_local_shakapacker"
-      ```
+     ```ruby
+     gem 'shakapacker', path: "relative_or_absolute_path_to_local_shakapacker"
+     ```
    - For npm package, use `yalc` with following steps:
-      ```bash
-      # In Shakapacker root directory
-      yalc publish
-      # In Rails app for testing
-      yalc link shakapacker
-
-      # After every change in shakapacker, run the following in Shakapacker directory
-      yalc push # or yalc publish --push
-      ```
+
+     ```bash
+     # In Shakapacker root directory
+     yalc publish
+     # In Rails app for testing
+     yalc link shakapacker
+
+     # After every change in shakapacker, run the following in Shakapacker directory
+     yalc push # or yalc publish --push
+     ```
+
 3. Run the following commands to set up the development environment.
    ```
    bundle install
    yarn install
+   yarn prepare:husky  # Set up pre-commit hooks for linting
    ```
 
 ## Understanding Optional Peer Dependencies
@@ -59,11 +105,13 @@ Shakapacker uses optional peer dependencies (via `peerDependenciesMeta`) for max
 - **Version constraints still apply** - When a package is installed, version compatibility is enforced
 
 ### When modifying dependencies:
+
 1. Add new peer dependencies to both `peerDependencies` and `peerDependenciesMeta` (marking as optional)
 2. Keep version ranges synchronized between `devDependencies` and `peerDependencies`
 3. Test with multiple package managers: `npm`, `yarn`, and `pnpm`
 
 ### Testing peer dependency changes:
+
 ```bash
 # Test with npm (no warnings expected)
 cd /tmp && mkdir test-npm && cd test-npm
@@ -129,6 +177,7 @@ bundle exec rake run_spec:gem
 ```
 
 #### 4.4 Run only Shakapacker gem specs for backward compatibility
+
 These specs are to check Shakapacker v7 backward compatibility with v6.x
 
 ```
@@ -136,6 +185,7 @@ bundle exec rake run_spec:gem_bc
 ```
 
 #### 4.5 Run dummy app test
+
 For this, you need `yalc` to be installed on your local machine
 
 ```
@@ -143,6 +193,7 @@ bundle exec rake run_spec:dummy
 ```
 
 #### 4.6 Testing the installer
+
 To ensure that your installer works as expected, either you can run `bundle exec rake run_spec:install`, or take the following manual testing steps:
 
 1. Update the `Gemfile` so that gem `shakapacker` has a line like this, pointing to your developing Shakapacker:
@@ -152,7 +203,7 @@ To ensure that your installer works as expected, either you can run `bundle exec
 2. Run `bundle install` to install the updated gem.
 3. Run `bundle exec rails shakapacker:install` to confirm that you got the right changes.
 
- **Note:** Ensure that you use bundle exec otherwise the installed shakapacker gem will run and not the one you are working on.
+**Note:** Ensure that you use bundle exec otherwise the installed shakapacker gem will run and not the one you are working on.
 
 ## CI Workflows
 
@@ -161,6 +212,7 @@ Shakapacker uses GitHub Actions for continuous integration. The CI workflows use
 ### Package Manager Choice
 
 The project uses Yarn in CI workflows for the following reasons:
+
 - Deterministic dependency resolution with `yarn.lock`
 - Faster installation with offline mirror support
 - Better workspace support for monorepo-style testing
@@ -174,14 +226,16 @@ The project uses Yarn in CI workflows for the following reasons:
 - `.github/workflows/generator.yml` - Generator installation tests
 
 All workflows use:
+
 ```yaml
 - uses: actions/setup-node@v4
   with:
-    cache: 'yarn'
+    cache: "yarn"
     cache-dependency-path: spec/dummy/yarn.lock
 ```
 
 And install dependencies with:
+
 ```bash
 yarn install
 ```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (9.0.0.beta.6)
+    shakapacker (9.0.0.beta.8)
       activesupport (>= 5.2)
       package_json
       rack-proxy (>= 0.6.1)

data/README.md

@@ -722,6 +722,10 @@ You can try out experimental integration with the esbuild-loader. You can read m
 
 Please note that if you want opt-in to use esbuild-loader, you can skip [React](#react) integration instructions as it is supported out of the box.
 
+### Switching between transpilers
+
+To switch between Babel, SWC, or esbuild, or to configure environment-specific transpiler settings, see the [Transpiler Migration Guide](./docs/transpiler-migration.md).
+
 ### Integrations
 
 Shakapacker out of the box supports JS and static assets (fonts, images etc.) compilation. To enable support for CoffeeScript or TypeScript install relevant packages:

data/TODO.md

@@ -22,22 +22,21 @@
 - [ ] Convert dev_server.js
 - [ ] Convert webpackDevServerConfig.js
 
-### Phase 4: Rules & Loaders
-- [ ] Convert all files in `package/rules/`
-- [ ] Convert all files in `package/plugins/`
-- [ ] Convert all files in `package/optimization/`
-
-### Phase 5: Framework-Specific Modules
-- [ ] Convert rspack support files
-- [ ] Convert swc support files
-- [ ] Convert esbuild support files
-- [ ] Convert babel preset
-
-### Phase 6: Final Cleanup
-- [ ] Convert remaining utilities
-- [ ] Add TypeScript linting
-- [ ] Enable strict mode
-- [ ] Update documentation
+### Phase 4: Rules & Loaders (PR #620) ✅
+- [x] Convert all files in `package/rules/`
+- [x] Convert all files in `package/plugins/`
+- [x] Convert all files in `package/optimization/`
+
+### Phase 5: Framework-Specific Modules ✅
+- [x] Convert rspack support files
+- [x] Convert swc support files
+- [x] Convert esbuild support files
+- [x] Convert babel preset
+
+### Phase 6: Final Cleanup ✅
+- [x] Add TypeScript linting with @typescript-eslint
+- [x] Verify strict mode is enabled (already configured)
+- [x] Update documentation
 
 ## Why Gradual Migration?
 - **Lower risk**: Each phase can be tested independently