shakapacker 8.4.0 → 9.0.0

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)
-}))

data/package/rules/file.js

@@ -1,29 +0,0 @@
-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",
-  generator: {
-    filename: (pathData) => {
-      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("/")
-      return `${foldersWithStatic}/[name]-[hash][ext][query]`
-    }
-  }
-}

data/package/rules/raw.js

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

data/package/rules/swc.js

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

data/package/swc/index.js

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

data/package/utils/configPath.js

@@ -1,4 +0,0 @@
-const { resolve } = require("path")
-
-module.exports =
-  process.env.SHAKAPACKER_CONFIG || resolve("config", "shakapacker.yml")

data/package/utils/defaultConfigPath.js

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

data/package/utils/getStyleRule.js

@@ -1,40 +0,0 @@
-/* eslint global-require: 0 */
-const { canProcess, moduleExists } = require("./helpers")
-const inliningCss = require("./inliningCss")
-
-const getStyleRule = (test, preprocessors = []) => {
-  if (moduleExists("css-loader")) {
-    const tryPostcss = () =>
-      canProcess("postcss-loader", (loaderPath) => ({
-        loader: loaderPath,
-        options: { sourceMap: true }
-      }))
-
-    // 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,
-      {
-        loader: require.resolve("css-loader"),
-        options: {
-          sourceMap: true,
-          importLoaders: 2,
-          modules: {
-            auto: true
-          }
-        }
-      },
-      tryPostcss(),
-      ...preprocessors
-    ].filter(Boolean)
-
-    return {
-      test,
-      use
-    }
-  }
-
-  return null
-}
-
-module.exports = getStyleRule

data/package/utils/helpers.js

@@ -1,62 +0,0 @@
-const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
-
-const ensureTrailingSlash = (path) => (path.endsWith("/") ? path : `${path}/`)
-
-const resolvedPath = (packageName) => {
-  try {
-    return require.resolve(packageName)
-  } catch (e) {
-    if (e.code !== "MODULE_NOT_FOUND") {
-      throw e
-    }
-    return null
-  }
-}
-
-const moduleExists = (packageName) => !!resolvedPath(packageName)
-
-const canProcess = (rule, fn) => {
-  const modulePath = resolvedPath(rule)
-
-  if (modulePath) {
-    return fn(modulePath)
-  }
-
-  return null
-}
-
-const loaderMatches = (configLoader, loaderToCheck, fn) => {
-  if (configLoader !== loaderToCheck) {
-    return null
-  }
-
-  const loaderName = `${configLoader}-loader`
-
-  if (!moduleExists(loaderName)) {
-    throw new Error(
-      `Your Shakapacker config specified using ${configLoader}, but ${loaderName} package is not installed. Please install ${loaderName} first.`
-    )
-  }
-
-  return fn()
-}
-
-const packageFullVersion = (packageName) => {
-  // eslint-disable-next-line import/no-dynamic-require
-  const packageJsonPath = require.resolve(`${packageName}/package.json`)
-  // eslint-disable-next-line import/no-dynamic-require, global-require
-  return require(packageJsonPath).version
-}
-
-const packageMajorVersion = (packageName) =>
-  packageFullVersion(packageName).match(/^\d+/)[0]
-
-module.exports = {
-  isBoolean,
-  ensureTrailingSlash,
-  canProcess,
-  moduleExists,
-  loaderMatches,
-  packageFullVersion,
-  packageMajorVersion
-}

data/package/utils/snakeToCamelCase.js

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

data/package/webpackDevServerConfig.js

@@ -1,71 +0,0 @@
-const shakapackerDevServerYamlConfig = require("./dev_server")
-const snakeToCamelCase = require("./utils/snakeToCamelCase")
-const { outputPath: contentBase, publicPath } = require("./config")
-
-const webpackDevServerMappedKeys = new Set([
-  // client, server, liveReload, devMiddleware are handled separately
-  "allowedHosts",
-  "bonjour",
-  "compress",
-  "headers",
-  "historyApiFallback",
-  "host",
-  "hot",
-  "http2",
-  "https",
-  "ipc",
-  "magicHtml",
-  "onAfterSetupMiddleware",
-  "onBeforeSetupMiddleware",
-  "open",
-  "port",
-  "proxy",
-  "server",
-  "setupExitSignals",
-  "setupMiddlewares",
-  "watchFiles",
-  "webSocketServer"
-])
-
-function createDevServerConfig() {
-  const devServerYamlConfig = { ...shakapackerDevServerYamlConfig }
-  const liveReload =
-    devServerYamlConfig.live_reload !== undefined
-      ? devServerYamlConfig.live_reload
-      : !devServerYamlConfig.hmr
-  delete devServerYamlConfig.live_reload
-
-  const config = {
-    devMiddleware: {
-      publicPath
-    },
-    liveReload,
-    historyApiFallback: {
-      disableDotRule: true
-    },
-    static: {
-      publicPath: contentBase
-    }
-  }
-
-  if (devServerYamlConfig.static) {
-    config.static = { ...config.static, ...devServerYamlConfig.static }
-    delete devServerYamlConfig.static
-  }
-
-  if (devServerYamlConfig.client) {
-    config.client = devServerYamlConfig.client
-    delete devServerYamlConfig.client
-  }
-
-  Object.keys(devServerYamlConfig).forEach((yamlKey) => {
-    const camelYamlKey = snakeToCamelCase(yamlKey)
-    if (webpackDevServerMappedKeys.has(camelYamlKey)) {
-      config[camelYamlKey] = devServerYamlConfig[yamlKey]
-    }
-  })
-
-  return config
-}
-
-module.exports = createDevServerConfig

data/test/package/rules/index.test.js

@@ -1,16 +0,0 @@
-const rules = require("../../../package/rules/index")
-
-jest.mock("../../../package/utils/helpers", () => {
-  const original = jest.requireActual("../../../package/utils/helpers")
-  const moduleExists = () => false
-  return {
-    ...original,
-    moduleExists
-  }
-})
-
-describe("index", () => {
-  test("rule tests are regexes", () => {
-    rules.forEach((rule) => expect(rule.test instanceof RegExp).toBe(true))
-  })
-})