Strip additional_paths from the asset paths generated in the file.js rule

CHANGELOG.md

@@ -9,6 +9,9 @@ Changes since the last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+### Changed
+- Just like with the `source_path` the paths in `additional_paths` will now also be stripped from asset paths. [PR 403](https://github.com/shakacode/shakapacker/pull/403) by [paypro-leon](https://github.com/paypro-leon).
+
 ## [v7.2.1] - December 30, 2023
 
 ### Fixed

package/config.js

@@ -53,4 +53,6 @@ if (config.manifest_path) {
   config.manifestPath = resolve(config.outputPath, 'manifest.json')
 }
 
+config.includePaths = [config.source_path, ...config.additional_paths]
+
 module.exports = config

package/index.d.ts

@@ -22,6 +22,7 @@ declare module 'shakapacker' {
     publicPath: string
     publicPathWithoutCDN: string
     manifestPath: string
+    includePaths: string[]
   }
 
   export interface Env {

package/rules/__tests__/babel.js

@@ -12,7 +12,7 @@ jest.mock("../../config", () => {
   const original = jest.requireActual("../../config");
   return {
     ...original,
-    additional_paths: [...original.additional_paths, "node_modules/included"],
+    includePaths: [...original.includePaths, "node_modules/included"]
   };
 });
 

package/rules/__tests__/esbuild.js

@@ -13,7 +13,7 @@ jest.mock("../../config", () => {
   return {
     ...original,
     webpack_loader: "esbuild",
-    additional_paths: [...original.additional_paths, "node_modules/included"],
+    includePaths: [...original.includePaths, "node_modules/included"]
   };
 });
 

package/rules/__tests__/file.js

@@ -1,5 +1,13 @@
 const file = require('../file')
 
+jest.mock("../../config", () => {
+  const original = jest.requireActual("../../config");
+  return {
+    ...original,
+    includePaths: [...original.includePaths, 'app/assets']
+  };
+});
+
 describe('file', () => {
   test('test expected file types', () => {
     const types = [
@@ -59,4 +67,13 @@ describe('file', () => {
       'static/images/nested/deeply/[name]-[hash][ext][query]'
     );
   });
+
+  test('correct generated output path is returned for all include paths', () => {
+    const pathData = {
+      filename: 'app/assets/images/image.svg',
+    };
+    expect(file.generator.filename(pathData)).toEqual(
+      'static/images/[name]-[hash][ext][query]'
+    );
+  });
 })

package/rules/__tests__/swc.js

@@ -12,7 +12,7 @@ jest.mock("../../config", () => {
   return {
     ...original,
     webpack_loader: "swc",
-    additional_paths: [...original.additional_paths, "node_modules/included"],
+    includePaths: [...original.includePaths, "node_modules/included"],
   };
 });
 

package/rules/file.js

@@ -1,14 +1,17 @@
 const { dirname } = require('path')
-const { source_path: sourcePath } = require('../config')
+const { includePaths } = 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 folders = dirname(pathData.filename)
-        .replace(`${sourcePath}`, '')
+      const path = dirname(pathData.filename)
+      const selectedIncludePath = includePaths.find((includePath) => path.includes(includePath))
+
+      const folders = path
+        .replace(`${selectedIncludePath}`, '')
         .split('/')
         .filter(Boolean)
 

package/rules/jscommon.js

@@ -1,11 +1,8 @@
 const { resolve } = require('path')
 const { realpathSync } = require('fs')
-const {
-  source_path: sourcePath,
-  additional_paths: additionalPaths
-} = require('../config')
+const { includePaths } = require('../config')
 
-const inclusions = [sourcePath, ...additionalPaths].map(p => {
+const inclusions = includePaths.map(p => {
   try {
     return realpathSync(p)
   } catch (e) {

package/rules/less.js

@@ -1,19 +1,18 @@
 const path = require('path')
 const { canProcess } = require('../utils/helpers')
 const getStyleRule = require('../utils/get_style_rule')
-
-const {
-  additional_paths: paths,
-  source_path: sourcePath
-} = require('../config')
+const { includePaths } = require('../config')
 
 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'),
+            ...includePaths
+          ]
         },
         sourceMap: true
       }

package/rules/stylus.js

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