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

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

@@ -22,7 +22,6 @@ declare module 'shakapacker' {
     publicPath: string
     publicPathWithoutCDN: string
     manifestPath: string
-    includePaths: string[]
   }
 
   export interface Env {
@@ -36,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/master/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,21 +1,28 @@
-const { dirname } = require('path')
-const { includePaths } = 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 path = dirname(pathData.filename)
-      const selectedIncludePath = includePaths.find((includePath) => path.includes(includePath))
+      const stripPaths = [...additionalPaths, sourcePath]
+
+      const selectedStripPath = stripPaths.find((includePath) =>
+        path.startsWith(includePath)
+      )
 
       const folders = path
-        .replace(`${selectedIncludePath}`, '')
-        .split('/')
+        .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,8 +1,11 @@
-const { resolve } = require('path')
-const { realpathSync } = require('fs')
-const { includePaths } = require('../config')
+const { resolve } = require("path")
+const { realpathSync } = require("fs")
+const {
+  source_path: sourcePath,
+  additional_paths: additionalPaths
+} = require("../config")
 
-const inclusions = includePaths.map(p => {
+const inclusions = [sourcePath, ...additionalPaths].map((p) => {
   try {
     return realpathSync(p)
   } catch (e) {
@@ -15,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,18 +1,19 @@
-const path = require('path')
-const { canProcess } = require('../utils/helpers')
-const getStyleRule = require('../utils/get_style_rule')
-const { includePaths } = require('../config')
+const path = require("path")
+const { canProcess } = require("../utils/helpers")
+const getStyleRule = require("../utils/getStyleRule")
 
-module.exports = canProcess('less-loader', (resolvedPath) =>
+const {
+  additional_paths: paths,
+  source_path: sourcePath
+} = require("../config")
+
+module.exports = canProcess("less-loader", (resolvedPath) =>
   getStyleRule(/\.(less)(\.erb)?$/i, [
     {
       loader: resolvedPath,
       options: {
         lessOptions: {
-          paths: [
-            path.resolve(__dirname, 'node_modules'),
-            ...includePaths
-          ]
+          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,

data/package/rules/stylus.js

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

data/package/rules/swc.js

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

data/package/swc/index.js

@@ -1,16 +1,16 @@
 /* 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 isJsxFile = (filename) => !!filename.match(/\.(jsx|tsx)?(\.erb)?$/)
 
 const isTypescriptFile = (filename) => !!filename.match(/\.(ts|tsx)?(\.erb)?$/)
 
 const getCustomConfig = () => {
-  const path = resolve('config', 'swc.config.js')
+  const path = resolve("config", "swc.config.js")
   if (existsSync(path)) {
     return require(path)
   }
@@ -20,15 +20,15 @@ const getCustomConfig = () => {
 const getSwcLoaderConfig = (filenameToProcess) => {
   const customConfig = getCustomConfig()
   const defaultConfig = {
-    loader: require.resolve('swc-loader'),
+    loader: require.resolve("swc-loader"),
     options: {
       jsc: {
         parser: {
           dynamicImport: true,
           syntax: isTypescriptFile(filenameToProcess)
-            ? 'typescript'
-            : 'ecmascript',
-          [isTypescriptFile(filenameToProcess) ? 'tsx' : 'jsx']:
+            ? "typescript"
+            : "ecmascript",
+          [isTypescriptFile(filenameToProcess) ? "tsx" : "jsx"]:
             isJsxFile(filenameToProcess)
         },
         loose: true
@@ -36,8 +36,8 @@ const getSwcLoaderConfig = (filenameToProcess) => {
       sourceMaps: true,
       env: {
         coreJs: 3,
-        exclude: ['transform-typeof-symbol'],
-        mode: 'entry'
+        exclude: ["transform-typeof-symbol"],
+        mode: "entry"
       }
     }
   }

data/package/utils/configPath.js

@@ -1,19 +1,4 @@
-const fs = require('fs')
-const { resolve } = require('path')
-const { setShakapackerEnvVariablesForBackwardCompatibility } = require('./helpers')
+const { resolve } = require("path")
 
-setShakapackerEnvVariablesForBackwardCompatibility()
-
-// For backward compatibility
-const resolveToPhysicalFilePath = () => {
-  const shakapackerConfigPath = resolve('config', 'shakapacker.yml')
-  const webpackerConfigPath = resolve('config', 'webpacker.yml')
-
-  if (fs.existsSync(shakapackerConfigPath)) return shakapackerConfigPath
-  if (fs.existsSync(webpackerConfigPath)) return webpackerConfigPath
-
-  // If neither of files exist, try to resolve to shakapacker.yml to get more relevant error
-  return shakapackerConfigPath
-}
-
-module.exports = process.env.SHAKAPACKER_CONFIG || resolveToPhysicalFilePath()
+module.exports =
+  process.env.SHAKAPACKER_CONFIG || resolve("config", "shakapacker.yml")

data/package/utils/defaultConfigPath.js

@@ -1,2 +1,2 @@
-const path = require.resolve('../../lib/install/config/shakapacker.yml')
+const path = require.resolve("../../lib/install/config/shakapacker.yml")
 module.exports = path

data/package/utils/{get_style_rule.js → getStyleRule.js}

@@ -1,11 +1,11 @@
 /* eslint global-require: 0 */
-const { canProcess, moduleExists } = require('./helpers')
-const inliningCss = require('./inliningCss')
+const { canProcess, moduleExists } = require("./helpers")
+const inliningCss = require("./inliningCss")
 
 const getStyleRule = (test, preprocessors = []) => {
-  if (moduleExists('css-loader')) {
+  if (moduleExists("css-loader")) {
     const tryPostcss = () =>
-      canProcess('postcss-loader', (loaderPath) => ({
+      canProcess("postcss-loader", (loaderPath) => ({
         loader: loaderPath,
         options: { sourceMap: true }
       }))
@@ -13,9 +13,9 @@ const getStyleRule = (test, preprocessors = []) => {
     // style-loader is required when using css modules with HMR on the webpack-dev-server
 
     const use = [
-      inliningCss ? 'style-loader' : require('mini-css-extract-plugin').loader,
+      inliningCss ? "style-loader" : require("mini-css-extract-plugin").loader,
       {
-        loader: require.resolve('css-loader'),
+        loader: require.resolve("css-loader"),
         options: {
           sourceMap: true,
           importLoaders: 2,

data/package/utils/helpers.js

@@ -1,35 +1,12 @@
-const isArray = (value) => Array.isArray(value)
 const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
-const chdirTestApp = () => {
-  try {
-    return process.chdir('spec/shakapacker/test_app')
-  } catch (e) {
-    return null
-  }
-}
 
-// For backward compatibility
-const chdirWebpackerTestApp = () => {
-  try {
-    return process.chdir('spec/backward_compatibility_specs/webpacker_test_app')
-  } catch (e) {
-    return null
-  }
-}
-
-const chdirCwd = () => process.chdir(process.cwd())
-
-const resetEnv = () => {
-  process.env = {}
-}
-
-const ensureTrailingSlash = (path) => (path.endsWith('/') ? path : `${path}/`)
+const ensureTrailingSlash = (path) => (path.endsWith("/") ? path : `${path}/`)
 
 const resolvedPath = (packageName) => {
   try {
     return require.resolve(packageName)
   } catch (e) {
-    if (e.code !== 'MODULE_NOT_FOUND') {
+    if (e.code !== "MODULE_NOT_FOUND") {
       throw e
     }
     return null
@@ -64,28 +41,10 @@ const loaderMatches = (configLoader, loaderToCheck, fn) => {
   return fn()
 }
 
-// For backward compatibility
-// Set SHAKAPACKER_XYZ only if SHAKAPACKER_XYZ is not defined but WEBPACKER_XYZ is.
-const setShakapackerEnvVariablesForBackwardCompatibility = () => {
-  const webpackerEnvVariables = Object.entries(process.env).filter((key) => /^WEBPACKER_/.test(key))
-  webpackerEnvVariables.forEach(([webpackerEnvKey, webpackerEnvValue]) => {
-    const shakapackerKey = webpackerEnvKey.replace(/^WEBPACKER/, 'SHAKAPACKER')
-    if (!process.env[shakapackerKey]) {
-      process.env[shakapackerKey] = webpackerEnvValue
-    }
-  })
-}
-
 module.exports = {
-  chdirTestApp,
-  chdirWebpackerTestApp,
-  setShakapackerEnvVariablesForBackwardCompatibility,
-  chdirCwd,
-  isArray,
   isBoolean,
   ensureTrailingSlash,
   canProcess,
   moduleExists,
-  resetEnv,
   loaderMatches
 }

data/package/utils/inliningCss.js

@@ -1,7 +1,8 @@
-const { runningWebpackDevServer } = require('../env')
-const devServer = require('../dev_server')
+const { runningWebpackDevServer } = require("../env")
+const devServer = require("../dev_server")
 
 // This logic is tied to lib/shakapacker/instance.rb
-const inliningCss = runningWebpackDevServer && devServer.hmr && devServer.inline_css !== false
+const inliningCss =
+  runningWebpackDevServer && devServer.hmr && devServer.inline_css !== false
 
 module.exports = inliningCss

data/package/utils/snakeToCamelCase.js

@@ -0,0 +1,5 @@
+function snakeToCamelCase(s) {
+  return s.replace(/(_\w)/g, (match) => match[1].toUpperCase())
+}
+
+module.exports = snakeToCamelCase