shakapacker 7.2.3 → 8.0.0.pre.rc.1

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

data/package/esbuild/index.js

@@ -1,22 +1,22 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const { resolve } = require('path')
-const { existsSync } = require('fs')
-const { merge } = require('webpack-merge')
+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 "js"
   }
 
   return matchData[1]
 }
 
 const getCustomConfig = () => {
-  const path = resolve('config', 'esbuild.config.js')
+  const path = resolve("config", "esbuild.config.js")
   if (existsSync(path)) {
     return require(path)
   }
@@ -26,7 +26,7 @@ const getCustomConfig = () => {
 const getEsbuildLoaderConfig = (filenameToProcess) => {
   const customConfig = getCustomConfig()
   const defaultConfig = {
-    loader: require.resolve('esbuild-loader'),
+    loader: require.resolve("esbuild-loader"),
     options: {
       loader: getLoaderExtension(filenameToProcess)
     }

data/package/index.d.ts

@@ -35,7 +35,6 @@ declare module 'shakapacker' {
   export const config: Config
   export const devServer: Record<string, unknown>
   export function generateWebpackConfig(extraConfig?: Configuration): Configuration
-  export const globalMutableWebpackConfig: Configuration
   export const baseConfig: Configuration
   export const env: Env
   export const rules: Record<string, unknown>

data/package/index.js

@@ -1,41 +1,35 @@
 /* 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 globalMutableWebpackConfig = () => {
-  const { nodeEnv } = env
-  const path = resolve(__dirname, 'environments', `${nodeEnv}.js`)
-  const environmentConfig = existsSync(path) ? require(path) : baseConfig
-  return environmentConfig
-}
+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'
+      "Only one extra config may be passed here - use webpack-merge to merge configs before passing them to Shakapacker"
     )
   }
 
-  const environmentConfig = globalMutableWebpackConfig()
-  const immutable = webpackMerge.merge({}, environmentConfig, extraConfig)
-  return immutable
+  const { nodeEnv } = env
+  const path = resolve(__dirname, "environments", `${nodeEnv}.js`)
+  const environmentConfig = existsSync(path) ? require(path) : baseConfig
+
+  return webpackMerge.merge({}, environmentConfig, extraConfig)
 }
 
-const shakapackerObject = {
+module.exports = {
   config, // shakapacker.yml
   devServer,
   generateWebpackConfig,
-  globalMutableWebpackConfig: globalMutableWebpackConfig(),
   baseConfig,
   env,
   rules,
@@ -44,26 +38,3 @@ const shakapackerObject = {
   inliningCss,
   ...webpackMerge
 }
-
-// For backward compatibility
-const shakapackerProxyHandler = {
-  get(target, prop) {
-    if (prop === 'webpackConfig') {
-      // eslint-disable-next-line no-console
-      console.warn(`⚠️
-DEPRECATION NOTICE:
-The 'webpackConfig' is deprecated and will be removed in a future version.
-Please use 'globalMutableWebpackConfig' instead, or use
-'generateWebpackConfig()' to avoid unwanted config mutation across the app.
-
-For more information, see version 7 upgrade documentation at:
-https://github.com/shakacode/shakapacker/blob/main/docs/v7_upgrade.md
-`)
-      return globalMutableWebpackConfig()
-    }
-
-    return target[prop]
-  }
-}
-
-module.exports = new Proxy(shakapackerObject, shakapackerProxyHandler)

data/package/rules/babel.js

@@ -1,16 +1,14 @@
-const { loaderMatches } = require('../utils/helpers')
-const {
-  webpack_loader: webpackLoader
-} = require('../config')
-const { isProduction } = require('../env')
-const jscommon = require('./jscommon')
+const { loaderMatches } = require("../utils/helpers")
+const { webpack_loader: webpackLoader } = require("../config")
+const { isProduction } = require("../env")
+const jscommon = require("./jscommon")
 
-module.exports = loaderMatches(webpackLoader, 'babel', () => ({
+module.exports = loaderMatches(webpackLoader, "babel", () => ({
   test: /\.(js|jsx|mjs|ts|tsx|coffee)?(\.erb)?$/,
   ...jscommon,
   use: [
     {
-      loader: require.resolve('babel-loader'),
+      loader: require.resolve("babel-loader"),
       options: {
         cacheDirectory: true,
         cacheCompression: isProduction,

data/package/rules/coffee.js

@@ -1,6 +1,6 @@
-const { canProcess } = require('../utils/helpers')
+const { canProcess } = require("../utils/helpers")
 
-module.exports = canProcess('coffee-loader', (resolvedPath) => ({
+module.exports = canProcess("coffee-loader", (resolvedPath) => ({
   test: /\.coffee(\.erb)?$/,
   use: [{ loader: resolvedPath }]
 }))

data/package/rules/css.js

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

data/package/rules/erb.js

@@ -1,10 +1,10 @@
-const { canProcess } = require('../utils/helpers')
+const { canProcess } = require("../utils/helpers")
 
-const runner = /^win/.test(process.platform) ? 'ruby ' : ''
+const runner = /^win/.test(process.platform) ? "ruby " : ""
 
-module.exports = canProcess('rails-erb-loader', (resolvedPath) => ({
+module.exports = canProcess("rails-erb-loader", (resolvedPath) => ({
   test: /\.erb$/,
-  enforce: 'pre',
+  enforce: "pre",
   exclude: /node_modules/,
   use: [
     {

data/package/rules/esbuild.js

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

data/package/rules/file.js

@@ -1,18 +1,28 @@
-const { dirname } = require('path')
-const { source_path: sourcePath } = require('../config')
+const { dirname } = require("path")
+const {
+  additional_paths: additionalPaths,
+  source_path: sourcePath
+} = require("../config")
 
 module.exports = {
   test: /\.(bmp|gif|jpe?g|png|tiff|ico|avif|webp|eot|otf|ttf|woff|woff2|svg)$/,
   exclude: /\.(js|mjs|jsx|ts|tsx)$/,
-  type: 'asset/resource',
+  type: "asset/resource",
   generator: {
     filename: (pathData) => {
-      const folders = dirname(pathData.filename)
-        .replace(`${sourcePath}`, '')
-        .split('/')
+      const path = dirname(pathData.filename)
+      const stripPaths = [...additionalPaths, sourcePath]
+
+      const selectedStripPath = stripPaths.find((includePath) =>
+        path.startsWith(includePath)
+      )
+
+      const folders = path
+        .replace(`${selectedStripPath}`, "")
+        .split("/")
         .filter(Boolean)
 
-      const foldersWithStatic = ['static', ...folders].join('/')
+      const foldersWithStatic = ["static", ...folders].join("/")
       return `${foldersWithStatic}/[name]-[hash][ext][query]`
     }
   }

data/package/rules/index.js

@@ -2,17 +2,17 @@
 /* eslint import/no-dynamic-require: 0 */
 
 const rules = {
-  raw: require('./raw'),
-  file: require('./file'),
-  css: require('./css'),
-  sass: require('./sass'),
-  babel: require('./babel'),
-  swc: require('./swc'),
-  esbuild: require('./esbuild'),
-  erb: require('./erb'),
-  coffee: require('./coffee'),
-  less: require('./less'),
-  stylus: require('./stylus')
+  raw: require("./raw"),
+  file: require("./file"),
+  css: require("./css"),
+  sass: require("./sass"),
+  babel: require("./babel"),
+  swc: require("./swc"),
+  esbuild: require("./esbuild"),
+  erb: require("./erb"),
+  coffee: require("./coffee"),
+  less: require("./less"),
+  stylus: require("./stylus")
 }
 
 module.exports = Object.keys(rules)

data/package/rules/jscommon.js

@@ -1,11 +1,11 @@
-const { resolve } = require('path')
-const { realpathSync } = require('fs')
+const { resolve } = require("path")
+const { realpathSync } = require("fs")
 const {
   source_path: sourcePath,
   additional_paths: additionalPaths
-} = require('../config')
+} = require("../config")
 
-const inclusions = [sourcePath, ...additionalPaths].map(p => {
+const inclusions = [sourcePath, ...additionalPaths].map((p) => {
   try {
     return realpathSync(p)
   } catch (e) {
@@ -18,7 +18,7 @@ module.exports = {
   exclude: [
     {
       // exclude all node_modules from running through babel-loader
-      and: [resolve('node_modules')],
+      and: [resolve("node_modules")],
       // Do not exclude inclusions, as otherwise these won't be transpiled
       not: [...inclusions]
     }

data/package/rules/less.js

@@ -1,19 +1,19 @@
-const path = require('path')
-const { canProcess } = require('../utils/helpers')
-const getStyleRule = require('../utils/get_style_rule')
+const path = require("path")
+const { canProcess } = require("../utils/helpers")
+const getStyleRule = require("../utils/getStyleRule")
 
 const {
   additional_paths: paths,
   source_path: sourcePath
-} = require('../config')
+} = require("../config")
 
-module.exports = canProcess('less-loader', (resolvedPath) =>
+module.exports = canProcess("less-loader", (resolvedPath) =>
   getStyleRule(/\.(less)(\.erb)?$/i, [
     {
       loader: resolvedPath,
       options: {
         lessOptions: {
-          paths: [path.resolve(__dirname, 'node_modules'), sourcePath, ...paths]
+          paths: [path.resolve(__dirname, "node_modules"), sourcePath, ...paths]
         },
         sourceMap: true
       }

data/package/rules/raw.js

@@ -1,5 +1,5 @@
 module.exports = {
   test: /\.html$/,
   exclude: /\.(js|mjs|jsx|ts|tsx)$/,
-  type: 'asset/source'
+  type: "asset/source"
 }

data/package/rules/sass.js

@@ -1,10 +1,10 @@
 /* eslint global-require: 0 */
 
-const getStyleRule = require('../utils/get_style_rule')
-const { canProcess } = require('../utils/helpers')
-const { additional_paths: includePaths } = require('../config')
+const getStyleRule = require("../utils/getStyleRule")
+const { canProcess } = require("../utils/helpers")
+const { additional_paths: includePaths } = require("../config")
 
-module.exports = canProcess('sass-loader', (resolvedPath) =>
+module.exports = canProcess("sass-loader", (resolvedPath) =>
   getStyleRule(/\.(scss|sass)(\.erb)?$/i, [
     {
       loader: resolvedPath,