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

data/lib/shakapacker/version_checker.rb

@@ -17,41 +17,19 @@ module Shakapacker
 
     def raise_if_gem_and_node_package_versions_differ
       # Skip check if package is not in package.json or listed from relative path, git repo or github URL
-      return if node_package_version.skip_processing?
+      # or if consistent version checking is not enabled
+      return if node_package_version.skip_processing? || !Shakapacker.config.ensure_consistent_versioning?
 
       node_major_minor_patch = node_package_version.major_minor_patch
       gem_major_minor_patch = gem_major_minor_patch_version
-      versions_match = node_major_minor_patch[0] == gem_major_minor_patch[0] &&
-                       node_major_minor_patch[1] == gem_major_minor_patch[1] &&
-                       node_major_minor_patch[2] == gem_major_minor_patch[2]
 
-      uses_wildcard = node_package_version.semver_wildcard?
+      raise_differing_versions_warning unless (
+        node_major_minor_patch[0] == gem_major_minor_patch[0] &&
+        node_major_minor_patch[1] == gem_major_minor_patch[1] &&
+        node_major_minor_patch[2] == gem_major_minor_patch[2]
+      )
 
-      if !Shakapacker.config.ensure_consistent_versioning? && (uses_wildcard || !versions_match)
-        check_failed = if uses_wildcard
-          "Semver wildcard without a lockfile detected"
-        else
-          "Version mismatch detected"
-        end
-
-        warn <<-MSG.strip_heredoc
-          Shakapacker::VersionChecker - #{check_failed}
-
-          You are currently not checking for consistent versions of shakapacker gem and npm package. A version mismatch or usage of semantic versioning wildcard (~ or ^) without a lockfile has been detected.
-
-          Version mismatch can lead to incorrect behavior and bugs. You should ensure that both the gem and npm package dependencies are locked to the same version.
-
-          You can enable the version check by setting `ensure_consistent_versioning: true` in your `shakapacker.yml` file.
-
-          Checking for gem and npm package versions mismatch or wildcard will be enabled by default in the next major version of shakapacker.
-        MSG
-
-        return
-      end
-
-      raise_differing_versions_warning unless versions_match
-
-      raise_node_semver_version_warning if uses_wildcard
+      raise_node_semver_version_warning if node_package_version.semver_wildcard?
     end
 
     private
@@ -87,6 +65,7 @@ module Shakapacker
         [match[1], match[2], match[3]]
       end
 
+      # TODO: this might as well use package_json
       class NodePackageVersion
         attr_reader :package_json
 

data/lib/shakapacker/webpack_runner.rb

@@ -23,16 +23,7 @@ module Shakapacker
 
       cmd = build_cmd
 
-      if @argv.include?("--debug-webpacker")
-        Shakapacker.puts_deprecation_message(
-          Shakapacker.short_deprecation_message(
-            "--debug-webpacker",
-            "--debug-shakapacker"
-          )
-        )
-      end
-
-      if @argv.delete("--debug-shakapacker") || @argv.delete("--debug-webpacker")
+      if @argv.delete("--debug-shakapacker")
         env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk"
       end
 
@@ -59,17 +50,7 @@ module Shakapacker
     private
 
       def build_cmd
-        if Shakapacker::Utils::Misc.use_package_json_gem
-          return package_json.manager.native_exec_command("webpack")
-        end
-
-        return ["#{@node_modules_bin_path}/webpack"] if node_modules_bin_exist?
-
-        ["yarn", "webpack"]
-      end
-
-      def node_modules_bin_exist?
-        File.exist?("#{@node_modules_bin_path}/webpack")
+        package_json.manager.native_exec_command("webpack")
       end
   end
 end

data/lib/shakapacker.rb

@@ -47,5 +47,3 @@ require "shakapacker/dev_server"
 require "shakapacker/deprecation_helper"
 
 require "shakapacker/railtie" if defined?(Rails)
-
-Webpacker = Shakapacker

data/lib/tasks/shakapacker/check_binstubs.rake

@@ -1,34 +1,20 @@
 namespace :shakapacker do
   desc "Verifies that bin/shakapacker is present"
   task :check_binstubs do
-    verify_file_existence("bin/shakapacker", "bin/webpacker")
-    verify_file_existence("bin/shakapacker-dev-server", "bin/webpacker-dev-server")
+    verify_file_existence("bin/shakapacker")
+    verify_file_existence("bin/shakapacker-dev-server")
   end
 end
 
-def verify_file_existance(main_file, alternative_file)
-  puts "verify_file_existance is deprecated - use verify_file_existence instead"
-  verify_file_existence(main_file, alternative_file)
-end
-
-def verify_file_existence(main_file, alternative_file)
-  unless File.exist?(Rails.root.join(main_file))
-    if File.exist?(Rails.root.join(alternative_file))
-      Shakapacker.puts_deprecation_message(
-        Shakapacker.short_deprecation_message(
-          alternative_file,
-          main_file
-        )
-      )
-    else
-      puts <<~MSG
-        Couldn't find shakapacker binstubs!
-        Possible solutions:
-        - Ensure you have run `rails shakapacker:install`.
-        - Run `rails shakapacker:binstubs` if you have already installed shakapacker.
-        - Ensure the `bin` directory, `bin/shakapacker`, and `bin/shakapacker-dev-server` are not included in .gitignore.
-      MSG
-      exit!
-    end
+def verify_file_existence(binstub_file)
+  unless File.exist?(Rails.root.join(binstub_file))
+    puts <<~MSG
+      Couldn't find shakapacker binstubs!
+      Possible solutions:
+      - Ensure you have run `rails shakapacker:install`.
+      - Run `rails shakapacker:binstubs` if you have already installed shakapacker.
+      - Ensure the `bin` directory, `bin/shakapacker`, and `bin/shakapacker-dev-server` are not included in .gitignore.
+    MSG
+    exit!
   end
 end

data/lib/tasks/shakapacker/check_manager.rake

@@ -1,15 +1,10 @@
 require "shakapacker/utils/misc"
+require "shakapacker/utils/manager"
 
 namespace :shakapacker do
   desc "Verifies if the expected JS package manager is installed"
-  task :check_manager do |task|
-    unless Shakapacker::Utils::Misc.use_package_json_gem
-      prefix = task.name.split(/#|shakapacker:/).first
-      Rake::Task["#{prefix}shakapacker:check_manager"].invoke
-      next
-    end
-
-    require "package_json"
+  task :check_manager do
+    Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
 
     package_json = PackageJson.read
     pm = package_json.manager.binary

data/lib/tasks/shakapacker/info.rake

@@ -1,5 +1,6 @@
 require "shakapacker/version"
 require "shakapacker/utils/misc"
+require "shakapacker/utils/manager"
 
 namespace :shakapacker do
   desc "Provide information on Shakapacker's environment"
@@ -9,30 +10,20 @@ namespace :shakapacker do
       $stdout.puts "Rails: #{Rails.version}"
       $stdout.puts "Shakapacker: #{Shakapacker::VERSION}"
       $stdout.puts "Node: #{`node --version`}"
-      if Shakapacker::Utils::Misc.use_package_json_gem
-        require "package_json"
 
-        pj_manager = PackageJson.read.manager
+      Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
 
-        $stdout.puts "#{pj_manager.binary}: #{pj_manager.version}"
-      else
-        $stdout.puts "Yarn: #{`yarn --version`}"
-      end
+      pj_manager = PackageJson.read.manager
 
-      if Shakapacker::Utils::Misc.use_package_json_gem
-        node_package_version = Shakapacker::VersionChecker.build.node_package_version.raw
-      else
-        node_package_version = `npm list shakapacker version`
-      end
+      $stdout.puts "#{pj_manager.binary}: #{pj_manager.version}"
+
+      node_package_version = Shakapacker::VersionChecker.build.node_package_version.raw
 
       $stdout.puts "\n"
       $stdout.puts "shakapacker: #{node_package_version}"
 
       $stdout.puts "Is bin/shakapacker present?: #{File.exist? 'bin/shakapacker'}"
       $stdout.puts "Is bin/shakapacker-dev-server present?: #{File.exist? 'bin/shakapacker-dev-server'}"
-      unless Shakapacker::Utils::Misc.use_package_json_gem
-        $stdout.puts "Is bin/yarn present?: #{File.exist? 'bin/yarn'}"
-      end
     end
   end
 end

data/package/babel/preset.js

@@ -1,11 +1,11 @@
-const { moduleExists } = require('shakapacker')
+const { moduleExists } = require("shakapacker")
 
 module.exports = function config(api) {
-  const validEnv = ['development', 'test', 'production']
+  const validEnv = ["development", "test", "production"]
   const currentEnv = api.env()
-  const isDevelopmentEnv = api.env('development')
-  const isProductionEnv = api.env('production')
-  const isTestEnv = api.env('test')
+  const isDevelopmentEnv = api.env("development")
+  const isProductionEnv = api.env("production")
+  const isTestEnv = api.env("test")
 
   if (!validEnv.includes(currentEnv)) {
     throw new Error(
@@ -17,21 +17,21 @@ module.exports = function config(api) {
 
   return {
     presets: [
-      isTestEnv && ['@babel/preset-env', { targets: { node: 'current' } }],
+      isTestEnv && ["@babel/preset-env", { targets: { node: "current" } }],
       (isProductionEnv || isDevelopmentEnv) && [
-        '@babel/preset-env',
+        "@babel/preset-env",
         {
-          useBuiltIns: 'entry',
-          corejs: '3.8',
-          modules: 'auto',
+          useBuiltIns: "entry",
+          corejs: "3.8",
+          modules: "auto",
           bugfixes: true,
-          exclude: ['transform-typeof-symbol']
+          exclude: ["transform-typeof-symbol"]
         }
       ],
-      moduleExists('@babel/preset-typescript') && '@babel/preset-typescript'
+      moduleExists("@babel/preset-typescript") && "@babel/preset-typescript"
     ].filter(Boolean),
-    plugins: [
-      ['@babel/plugin-transform-runtime', { helpers: false }]
-    ].filter(Boolean)
+    plugins: [["@babel/plugin-transform-runtime", { helpers: false }]].filter(
+      Boolean
+    )
   }
 }

data/package/config.js

@@ -1,19 +1,16 @@
-const { resolve } = require('path')
-const { load } = require('js-yaml')
-const { existsSync, readFileSync } = require('fs')
+const { resolve } = require("path")
+const { load } = require("js-yaml")
+const { existsSync, readFileSync } = require("fs")
 
-const { merge } = require('webpack-merge')
-const {
-  ensureTrailingSlash,
-  setShakapackerEnvVariablesForBackwardCompatibility
-} = require('./utils/helpers')
-const { railsEnv } = require('./env')
-const configPath = require('./utils/configPath')
+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 defaultConfigPath = require("./utils/defaultConfigPath")
 
 const getDefaultConfig = () => {
-  const defaultConfig = load(readFileSync(defaultConfigPath), 'utf8')
+  const defaultConfig = load(readFileSync(defaultConfigPath), "utf8")
   return defaultConfig[railsEnv] || defaultConfig.production
 }
 
@@ -21,12 +18,14 @@ const defaults = getDefaultConfig()
 let config
 
 if (existsSync(configPath)) {
-  const appYmlObject = load(readFileSync(configPath), 'utf8')
+  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.`)
+    console.warn(
+      `Warning: ${railsEnv} key not found in the configuration file. Using production configuration as a fallback.`
+    )
   }
 
   config = merge(defaults, envAppConfig || {})
@@ -39,8 +38,7 @@ 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 = () => {
-  setShakapackerEnvVariablesForBackwardCompatibility()
-  const rootUrl = ensureTrailingSlash(process.env.SHAKAPACKER_ASSET_HOST || '/')
+  const rootUrl = ensureTrailingSlash(process.env.SHAKAPACKER_ASSET_HOST || "/")
   return `${rootUrl}${config.public_output_path}/`
 }
 
@@ -50,9 +48,7 @@ config.publicPathWithoutCDN = `/${config.public_output_path}/`
 if (config.manifest_path) {
   config.manifestPath = resolve(config.manifest_path)
 } else {
-  config.manifestPath = resolve(config.outputPath, 'manifest.json')
+  config.manifestPath = resolve(config.outputPath, "manifest.json")
 }
 
-config.includePaths = [config.source_path, ...config.additional_paths]
-
 module.exports = config

data/package/dev_server.js

@@ -1,6 +1,6 @@
-// These are the raw webpacker dev server config settings from the YML file with ENV overrides applied.
-const { isBoolean } = require('./utils/helpers')
-const config = require('./config')
+// These are the raw shakapacker dev server config settings from the YML file with ENV overrides applied.
+const { isBoolean } = require("./utils/helpers")
+const config = require("./config")
 
 const envFetch = (key) => {
   const value = process.env[key]
@@ -10,7 +10,7 @@ const envFetch = (key) => {
 const devServerConfig = config.dev_server
 
 if (devServerConfig) {
-  const envPrefix = config.dev_server.env_prefix || 'SHAKAPACKER_DEV_SERVER'
+  const envPrefix = config.dev_server.env_prefix || "SHAKAPACKER_DEV_SERVER"
 
   Object.keys(devServerConfig).forEach((key) => {
     const envValue = envFetch(`${envPrefix}_${key.toUpperCase()}`)

data/package/env.js

@@ -1,40 +1,42 @@
-const { load } = require('js-yaml')
-const { readFileSync } = require('fs')
-const defaultConfigPath = require('./utils/defaultConfigPath')
+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 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'
+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')
+  config = load(readFileSync(configPath), "utf8")
 } catch (error) {
-  if (error.code === 'ENOENT') {
+  if (error.code === "ENOENT") {
     // File not found, use default configuration
-    config = load(readFileSync(defaultConfigPath), 'utf8')
+    config = load(readFileSync(defaultConfigPath), "utf8")
   } else {
     throw error
   }
 }
 
-const availableEnvironments = Object.keys(config).join('|')
-const regex = new RegExp(`^(${availableEnvironments})$`, 'g')
+const availableEnvironments = Object.keys(config).join("|")
+const regex = new RegExp(`^(${availableEnvironments})$`, "g")
 
-const runningWebpackDevServer = process.env.WEBPACK_SERVE === 'true'
+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.`)
+  console.warn(
+    `Warning: '${railsEnv}' environment not found in the configuration. Using '${DEFAULT}' configuration as a fallback.`
+  )
 }
 
 module.exports = {

data/package/environments/base.js

@@ -1,28 +1,45 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const { basename, dirname, join, relative, resolve } = require('path')
-const extname = require('path-complete-extname')
-const { sync: globSync } = require('glob')
-const WebpackAssetsManifest = require('webpack-assets-manifest')
-const webpack = require('webpack')
-const rules = require('../rules')
-const config = require('../config')
-const { isProduction } = require('../env')
-const { moduleExists } = require('../utils/helpers')
+const { existsSync, readdirSync } = require("fs")
+const { basename, dirname, join, relative, resolve } = require("path")
+const extname = require("path-complete-extname")
+const WebpackAssetsManifest = require("webpack-assets-manifest")
+const webpack = require("webpack")
+const rules = require("../rules")
+const config = require("../config")
+const { isProduction } = require("../env")
+const { moduleExists } = require("../utils/helpers")
+
+const getFilesInDirectory = (dir, includeNested) => {
+  if (!existsSync(dir)) {
+    return []
+  }
+
+  return readdirSync(dir, { withFileTypes: true }).flatMap((dirent) => {
+    const filePath = join(dir, dirent.name)
+
+    if (dirent.isDirectory() && includeNested) {
+      return getFilesInDirectory(filePath, includeNested)
+    }
+    if (dirent.isFile()) {
+      return filePath
+    }
+    return []
+  })
+}
 
 const getEntryObject = () => {
   const entries = {}
   const rootPath = join(config.source_path, config.source_entry_path)
-  if (config.source_entry_path === '/' && config.nested_entries) {
+  if (config.source_entry_path === "/" && config.nested_entries) {
     throw new Error(
       "Your shakapacker config specified using a source_entry_path of '/' with 'nested_entries' == " +
-      "'true'. Doing this would result in packs for every one of your source files"
+        "'true'. Doing this would result in packs for every one of your source files"
     )
   }
-  const nesting = config.nested_entries ? '**/' : ''
 
-  globSync(`${rootPath}/${nesting}*.*`).forEach((path) => {
+  getFilesInDirectory(rootPath, config.nested_entries).forEach((path) => {
     const namespace = relative(join(rootPath), dirname(path))
     const name = join(namespace, basename(path, extname(path)))
     let assetPaths = resolve(path)
@@ -50,7 +67,7 @@ const getModulePaths = () => {
   if (config.additional_paths) {
     config.additional_paths.forEach((path) => result.push(resolve(path)))
   }
-  result.push('node_modules')
+  result.push("node_modules")
 
   return result
 }
@@ -67,9 +84,9 @@ const getPlugins = () => {
     })
   ]
 
-  if (moduleExists('css-loader') && moduleExists('mini-css-extract-plugin')) {
-    const hash = isProduction || config.useContentHash ? '-[contenthash:8]' : ''
-    const MiniCssExtractPlugin = require('mini-css-extract-plugin')
+  if (moduleExists("css-loader") && moduleExists("mini-css-extract-plugin")) {
+    const hash = isProduction || config.useContentHash ? "-[contenthash:8]" : ""
+    const MiniCssExtractPlugin = require("mini-css-extract-plugin")
     plugins.push(
       new MiniCssExtractPlugin({
         filename: `css/[name]${hash}.css`,
@@ -87,35 +104,35 @@ const getPlugins = () => {
 
 // Don't use contentHash except for production for performance
 // https://webpack.js.org/guides/build-performance/#avoid-production-specific-tooling
-const hash = isProduction || config.useContentHash ? '-[contenthash]' : ''
+const hash = isProduction || config.useContentHash ? "-[contenthash]" : ""
 
 module.exports = {
-  mode: 'production',
+  mode: "production",
   output: {
     filename: `js/[name]${hash}.js`,
     chunkFilename: `js/[name]${hash}.chunk.js`,
 
     // https://webpack.js.org/configuration/output/#outputhotupdatechunkfilename
-    hotUpdateChunkFilename: 'js/[id].[fullhash].hot-update.js',
+    hotUpdateChunkFilename: "js/[id].[fullhash].hot-update.js",
     path: config.outputPath,
     publicPath: config.publicPath
   },
   entry: getEntryObject(),
   resolve: {
-    extensions: ['.js', '.jsx', '.mjs', '.ts', '.tsx', '.coffee'],
+    extensions: [".js", ".jsx", ".mjs", ".ts", ".tsx", ".coffee"],
     modules: getModulePaths()
   },
 
   plugins: getPlugins(),
 
   resolveLoader: {
-    modules: ['node_modules']
+    modules: ["node_modules"]
   },
 
   optimization: {
-    splitChunks: { chunks: 'all' },
+    splitChunks: { chunks: "all" },
 
-    runtimeChunk: 'single'
+    runtimeChunk: "single"
   },
 
   module: {

data/package/environments/development.js

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

data/package/environments/production.js

@@ -1,29 +1,29 @@
 /* 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 { 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',
+      filename: "[path][base].gz[query]",
+      algorithm: "gzip",
       test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
     })
   )
 
-  if ('brotli' in process.versions) {
+  if ("brotli" in process.versions) {
     plugins.push(
       new CompressionPlugin({
-        filename: '[path][base].br[query]',
-        algorithm: 'brotliCompress',
+        filename: "[path][base].br[query]",
+        algorithm: "brotliCompress",
         test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
       })
     )
@@ -34,10 +34,10 @@ const getPlugins = () => {
 
 const tryCssMinimizer = () => {
   if (
-    moduleExists('css-loader') &&
-    moduleExists('css-minimizer-webpack-plugin')
+    moduleExists("css-loader") &&
+    moduleExists("css-minimizer-webpack-plugin")
   ) {
-    const CssMinimizerPlugin = require('css-minimizer-webpack-plugin')
+    const CssMinimizerPlugin = require("css-minimizer-webpack-plugin")
     return new CssMinimizerPlugin()
   }
 
@@ -45,8 +45,8 @@ const tryCssMinimizer = () => {
 }
 
 const productionConfig = {
-  devtool: 'source-map',
-  stats: 'normal',
+  devtool: "source-map",
+  stats: "normal",
   bail: true,
   plugins: getPlugins(),
   optimization: {

data/package/environments/test.js

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