shakapacker 7.3.0.beta.1 → 8.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32122fb686bab6ec0cfeba217c5d53ad88cf40897fe08564475a4e8fa8b79962
-  data.tar.gz: 1304bdd1f5d735bcc3642ae27a1d9151a75ca1a7c3cf33b1217163577f43a193
+  metadata.gz: 78b70cacbde999707fcbdf1d0f45a192e21c7e5eef5e9f5709835b9dcadd3824
+  data.tar.gz: 1110ce2c14512b80243f70d6273565e01983cac159c002e044c9fc732c425c9d
 SHA512:
-  metadata.gz: c77d2e756603a02a42e5b3a5917cb77cce6b112edee947572348057adde9b4bb696c7cdffa592dcee63d851c2cbd04c4143504ed5edaa3ced7206b5c6a88f767
-  data.tar.gz: cdfa1f6f2771eef452dc9a0f3d447ff437bb99ac0b5427381d20042b83734d85f7e21eaf7559bd712788db2f788178c663a4b9117babc44441fb29fc079d5053
+  metadata.gz: 266bd0b3cd20a82d6b1d910e9b2a442c498c2a3dc259bc487604c80993e55fbbff81c0733b66edb8abc7215cc8b5252e60fa6b08c5c0608e3d7cf4f07c07e112
+  data.tar.gz: 2855f15d2c926a7a0bc3f6075dd46e75ab68368edbe98e19d3360a02bcbb271c0fa06a563b1c1ac5c89635862ef005e88680ef28df2c249cd3b9dfe3c6864faf

data/.eslintignore

@@ -1,4 +1,4 @@
 lib/*
 node_modules/*
 vendor/*
-**/__tests__/**/*
+spec/*

data/.eslintrc.js

@@ -1,15 +1,36 @@
 module.exports = {
-  extends: ['airbnb', 'prettier'],
+  extends: ["airbnb", "plugin:prettier/recommended"],
   rules: {
-    'comma-dangle': ['error', 'never'],
-    'import/no-unresolved': 'off',
-    'import/no-extraneous-dependencies': 'off',
-    'import/extensions': 'off',
-    "indent": ["error", 2],
-    semi: ['error', 'never']
+    "import/no-unresolved": "off",
+    "import/no-extraneous-dependencies": "off",
+    "import/extensions": "off",
+    indent: ["error", 2]
   },
   env: {
     browser: true,
     node: true
-  }
+  },
+  overrides: [
+    {
+      files: ["test/**"],
+      extends: ["plugin:jest/recommended", "plugin:jest/style"],
+      rules: {
+        "global-require": "off",
+        "jest/prefer-called-with": "error",
+        "jest/no-conditional-in-test": "error",
+        "jest/no-test-return-statement": "error",
+        "jest/prefer-expect-resolves": "error",
+        "jest/require-to-throw-message": "error",
+        "jest/require-top-level-describe": "error",
+        "jest/prefer-hooks-on-top": "error",
+        "jest/prefer-lowercase-title": [
+          "error",
+          { ignoreTopLevelDescribe: true }
+        ],
+        "jest/prefer-spy-on": "error",
+        "jest/prefer-strict-equal": "error",
+        "jest/prefer-todo": "error"
+      }
+    }
+  ]
 }

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,13 @@
 ### Summary
 
-_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._
+<!--
+  Describe the code changes in your pull request here - were there any bugs you had fixed, features you added, tradeoffs you made?
+  If so, mention them. If these changes 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 does not apply to the PR, both check it out and wrap it by `~`._
+
+<!-- If any of the items on this checklist do not apply to the PR, both check it out and wrap it by `~`. -->
 
 - [ ] Add/update test to cover these changes
 - [ ] Update documentation
@@ -11,4 +15,7 @@ _Remove this line after checking all the items here. If the item does not apply
 
 ### Other Information
 
-_Remove this paragraph and mention other important and relevant information, such as benchmarks._
+<!--
+  Mention any other important information that might relate to this PR but that don't belong in the summary,
+  like detailed benchmarks or possible follow-up changes.
+-->

data/.github/workflows/dummy.yml

@@ -3,9 +3,14 @@ name: Dummy specs
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
   pull_request:
 
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest

data/.github/workflows/generator.yml

@@ -3,9 +3,14 @@ name: Generator specs
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
   pull_request:
 
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     name: Generator specs
@@ -13,22 +18,21 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ruby: ['2.6', '2.7', '3.0']
-        use_package_json_gem: ['true', 'false']
+        ruby: ['2.7', '3.0', '3.1', '3.2']
         gemfile:
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
           - gemfiles/Gemfile-rails.7.0.x
+          - gemfiles/Gemfile-rails.7.1.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
+          - ruby: '3.1'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
+          - ruby: '3.2'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
+
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
@@ -39,13 +43,5 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      # Bundler 2.5.0 dropped support for Ruby 2.6 and 2.7
-      - name: Use Bundler 2.4.22
-        run: |
-          gem install bundler -v '2.4.22'
-          bundle config --local path vendor/bundle
-      - name: Install dependencies
-        run: bundle install
+          bundler-cache: true
       - run: bundle exec rake run_spec:generator
-        env:
-          SHAKAPACKER_USE_PACKAGE_JSON_GEM: ${{ matrix.use_package_json_gem }}

data/.github/workflows/node.yml

@@ -0,0 +1,56 @@
+name: Node based checks
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --non-interactive --prefer-offline
+
+      - name: Node eslint
+        run: yarn lint
+  test:
+    name: Testing
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [14.x, 16.x, 18.x, 20.x]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --non-interactive --prefer-offline
+
+      - name: Jest Specs
+        run: yarn test

data/.github/workflows/ruby.yml

@@ -1,33 +1,52 @@
-name: Ruby specs
+name: Ruby based checks
 
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
   pull_request:
 
+concurrency:
+  # Pushing new changes to a branch will cancel any in-progress CI runs
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Ruby rubocop
+        run: bundle exec rubocop
+
   test:
-    name: Ruby specs
+    name: Testing
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ruby: ['2.6', '2.7', '3.0']
+        ruby: ['2.7', '3.0', '3.1', '3.2']
         gemfile:
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
           - gemfiles/Gemfile-rails.7.0.x
+          - gemfiles/Gemfile-rails.7.1.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
+          - ruby: '3.1'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
+          - ruby: '3.2'
+            gemfile: gemfiles/Gemfile-rails.6.0.x
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
@@ -43,10 +62,3 @@ jobs:
 
       - name: Ruby specs
         run: bundle exec rake run_spec:gem
-        env:
-          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "false"
-
-      - name: Ruby specs
-        run: bundle exec rake run_spec:gem
-        env:
-          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "true"

data/.node-version

@@ -1 +1 @@
-16.14.0
+21.0.0

data/.rubocop.yml

@@ -1,5 +1,6 @@
 require: rubocop-performance
 AllCops:
+  TargetRubyVersion: 2.7
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true

data/CHANGELOG.md

@@ -1,20 +1,70 @@
 * 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 [v8 Upgrade Guide](./docs/v8_upgrade.md) for upgrading to version 8 and accounting for breaking changes.
 * 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).
 
+_next_ branch is for v8 changes
+
 ## Versions
 ## [Unreleased]
 Changes since the last non-beta release.
 
+### Breaking changes
+- Remove `relative_url_root` [PR 413](https://github.com/shakacode/shakapacker/pull/413) by [G-Rath](https://github.com/g-rath).
+
+- Removes deprecated support of `Webpacker` spelling, config variables and constants. [PR 429](https://github.com/shakacode/shakapacker/pull/429) by [tomdracz](https://github.com/tomdracz).
+
+  The usage of those has been deprecated in Shakapacker v7 and now fully removed in v8. See the [v7 Upgrade Guide](./docs/v7_upgrade.md) for more information if you are still yet to address this deprecation.
+
+- Remove `globalMutableWebpackConfig` global [PR 439](https://github.com/shakacode/shakapacker/pull/439) by [G-Rath](https://github.com/g-rath).
+
+  Use `generateWebpackConfig` instead.
+
+- Use `package_json` gem to manage Node dependencies and commands, and use `npm` by default [PR 430](https://github.com/shakacode/shakapacker/pull/430) by [G-Rath](https://github.com/g-rath)
+
+  This enables support for package managers other than `yarn`, with `npm` being the default; to continue using Yarn,
+  specify it in `package.json` using the [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property.
+
+- Remove `yarn_install` rake task, and stop installing js packages automatically as part of `assets:precompile` [PR 412](https://github.com/shakacode/shakapacker/pull/412) by [G-Rath](https://github.com/g-rath).
+
+- Remove `check_yarn` rake task [PR 443](https://github.com/shakacode/shakapacker/pull/443) by [G-Rath](https://github.com/g-rath).
+
+- Remove `https` option for `webpack-dev-server` [PR 414](https://github.com/shakacode/shakapacker/pull/414) by [G-Rath](https://github.com/g-rath).
+
+- Remove `verify_file_existance` method [PR 446](https://github.com/shakacode/shakapacker/pull/446) by [G-Rath](https://github.com/g-rath).
+
+- Drop support for Ruby 2.6 [PR 415](https://github.com/shakacode/shakapacker/pull/415) by [G-Rath](https://github.com/g-rath).
+
+- Drop support for Node v12 [PR 431](https://github.com/shakacode/shakapacker/pull/431) by [G-Rath](https://github.com/g-rath).
+
+- Enable `ensure_consistent_versioning` by default [PR 447](https://github.com/shakacode/shakapacker/pull/447) by [G-Rath](https://github.com/g-rath).
+
+- Asset files put in `additional_paths` will have their path stripped just like with the `source_path`. [PR 403](https://github.com/shakacode/shakapacker/pull/403) by [paypro-leon](https://github.com/paypro-leon).
+
+- Remove `isArray` utility (just use `Array.isArray` directly) and renamed a few files [PR 454](https://github.com/shakacode/shakapacker/pull/454) by [G-Rath](https://github.com/g-rath).
+
+- Make JavaScript test helper utilities internal (`chdirTestApp`, `chdirCwd`, `resetEnv`)  [PR 458](https://github.com/shakacode/shakapacker/pull/458) by [G-Rath](https://github.com/g-rath).
+
+## [v7.2.3] - March 23, 2024
+
+### Added
+- Emit warnings instead of errors when compilation is success but stderr is not empty. [PR 416](https://github.com/shakacode/shakapacker/pull/416) by [n-rodriguez](https://github.com/n-rodriguez).
+- Allow `webpack-dev-server` v5. [PR 418](https://github.com/shakacode/shakapacker/pull/418) by [G-Rath](https://github.com/g-rath)
+
+### Removed
+- Removes dependency on `glob` library. [PR 435](https://github.com/shakacode/shakapacker/pull/435) by [tomdracz](https://github.com/tomdracz).
+
+### Fixed
+- Uses config file passed in `SHAKAPACKER_CONFIG` consistently.[PR 448](https://github.com/shakacode/shakapacker/pull/448) by [tomdracz](https://github.com/tomdracz).
+
+   Previously this could have been ignored in few code branches, especially when checking for available environments.
+
 ## [v7.2.2] - January 19, 2024
 
 ### Added
 - Allow `compression-webpack-plugin` v11. [PR 406](https://github.com/shakacode/shakapacker/pull/406) by [tagliala](https://github.com/tagliala).
 
-### Changed
-- Just like with the `source_path` the paths in `additional_paths` will now also be stripped from asset paths. [PR 403](https://github.com/shakacode/shakapacker/pull/403) by [paypro-leon](https://github.com/paypro-leon).
-
 ## [v7.2.1] - December 30, 2023
 
 ### Fixed
@@ -65,7 +115,7 @@ Changes since the last non-beta release.
 
 - 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.
+  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/main/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).
@@ -303,7 +353,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 ## v5.4.3 and prior changes from rails/webpacker
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md)
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v7.2.2...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v7.2.3...main
+[v7.2.3]: https://github.com/shakacode/shakapacker/compare/v7.2.2...v7.2.3
 [v7.2.2]: https://github.com/shakacode/shakapacker/compare/v7.2.1...v7.2.2
 [v7.2.1]: https://github.com/shakacode/shakapacker/compare/v7.2.0...v7.2.1
 [v7.2.0]: https://github.com/shakacode/shakapacker/compare/v7.1.0...v7.2.0