shakapacker 8.0.2 → 9.2.0

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 9.2.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 - Gaurav Tiwari
 - Justin Gordon
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -124,7 +123,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - david@basecamp.com
 - gaurav@gauravtiwari.co.uk
@@ -134,20 +132,30 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".eslintignore"
+- ".eslintrc.fast.js"
 - ".eslintrc.js"
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/STATUS.md"
+- ".github/workflows/claude-code-review.yml"
+- ".github/workflows/claude.yml"
 - ".github/workflows/dummy.yml"
 - ".github/workflows/generator.yml"
 - ".github/workflows/node.yml"
 - ".github/workflows/ruby.yml"
+- ".github/workflows/test-bundlers.yml"
 - ".gitignore"
+- ".husky/pre-commit"
 - ".node-version"
+- ".npmignore"
+- ".prettierignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".yalcignore"
 - CHANGELOG.md
+- CLAUDE.md
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.development_dependencies
@@ -155,37 +163,64 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- TODO.md
+- TODO_v9.md
 - __mocks__/nonexistent/package.json
 - __mocks__/sass-loader/package.json
+- bin/export-bundler-config
+- conductor-setup.sh
+- conductor.json
 - config/README.md
 - config/shakapacker.yml
+- docs/cdn_setup.md
+- docs/common-upgrades.md
+- docs/css-modules-export-mode.md
 - docs/customizing_babel_config.md
 - docs/deployment.md
 - docs/developing_shakapacker.md
+- docs/optional-peer-dependencies.md
+- docs/peer-dependencies.md
 - docs/react.md
+- docs/releasing.md
+- docs/rspack.md
+- docs/rspack_migration_guide.md
 - docs/sprockets.md
 - docs/style_loader_vs_mini_css.md
+- docs/subresource_integrity.md
+- docs/transpiler-migration.md
+- docs/transpiler-performance.md
 - docs/troubleshooting.md
+- docs/typescript-migration.md
+- docs/typescript.md
 - docs/using_esbuild_loader.md
 - docs/using_swc_loader.md
 - docs/v6_upgrade.md
 - docs/v7_upgrade.md
 - docs/v8_upgrade.md
+- docs/v9_upgrade.md
 - gemfiles/Gemfile-rails-edge
 - gemfiles/Gemfile-rails.6.0.x
 - gemfiles/Gemfile-rails.6.1.x
 - gemfiles/Gemfile-rails.7.0.x
 - gemfiles/Gemfile-rails.7.1.x
+- gemfiles/Gemfile-rails.7.2.x
+- gemfiles/Gemfile-rails.8.0.x
 - jest.config.js
 - lib/install/application.js
+- lib/install/bin/export-bundler-config
 - lib/install/bin/shakapacker
 - lib/install/bin/shakapacker-dev-server
 - lib/install/binstubs.rb
+- lib/install/config/rspack/rspack.config.js
+- lib/install/config/rspack/rspack.config.ts
 - lib/install/config/shakapacker.yml
 - lib/install/config/webpack/webpack.config.js
+- lib/install/config/webpack/webpack.config.ts
+- lib/install/package.json
 - lib/install/template.rb
 - lib/shakapacker.rb
 - lib/shakapacker/base_strategy.rb
+- lib/shakapacker/bundler_switcher.rb
 - lib/shakapacker/commands.rb
 - lib/shakapacker/compiler.rb
 - lib/shakapacker/compiler_strategy.rb
@@ -195,13 +230,16 @@ files:
 - lib/shakapacker/dev_server_proxy.rb
 - lib/shakapacker/dev_server_runner.rb
 - lib/shakapacker/digest_strategy.rb
+- lib/shakapacker/doctor.rb
 - lib/shakapacker/env.rb
 - lib/shakapacker/helper.rb
 - lib/shakapacker/instance.rb
 - lib/shakapacker/manifest.rb
 - lib/shakapacker/mtime_strategy.rb
 - lib/shakapacker/railtie.rb
+- lib/shakapacker/rspack_runner.rb
 - lib/shakapacker/runner.rb
+- lib/shakapacker/swc_migrator.rb
 - lib/shakapacker/utils/manager.rb
 - lib/shakapacker/utils/misc.rb
 - lib/shakapacker/utils/version_syntax_converter.rb
@@ -216,44 +254,78 @@ files:
 - lib/tasks/shakapacker/clean.rake
 - lib/tasks/shakapacker/clobber.rake
 - lib/tasks/shakapacker/compile.rake
+- lib/tasks/shakapacker/doctor.rake
+- lib/tasks/shakapacker/export_bundler_config.rake
 - lib/tasks/shakapacker/info.rake
 - lib/tasks/shakapacker/install.rake
+- lib/tasks/shakapacker/migrate_to_swc.rake
+- lib/tasks/shakapacker/switch_bundler.rake
 - lib/tasks/shakapacker/verify_config.rake
 - lib/tasks/shakapacker/verify_install.rake
+- package-lock.json
 - package.json
-- package/babel/preset.js
-- package/config.js
-- package/dev_server.js
-- package/env.js
-- package/environments/base.js
-- package/environments/development.js
-- package/environments/production.js
-- package/environments/test.js
-- package/esbuild/index.js
+- package/.npmignore
+- package/babel/preset.ts
+- package/config.ts
+- package/configExporter/cli.ts
+- package/configExporter/configDocs.ts
+- package/configExporter/fileWriter.ts
+- package/configExporter/index.ts
+- package/configExporter/types.ts
+- package/configExporter/yamlSerializer.ts
+- package/dev_server.ts
+- package/env.ts
+- package/environments/__type-tests__/rspack-plugin-compatibility.ts
+- package/environments/base.ts
+- package/environments/development.ts
+- package/environments/production.ts
+- package/environments/test.ts
+- package/environments/types.ts
+- package/esbuild/index.ts
 - package/index.d.ts
-- package/index.js
-- package/rules/babel.js
-- package/rules/coffee.js
-- package/rules/css.js
-- package/rules/erb.js
-- package/rules/esbuild.js
-- package/rules/file.js
-- package/rules/index.js
-- package/rules/jscommon.js
-- package/rules/less.js
-- package/rules/raw.js
-- package/rules/sass.js
-- package/rules/stylus.js
-- package/rules/swc.js
-- package/swc/index.js
-- package/utils/configPath.js
-- package/utils/defaultConfigPath.js
-- package/utils/getStyleRule.js
-- package/utils/helpers.js
-- package/utils/inliningCss.js
-- package/utils/snakeToCamelCase.js
-- package/webpackDevServerConfig.js
+- package/index.ts
+- package/loaders.d.ts
+- package/optimization/rspack.ts
+- package/optimization/webpack.ts
+- package/plugins/rspack.ts
+- package/plugins/webpack.ts
+- package/rspack/index.ts
+- package/rules/babel.ts
+- package/rules/coffee.ts
+- package/rules/css.ts
+- package/rules/erb.ts
+- package/rules/esbuild.ts
+- package/rules/file.ts
+- package/rules/jscommon.ts
+- package/rules/less.ts
+- package/rules/raw.ts
+- package/rules/rspack.ts
+- package/rules/sass.ts
+- package/rules/stylus.ts
+- package/rules/swc.ts
+- package/rules/webpack.ts
+- package/swc/index.ts
+- package/types.ts
+- package/types/README.md
+- package/types/index.ts
+- package/utils/configPath.ts
+- package/utils/debug.ts
+- package/utils/defaultConfigPath.ts
+- package/utils/errorCodes.ts
+- package/utils/errorHelpers.ts
+- package/utils/getStyleRule.ts
+- package/utils/helpers.ts
+- package/utils/inliningCss.ts
+- package/utils/pathValidation.ts
+- package/utils/requireOrError.ts
+- package/utils/snakeToCamelCase.ts
+- package/utils/typeGuards.ts
+- package/utils/validateDependencies.ts
+- package/webpack-types.d.ts
+- package/webpackDevServerConfig.ts
 - prettier.config.js
+- scripts/remove-use-strict.js
+- scripts/type-check-no-emit.js
 - shakapacker.gemspec
 - test/helpers.js
 - test/package/config.test.js
@@ -269,21 +341,31 @@ files:
 - test/package/rules/babel.test.js
 - test/package/rules/esbuild.test.js
 - test/package/rules/file.test.js
-- test/package/rules/index.test.js
 - test/package/rules/raw.test.js
 - test/package/rules/sass.test.js
 - test/package/rules/sass1.test.js
 - test/package/rules/swc.test.js
+- test/package/rules/webpack.test.js
 - test/package/staging.test.js
 - test/package/test.test.js
+- test/package/transpiler-defaults.test.js
+- test/peer-dependencies.sh
 - test/resolver.js
+- test/scripts/remove-use-strict.test.js
+- test/typescript/build.test.js
+- test/typescript/environments.test.js
+- test/typescript/pathValidation.test.js
+- test/typescript/securityValidation.test.js
+- tools/README.md
+- tools/css-modules-v9-codemod.js
+- tsconfig.eslint.json
+- tsconfig.json
 - yarn.lock
 homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v8.0.2
-post_install_message:
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.2.0
 rdoc_options: []
 require_paths:
 - lib
@@ -298,8 +380,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Use webpack to manage app-like JavaScript modules in Rails
 test_files:
@@ -317,11 +398,18 @@ test_files:
 - test/package/rules/babel.test.js
 - test/package/rules/esbuild.test.js
 - test/package/rules/file.test.js
-- test/package/rules/index.test.js
 - test/package/rules/raw.test.js
 - test/package/rules/sass.test.js
 - test/package/rules/sass1.test.js
 - test/package/rules/swc.test.js
+- test/package/rules/webpack.test.js
 - test/package/staging.test.js
 - test/package/test.test.js
+- test/package/transpiler-defaults.test.js
+- test/peer-dependencies.sh
 - test/resolver.js
+- test/scripts/remove-use-strict.test.js
+- test/typescript/build.test.js
+- test/typescript/environments.test.js
+- test/typescript/pathValidation.test.js
+- test/typescript/securityValidation.test.js

data/package/babel/preset.js

@@ -1,37 +0,0 @@
-const { moduleExists } = require("shakapacker")
-
-module.exports = function config(api) {
-  const validEnv = ["development", "test", "production"]
-  const currentEnv = api.env()
-  const isDevelopmentEnv = api.env("development")
-  const isProductionEnv = api.env("production")
-  const isTestEnv = api.env("test")
-
-  if (!validEnv.includes(currentEnv)) {
-    throw new Error(
-      `Please specify a valid NODE_ENV or BABEL_ENV environment variable. Valid values are "development", "test", and "production". Instead, received: "${JSON.stringify(
-        currentEnv
-      )}".`
-    )
-  }
-
-  return {
-    presets: [
-      isTestEnv && ["@babel/preset-env", { targets: { node: "current" } }],
-      (isProductionEnv || isDevelopmentEnv) && [
-        "@babel/preset-env",
-        {
-          useBuiltIns: "entry",
-          corejs: "3.8",
-          modules: "auto",
-          bugfixes: true,
-          exclude: ["transform-typeof-symbol"]
-        }
-      ],
-      moduleExists("@babel/preset-typescript") && "@babel/preset-typescript"
-    ].filter(Boolean),
-    plugins: [["@babel/plugin-transform-runtime", { helpers: false }]].filter(
-      Boolean
-    )
-  }
-}

data/package/config.js

@@ -1,54 +0,0 @@
-const { resolve } = require("path")
-const { load } = require("js-yaml")
-const { existsSync, readFileSync } = require("fs")
-
-const { merge } = require("webpack-merge")
-const { ensureTrailingSlash } = require("./utils/helpers")
-const { railsEnv } = require("./env")
-const configPath = require("./utils/configPath")
-
-const defaultConfigPath = require("./utils/defaultConfigPath")
-
-const getDefaultConfig = () => {
-  const defaultConfig = load(readFileSync(defaultConfigPath), "utf8")
-  return defaultConfig[railsEnv] || defaultConfig.production
-}
-
-const defaults = getDefaultConfig()
-let config
-
-if (existsSync(configPath)) {
-  const appYmlObject = load(readFileSync(configPath), "utf8")
-  const envAppConfig = appYmlObject[railsEnv]
-
-  if (!envAppConfig) {
-    /* eslint no-console:0 */
-    console.warn(
-      `Warning: ${railsEnv} key not found in the configuration file. Using production configuration as a fallback.`
-    )
-  }
-
-  config = merge(defaults, envAppConfig || {})
-} else {
-  config = merge(defaults, {})
-}
-
-config.outputPath = resolve(config.public_root_path, config.public_output_path)
-
-// Ensure that the publicPath includes our asset host so dynamic imports
-// (code-splitting chunks and static assets) load from the CDN instead of a relative path.
-const getPublicPath = () => {
-  const rootUrl = ensureTrailingSlash(process.env.SHAKAPACKER_ASSET_HOST || "/")
-  return `${rootUrl}${config.public_output_path}/`
-}
-
-config.publicPath = getPublicPath()
-config.publicPathWithoutCDN = `/${config.public_output_path}/`
-
-if (config.manifest_path) {
-  config.manifestPath = resolve(config.manifest_path)
-} else {
-  config.manifestPath = resolve(config.outputPath, "manifest.json")
-}
-
-module.exports = config

data/package/env.js

@@ -1,48 +0,0 @@
-const { load } = require("js-yaml")
-const { readFileSync } = require("fs")
-const defaultConfigPath = require("./utils/defaultConfigPath")
-
-const NODE_ENVIRONMENTS = ["development", "production", "test"]
-const DEFAULT = "production"
-const configPath = require("./utils/configPath")
-
-const railsEnv = process.env.RAILS_ENV
-const rawNodeEnv = process.env.NODE_ENV
-const nodeEnv =
-  rawNodeEnv && NODE_ENVIRONMENTS.includes(rawNodeEnv) ? rawNodeEnv : DEFAULT
-const isProduction = nodeEnv === "production"
-const isDevelopment = nodeEnv === "development"
-
-let config
-try {
-  config = load(readFileSync(configPath), "utf8")
-} catch (error) {
-  if (error.code === "ENOENT") {
-    // File not found, use default configuration
-    config = load(readFileSync(defaultConfigPath), "utf8")
-  } else {
-    throw error
-  }
-}
-
-const availableEnvironments = Object.keys(config).join("|")
-const regex = new RegExp(`^(${availableEnvironments})$`, "g")
-
-const runningWebpackDevServer = process.env.WEBPACK_SERVE === "true"
-
-const validatedRailsEnv = railsEnv && railsEnv.match(regex) ? railsEnv : DEFAULT
-
-if (railsEnv && validatedRailsEnv !== railsEnv) {
-  /* eslint no-console:0 */
-  console.warn(
-    `Warning: '${railsEnv}' environment not found in the configuration. Using '${DEFAULT}' configuration as a fallback.`
-  )
-}
-
-module.exports = {
-  railsEnv: validatedRailsEnv,
-  nodeEnv,
-  isProduction,
-  isDevelopment,
-  runningWebpackDevServer
-}

data/package/environments/development.js

@@ -1,13 +0,0 @@
-const { merge } = require("webpack-merge")
-
-const baseConfig = require("./base")
-const webpackDevServerConfig = require("../webpackDevServerConfig")
-const { runningWebpackDevServer } = require("../env")
-
-const devConfig = {
-  mode: "development",
-  devtool: "cheap-module-source-map",
-  ...(runningWebpackDevServer && { devServer: webpackDevServerConfig() })
-}
-
-module.exports = merge(baseConfig, devConfig)

data/package/environments/production.js

@@ -1,88 +0,0 @@
-/* eslint global-require: 0 */
-/* eslint import/no-dynamic-require: 0 */
-
-const { merge } = require("webpack-merge")
-const CompressionPlugin = require("compression-webpack-plugin")
-const TerserPlugin = require("terser-webpack-plugin")
-const baseConfig = require("./base")
-const { moduleExists } = require("../utils/helpers")
-const config = require("../config")
-
-const getPlugins = () => {
-  const plugins = []
-
-  plugins.push(
-    new CompressionPlugin({
-      filename: "[path][base].gz[query]",
-      algorithm: "gzip",
-      test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
-    })
-  )
-
-  if ("brotli" in process.versions) {
-    plugins.push(
-      new CompressionPlugin({
-        filename: "[path][base].br[query]",
-        algorithm: "brotliCompress",
-        test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
-      })
-    )
-  }
-
-  return plugins
-}
-
-const tryCssMinimizer = () => {
-  if (
-    moduleExists("css-loader") &&
-    moduleExists("css-minimizer-webpack-plugin")
-  ) {
-    const CssMinimizerPlugin = require("css-minimizer-webpack-plugin")
-    return new CssMinimizerPlugin()
-  }
-
-  return null
-}
-
-const productionConfig = {
-  devtool: "source-map",
-  stats: "normal",
-  bail: true,
-  plugins: getPlugins(),
-  optimization: {
-    minimizer: [
-      tryCssMinimizer(),
-      new TerserPlugin({
-        parallel: Number.parseInt(process.env.SHAKAPACKER_PARALLEL, 10) || true,
-        terserOptions: {
-          parse: {
-            // Let terser parse ecma 8 code but always output
-            // ES5 compliant code for older browsers
-            ecma: 8
-          },
-          compress: {
-            ecma: 5,
-            warnings: false,
-            comparisons: false
-          },
-          mangle: { safari10: true },
-          output: {
-            ecma: 5,
-            comments: false,
-            ascii_only: true
-          }
-        }
-      })
-    ].filter(Boolean)
-  }
-}
-
-if (config.useContentHash === false) {
-  // eslint-disable-next-line no-console
-  console.warn(`⚠️ WARNING
-Setting 'useContentHash' to 'false' in the production environment (specified by NODE_ENV environment variable) is not allowed!
-Content hashes get added to the filenames regardless of setting useContentHash in 'shakapacker.yml' to false.
-`)
-}
-
-module.exports = merge(baseConfig, productionConfig)

data/package/environments/test.js

@@ -1,3 +0,0 @@
-const baseConfig = require("./base")
-
-module.exports = baseConfig

data/package/esbuild/index.js

@@ -1,40 +0,0 @@
-/* eslint global-require: 0 */
-/* eslint import/no-dynamic-require: 0 */
-
-const { resolve } = require("path")
-const { existsSync } = require("fs")
-const { merge } = require("webpack-merge")
-
-const getLoaderExtension = (filename) => {
-  const matchData = filename.match(/\.([jt]sx?)?(\.erb)?$/)
-
-  if (!matchData) {
-    return "js"
-  }
-
-  return matchData[1]
-}
-
-const getCustomConfig = () => {
-  const path = resolve("config", "esbuild.config.js")
-  if (existsSync(path)) {
-    return require(path)
-  }
-  return {}
-}
-
-const getEsbuildLoaderConfig = (filenameToProcess) => {
-  const customConfig = getCustomConfig()
-  const defaultConfig = {
-    loader: require.resolve("esbuild-loader"),
-    options: {
-      loader: getLoaderExtension(filenameToProcess)
-    }
-  }
-
-  return merge(defaultConfig, customConfig)
-}
-
-module.exports = {
-  getEsbuildLoaderConfig
-}

data/package/index.js

@@ -1,40 +0,0 @@
-/* eslint global-require: 0 */
-/* eslint import/no-dynamic-require: 0 */
-
-const webpackMerge = require("webpack-merge")
-const { resolve } = require("path")
-const { existsSync } = require("fs")
-const baseConfig = require("./environments/base")
-const rules = require("./rules")
-const config = require("./config")
-const devServer = require("./dev_server")
-const env = require("./env")
-const { moduleExists, canProcess } = require("./utils/helpers")
-const inliningCss = require("./utils/inliningCss")
-
-const generateWebpackConfig = (extraConfig = {}, ...extraArgs) => {
-  if (extraArgs.length > 0) {
-    throw new Error(
-      "Only one extra config may be passed here - use webpack-merge to merge configs before passing them to Shakapacker"
-    )
-  }
-
-  const { nodeEnv } = env
-  const path = resolve(__dirname, "environments", `${nodeEnv}.js`)
-  const environmentConfig = existsSync(path) ? require(path) : baseConfig
-
-  return webpackMerge.merge({}, environmentConfig, extraConfig)
-}
-
-module.exports = {
-  config, // shakapacker.yml
-  devServer,
-  generateWebpackConfig,
-  baseConfig,
-  env,
-  rules,
-  moduleExists,
-  canProcess,
-  inliningCss,
-  ...webpackMerge
-}

data/package/rules/css.js

@@ -1,3 +0,0 @@
-const getStyleRule = require("../utils/getStyleRule")
-
-module.exports = getStyleRule(/\.(css)$/i)

data/package/rules/esbuild.js

@@ -1,10 +0,0 @@
-const { loaderMatches } = require("../utils/helpers")
-const { getEsbuildLoaderConfig } = require("../esbuild")
-const { webpack_loader: webpackLoader } = require("../config")
-const jscommon = require("./jscommon")
-
-module.exports = loaderMatches(webpackLoader, "esbuild", () => ({
-  test: /\.(ts|tsx|js|jsx|mjs|coffee)?(\.erb)?$/,
-  ...jscommon,
-  use: ({ resource }) => getEsbuildLoaderConfig(resource)
-}))