shakapacker 6.6.0 → 7.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 667631baa338ba0105550f29536e148bed8b21475daf816b148ab22be98209f9
-  data.tar.gz: 1f49260d3dd206242d022a07200c8d5dbf370fbc72e1dedf10ab033add63dc52
+  metadata.gz: aba276f401a1f78173be61e48f752843e048ccab75e2cea85789e0db511f120b
+  data.tar.gz: d29b9940a940f999d5ec9be41a75fabf9d7601c44767b28bfca7c0068c537ded
 SHA512:
-  metadata.gz: c830769b5fc9a2c40c0e686848421ee39b6df1ae4866f6ad0f00a60b34e1d3262c2fa7b39012e92cbc5d1a985f200c38a636597a8a4adf339c5961960d457fe2
-  data.tar.gz: 818526e1d7b2f5a355a4ffe86c3b09e30ae1ca957fd077e685475aab512fe1107ce3f548e1100811a226c8cce6ed3a5f5a2e1511a9f822112eee9b091e9704c1
+  metadata.gz: dddcafead06f6db4f256759f7d8f243f5511f7b131d4bbdaae3da6cc3ea160854f82c70fd87ae313f33a14ec3309a6a762b35d24fcbffbd53c22a0eac0920abb
+  data.tar.gz: 06c7e5ed689286cb05091c00390f3b4ef56bbbec19bb5a30354c8819c503373dd503f8ed9f240c3ca970d07506045a6be0dfc96b4a0f1a9faa5dfc2c3cbcbdc3

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +1,14 @@
 ### Summary
 
-_Remove this paragraph and provide a general description of the code changes in your pull
-request... were there any bugs you had fixed? If so, mention them. If
-these bugs have open GitHub issues, be sure to tag them here as well,
-to keep the conversation linked together._
+_Remove this paragraph and describe the code changes in your pull request... were there any bugs you had fixed? If so, mention them. If these bugs have open GitHub issues, tag them here as well to keep the conversation linked._
 
 ### Pull Request checklist
-_Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by `~`._
+_Remove this line after checking all the items here. If the item does not apply to the PR, both check it out and wrap it by `~`._
 
 - [ ] Add/update test to cover these changes
 - [ ] Update documentation
-- [ ] Update CHANGELOG file  
-  _Add the CHANGELOG entry at the top of the file._
+- [ ] Update CHANGELOG file
 
 ### Other Information
 
-_Remove this parapraph and mention any other important and relevant information such as benchmarks._
+_Remove this paragraph and mention other important and relevant information, such as benchmarks._

data/.github/workflows/dummy.yml

@@ -0,0 +1,21 @@
+name: Dummy specs
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1.2'
+      - name: Install dependencies
+        run: |
+          bundle install
+          yarn install
+          sudo yarn global add yalc
+
+      - name: Run tests
+        run: bundle exec rake run_spec:dummy

data/.github/workflows/generator.yml

@@ -0,0 +1,37 @@
+name: Generator specs
+
+on: [push]
+
+jobs:
+  test:
+    name: Generator specs
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ['2.6', '2.7', '3.0']
+        gemfile:
+          - gemfiles/Gemfile-rails.6.0.x
+          - gemfiles/Gemfile-rails.6.1.x
+          - gemfiles/Gemfile-rails.7.0.x
+          # Uncomment the following line only to ensure compatibility with the
+          # upcomming Rails versions, maybe before a release.
+          #- gemfiles/Gemfile-rails-edge
+        exclude:
+          - ruby: 2.6
+            os: ubuntu-latest
+            gemfile: gemfiles/Gemfile-rails.7.0.x
+          - ruby: 2.6
+            os: ubuntu-latest
+            gemfile: gemfiles/Gemfile-rails-edge
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - run: bundle exec rake run_spec:generator

data/.github/workflows/jest.yml

@@ -1,6 +1,6 @@
 name: Jest specs
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   jest:
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [12.x, 14.x, 16.x]
+        node: [14.x, 16.x, 18.x]
 
     runs-on: ${{ matrix.os }}
 

data/.github/workflows/js-lint.yml

@@ -1,6 +1,6 @@
 name: JS lint
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   lint:
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [12.x, 14.x, 16.x]
+        node: [14.x, 16.x, 18.x]
 
     runs-on: ${{ matrix.os }}
 

data/.github/workflows/rubocop.yml

@@ -1,6 +1,6 @@
 name: Rubocop
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   rubocop:

data/.github/workflows/ruby-backward-compatibility.yml

@@ -0,0 +1,39 @@
+name: Ruby specs - Backward compatibility
+
+on: [push]
+
+jobs:
+  test:
+    name: Ruby specs - Backward compatibility
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ['2.6', '2.7', '3.0']
+        gemfile:
+          - gemfiles/Gemfile-rails.6.0.x
+          - gemfiles/Gemfile-rails.6.1.x
+          - gemfiles/Gemfile-rails.7.0.x
+          # Uncomment the following line only to ensure compatibility with the
+          # upcomming Rails versions, maybe before a release.
+          #- gemfiles/Gemfile-rails-edge
+        exclude:
+          - ruby: 2.6
+            os: ubuntu-latest
+            gemfile: gemfiles/Gemfile-rails.7.0.x
+          - ruby: 2.6
+            os: ubuntu-latest
+            gemfile: gemfiles/Gemfile-rails-edge
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Ruby specs - Backward compatibility
+        run: bundle exec rake run_spec:gem_bc

data/.github/workflows/ruby.yml

@@ -1,6 +1,6 @@
 name: Ruby specs
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   test:
@@ -11,7 +11,6 @@ jobs:
         os: [ubuntu-latest]
         ruby: ['2.6', '2.7', '3.0']
         gemfile:
-          - gemfiles/Gemfile-rails.5.2.x
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
           - gemfiles/Gemfile-rails.7.0.x
@@ -25,9 +24,6 @@ jobs:
           - ruby: 2.6
             os: ubuntu-latest
             gemfile: gemfiles/Gemfile-rails-edge
-          - ruby: 3.0
-            os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails.5.2.x
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
@@ -40,4 +36,4 @@ jobs:
           bundler-cache: true
 
       - name: Ruby specs
-        run: bundle exec rake test
+        run: bundle exec rake run_spec:gem_bc

data/.gitignore

@@ -12,3 +12,6 @@ yarn-error.log*
 /log
 gemfiles/*.lock
 .DS_Store
+
+.yalc
+yalc.lock

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 * For the changelog of versions prior to v6, see the [5.x stable branch of rails/webpacker](https://github.com/rails/webpacker/tree/5-x-stable).
+* Please see the [v7 Upgrade Guide](./docs/v7_upgrade.md) for upgrading to new spelling in version 7.
 * Please see the [v6 Upgrade Guide](./docs/v6_upgrade.md) to go from versions prior to v6.
 * [ShakaCode](https://www.shakacode.com) offers support for upgrading from Webpacker or using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com).
 
@@ -8,21 +9,64 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+### Breaking changes
+- Removes defaults passed to `@babel/preset-typescript`. [PR 273](https://github.com/shakacode/shakapacker/pull/273) by [tomdracz](https://github.com/tomdracz).
+
+  `@babel/preset-typescript` has been initialised in default configuration with `{ allExtensions: true, isTSX: true }` - meaning every file in the codebase was treated as TSX leading to potential issues. This has been removed and returns to sensible default of the preset which is to figure out the file type from the extensions. This change might affect generated output however so it is marked as breaking.
+
+- Export immutable webpackConfig function. [PR 293](https://github.com/shakacode/shakapacker/pull/293) by [tomdracz](https://github.com/tomdracz).
+
+  The `webpackConfig` property in the `shakapacker` module has been updated to be a function instead of a global mutable webpack configuration. This function now returns an immutable webpack configuration object, which ensures that any modifications made to it will not affect any other usage of the webpack configuration. If a project still requires the old mutable object, it can be accessed by replacing `webpackConfig` with `globalMutableWebpackConfig`. Check [v7-upgrade](https://github.com/shakacode/shakapacker/blob/master/docs/v7_upgrade.md) documentation for more detail.
+
+### Added
+- Set CSS modules mode depending on file type. [PR 261](https://github.com/shakacode/shakapacker/pull/261) by [talyuk](https://github.com/talyuk).
+- All standard webpack entries with the camelCase format are now supported in `shakapacker.yml` in snake_case format. [PR276](https://github.com/shakacode/shakapacker/pull/276) by [ahangarha](https://github.com/ahangarha).
+- The `shakapacker:install` rake task now has an option to force overriding files using `FORCE=true` environment variable [PR311](https://github.com/shakacode/shakapacker/pull/311) by [ahangarha](https://github.com/ahangarha).
+
+### Changed
+- Rename Webpacker to Shakapacker in the entire project including config files, binstubs, environment variables, etc. with a high degree of backward compatibility.
+
+  This change might be breaking for certain setups and edge cases. More information: [v7 Upgrade Guide](./docs/v7_upgrade.md) [PR157](https://github.com/shakacode/shakapacker/pull/157) by [ahangarha](https://github.com/ahangarha)
+
+- Set `source_entry_path` to `packs` and `nested_entries` to `true` in`shakapacker.yml` [PR 284](https://github.com/shakacode/shakapacker/pull/284) by [ahangarha](https://github.com/ahangarha).
+- Dev server configuration is modified to follow [webpack recommended configurations](https://webpack.js.org/configuration/dev-server/) for dev server. [PR276](https://github.com/shakacode/shakapacker/pull/276) by [ahangarha](https://github.com/ahangarha):
+  - Deprecated `https` entry is removed from the default configuration file, allowing to set `server` or `https` as per the project requirements. For more detail, check webpack documentation. The `https` entry can be effective only if there is no `server` entry in the config file.
+  - `allowed_hosts` is now set to `auto` instead of `all` by default.
+
+- Remove the arbitrary stripping of the top-level directory when generating static file paths. [PR 283](https://github.com/shakacode/shakapacker/pull/283) by [tomdracz](https://github.com/tomdracz).
+
+  Prior to this change, top level directory of static assets like images and fonts was stripped. This meant that file in `app/javascript/images/image.png` would be output to `static/image.png` directory and could be referenced through helpers as `image_pack_tag("image.jpg")` or `image_pack_tag("static/image.jpg")`.
+
+  Going forward, the top level directory of static files will be retained so this will necessitate the update of file name references in asset helpers. In the example above, the file sourced from `app/javascript/images/image.png` will be now output to `static/images/image.png` and needs to be referenced as `image_pack_tag("images/image.jpg")` or `image_pack_tag("static/images/image.jpg")`.
+
+### Fixed
+- Move compilation lock file into the working directory. [PR 272](https://github.com/shakacode/shakapacker/pull/272) by [tomdracz](https://github.com/tomdracz).
+- Process `source_entry_path` with values starting with `/` as a relative path to `source_path` [PR 284](https://github.com/shakacode/shakapacker/pull/284) by [ahangarha](https://github.com/ahangarha).
+- Removes defaults passed to `@babel/preset-typescript` to make it possible to have projects with mix of JS and TS code [PR 273](https://github.com/shakacode/shakapacker/pull/273) by [tomdracz](https://github.com/tomdracz).
+
+  `@babel/preset-typescript` has been initialised in default configuration with `{ allExtensions: true, isTSX: true }` - meaning every file in the codebase was treated as TSX leading to potential issues. This has been removed and returns to sensible default of the preset which is to figure out the file type from the extensions. This change might affect generated output however so it is marked as breaking.
+
+- Fixed RC version detection during installation. [PR312](https://github.com/shakacode/shakapacker/pull/312) by [ahangarha](https://github.com/ahangarha)
+- Fix addition of webpack-dev-server to devDependencies during installation. [PR310](https://github.com/shakacode/shakapacker/pull/310) by [ahangarha](https://github.com/ahangarha)
+### Removed
+- Remove redundant enhancement for precompile task to run `yarn install` [PR 270](https://github.com/shakacode/shakapacker/pull/270) by [ahangarha](https://github.com/ahangarha).
+- Remove deprecated `check_yarn_integrity` from `Shakapacker::Configuration` [PR SP288](https://github.com/shakacode/shakapacker/pull/288) by [ahangarha](https://github.com/ahangarha).
+
 ## [v6.6.0] - March 7, 2023
 ### Improved
-- Allow configuration of webpacker.yml through env variable. [PR 254](https://github.com/shakacode/shakapacker/pull/254) by [alecslupu](https://github.com/alecslupu)
+- Allow configuration of webpacker.yml through env variable. [PR 254](https://github.com/shakacode/shakapacker/pull/254) by [alecslupu](https://github.com/alecslupu).
 
 ## [v6.5.6] - February 11, 2023
 ### Fixed
-- Fixed failing to update `bin/setup` file due to different formats of the file in different versions of Rails. [PR 229](https://github.com/shakacode/shakapacker/pull/229) by [ahangarha](https://github.com/ahangarha)
+- Fixed failing to update `bin/setup` file due to different formats of the file in different versions of Rails. [PR 229](https://github.com/shakacode/shakapacker/pull/229) by [ahangarha](https://github.com/ahangarha).
 
 - Upgrade several JS dependencies to fix security issues. [PR 243](https://github.com/shakacode/shakapacker/pull/243) by [ahangarha](https://github.com/ahangarha).
 
 - Added `prepend_javascript_pack_tag` to helpers. Allows to move an entry to the top of queue. Handy when calling from the layout to make sure an entry goes before the view and partial `append_javascript_pack_tag` entries. [PR 235](https://github.com/shakacode/shakapacker/pull/235) by [paypro-leon](https://github.com/paypro-leon).
 
-- Fixed [issue](https://github.com/shakacode/shakapacker/issues/208) to support directories under `node_modules/*` in the `additional_paths` property of `webpacker.yml` [PR 238](https://github.com/shakacode/shakapacker/pull/238) by [vaukalak](https://github.com/vaukalak).
+- Fixed [issue](https://github.com/shakacode/shakapacker/issues/208) to support directories under `node_modules/*` in the `additional_paths` property of `webpacker.yml` [PR 240](https://github.com/shakacode/shakapacker/pull/240) by [vaukalak](https://github.com/vaukalak).
 - Remove duplicate yarn installs. [PR 238](https://github.com/shakacode/shakapacker/pull/238) by [justin808](https://github/justin808).
-- Remove unneeded code related to CSP config for generator. [PR 223](https://github.com/shakacode/shakapacker/pull/223) by [ahangarha](https://github/ahangarha). 
+- Remove unneeded code related to CSP config for generator. [PR 223](https://github.com/shakacode/shakapacker/pull/223) by [ahangarha](https://github/ahangarha).
 
 ## [v6.5.5] - December 28, 2022
 

data/CONTRIBUTING.md

@@ -1,26 +1,60 @@
+# Contributing Guidelines
+
+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)
 - [Making sure your changes pass all tests](#making-sure-your-changes-pass-all-tests)
 - [Testing the generator](#testing-the-generator)
-- [Find existing issues](#find-existing-issues)
 
----
-## Setting Up a Development Environment
+## Reporting Issues
+If you encounter any issues with the project, please first check the exisiting 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).
 
-1. Install [Yarn](https://yarnpkg.com/)
+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.
 
-2. Run the following commands to set up the development environment.
+## 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:
 
-```
-bundle install
-yarn
-```
+  - 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.
+
+---
+## 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"
+      ```
+   - 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 chagnes in shakapacker, run the folloing in Shakapacker directory
+      yalc push # or yalc publish --push
+      ```
+3. Run the following commands to set up the development environment.
+   ```
+   bundle install
+   yarn install
+   ```
 
 ## Making sure your changes pass all tests
 
-There are a number of automated checks which run on GitHub Actions when a pull request is created.
+There are several specs, covering different aspects of Shakapacker gem. You may run them locally or rely on GitHub CI actions configured to test the gem functionality if different Ruby, Rails, and Node environment.
 
-You can run those checks on your own locally to make sure that your changes would not break the CI build.
+We request running tests locally to ensure the new changes would not break the CI build.
 
 ### 1. Check the code for JavaScript style violations
 
@@ -40,33 +74,55 @@ bundle exec rubocop
 yarn test
 ```
 
-### 4. Run the Ruby test suite
+### 4. Run all the Ruby test suite
 
 ```
 bundle exec rake test
 ```
 
+Note: For this, you need `yalc` to be installed on your local machine
+
 #### 4.1 Run a single ruby test file
 
 ```
-bundle exec rake test TEST=test/rake_tasks_test.rb
+bundle exec rspec spec/configuration_spec.rb
 ```
 
 #### 4.2 Run a single ruby test
 
 ```
-bundle exec ruby -I test test/rake_tasks_test.rb -n test_rake_webpacker_install
+bundle exec rspec -e "#source_entry_path returns correct path"
 ```
 
-## Testing the generator
-If you change the generator, check that install instructions work.
+#### 4.3 Run only Shakapacker gem specs
 
-1. Update the gemfile so that gem "webpacker" has a line like this, pointing to your install of webpacker
+```
+bundle exec rake run_spec:gem
+```
+
+#### 4.4 Run only Shakapacker gem specs for backward compatibility
+These specs are to check Shakapcker v7 backward compatibility with v6.x
+
+```
+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
+
+```
+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:
    ```ruby
-   gem 'webpacker', path: "~/shakacode/forks/shakapacker"
+   gem 'shakapacker', path: "relative_or_absolute_path_to_the_gem"
    ```
-2. `bundle`
-3. Run the generator confirm that you got the right changes. 
+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.
 
-## Find existing issues
-You may look at the issues list to find existing known issues to be addressed. In this, we recommend to look at closed issues, particularly with "[help wanted](https://github.com/shakacode/shakapacker/issues?q=is%3Aissue+label%3A%22help+wanted%22+is%3Aclosed+)" label.

data/Gemfile.development_dependencies

@@ -7,7 +7,7 @@ gem "nokogiri", ">= 1.13.6"
 gem "rails-html-sanitizer", ">= 1.4.3"
 
 group :test, :development do
-  gem "rspec-rails", "~> 5.0.0"
+  gem "rspec-rails", "~> 6.0.2"
 end
 
 group :test do