React-app-rewired: react-app-rewire-less not working

[afc163]

/Users/afc163/Projects/antd-demo-new/node_modules/[email protected]@react-app-rewire-less/index.js:8
  fileLoader.exclude.push(lessExtension);
            ^

TypeError: Cannot read property 'exclude' of undefined
    at rewireLess (/Users/afc163/Projects/antd-demo-new/node_modules/[email protected]@react-app-rewire-less/index.js:8:13)
    at override (/Users/afc163/Projects/antd-demo-new/config-overrides.js:6:12)
    at Object.<anonymous> (/Users/afc163/Projects/antd-demo-new/node_modules/[email protected]@react-app-rewired/scripts/start.js:18:3)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:389:7)
    at startup (bootstrap_node.js:149:9)
    at bootstrap_node.js:504:3

[timarney]

[email protected]

[sunnyYanan]

I still have the problem with "react-app-rewire-less": "^2.1.0",

[dawnmist]

@sunnyYanan Could you please post the output from adding the console.log line below to your config-overrides.js file just before the call to react-app-rewire-less:

// Turns the regex tests defined in the rules into a human readable string instead of an empty object,
// so we can actually see the rule tests defined when we output it to the console.
function stringifyConfig(name, value) {
  if  (value && value.constructor === RegExp) {
    return value.toString();
  }
  return value;
}

// Assuming you're using the single function type of config-overrides.js. If not, this should be the 
// "webpack" function in the combined export.
module.exports = function(config, env) {
  // Output the actual configuration rules as generated on your machine
  console.log(`${JSON.stringify(config.module.rules, stringifyConfig, 2)}`);
  // Just to exit out without going any further, so the log messages do not get wiped away.
  throw new Error('stop here');

  config = react-app-rewire-less(config, env);
  ...the rest of your changes here...
  return config;
}

Once you have the console output from above, you can undo these changes - they're just to put together what the actual rules are that are being passed to the rewire so that we can debug why the file-loader is not being found properly on your machine.

And a quick question just to confirm - are you using the normal/default react-scripts package, or are you using a custom scripts package (the --scripts-version option to react-app-rewired)?

[sunnyYanan]

[
  {
    "test": "/\\.(js|jsx|mjs)$/",
    "enforce": "pre",
    "use": [
      {
        "options": {
          "eslintPath": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@eslint/lib/api.js",
          "baseConfig": {
            "extends": [
              "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@eslint-config-react-app/index.js"
            ]
          },
          "ignore": false,
          "useEslintrc": false
        },
        "loader": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@eslint-loader/index.js"
      }
    ],
    "include": "/Users/zhangyanan/Documents/self-template/src"
  },
  {
    "oneOf": [
      {
        "test": [
          "/\\.bmp$/",
          "/\\.gif$/",
          "/\\.jpe?g$/",
          "/\\.png$/"
        ],
        "loader": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@url-loader/index.js",
        "options": {
          "limit": 10000,
          "name": "static/media/[name].[hash:8].[ext]"
        }
      },
      {
        "test": "/\\.(js|jsx|mjs)$/",
        "include": "/Users/zhangyanan/Documents/self-template/src",
        "loader": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@babel-loader/lib/index.js",
        "options": {
          "babelrc": false,
          "presets": [
            "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@babel-preset-react-app/index.js"
          ],
          "cacheDirectory": true
        }
      },
      {
        "test": "/\\.css$/",
        "use": [
          "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@style-loader/index.js",
          {
            "loader": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@css-loader/index.js",
            "options": {
              "importLoaders": 1
            }
          },
          {
            "loader": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@postcss-loader/lib/index.js",
            "options": {
              "ident": "postcss"
            }
          }
        ]
      },
      {
        "exclude": [
          "/\\.js$/",
          "/\\.html$/",
          "/\\.json$/"
        ],
        "loader": "/Users/zhangyanan/Documents/self-template/node_modules/[email protected]@file-loader/dist/cjs.js",
        "options": {
          "name": "static/media/[name].[hash:8].[ext]"
        }
      }
    ]
  }
]

here is my output, and I use the default react-scripts package

[dawnmist]

@sunnyYanan Looking at the above, the file-loader really should have been able to be found - we search for it as both /file-loader/ and @file-loader/ (actually use path.sep instead of the '/' character directly, so that it adjusts to different path separators in different OS's), and the second of those two possibilities should have been triggered in the config you've posted. The match is checked for by calling loaderNameMatches(rule, 'file-loader') as follows:
https://github.com/timarney/react-app-rewired/blob/6b3e04b9648c8cb57f5e359b0791dcb087ad4c18/packages/react-app-rewire-less/index.js#L8-L11
https://github.com/timarney/react-app-rewired/blob/6b3e04b9648c8cb57f5e359b0791dcb087ad4c18/packages/react-app-rewired/index.js#L14-L24
https://github.com/timarney/react-app-rewired/blob/6b3e04b9648c8cb57f5e359b0791dcb087ad4c18/packages/react-app-rewired/index.js#L4-L8

It _should_ have gone past the first rule in the config.modules.rules, found the "oneOf" clause in the second rule, then iterated through each of the subrules in the oneOf clause until it found a match with the last subrule according to the config that you have posted.

[pauliusuza]

Having the same issue as @sunnyYanan. This is an active bug, please re-open.

[dawnmist]

@pauliusuza @sunnyYanan Can either of you put together a sample repository that shows this happening? What OS are you seeing it on? At this stage, I cannot reproduce the issue, and the output that @sunnyYanan provided shows that it should not have been happening, so without a way to reproduce and with output that I can see no reason for the code to be failing I am at a loss to be able to help any further.

The original reason for this to have been occurring was that we were looking for ${path.sep}file-loader${path.sep} and on some operating systems the version number is added to the path as well, so we needed to look for @file-loader${path.sep} on those operating systems. The config output that @sunnyYanan provided showed that the @file-loader${path.sep} path should have matched his config.

[sam019]

I meet this bug yet. [email protected]

this is my output:
[ { "test": "/\\.(js|jsx|mjs)$/", "enforce": "pre", "use": [ { "options": { "eslintPath": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@eslint/lib/api.js", "baseConfig": { "extends": [ "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@eslint-config-react-app/index.js" ] }, "ignore": false, "useEslintrc": false }, "loader": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@eslint-loader/index.js" } ], "include": "/Users/liangsen/Desktop/eleme/tms_ops_web/src" }, { "oneOf": [ { "test": [ "/\\.bmp$/", "/\\.gif$/", "/\\.jpe?g$/", "/\\.png$/" ], "loader": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@url-loader/index.js", "options": { "limit": 10000, "name": "static/media/[name].[hash:8].[ext]" } }, { "test": "/\\.(js|jsx|mjs)$/", "include": "/Users/liangsen/Desktop/eleme/tms_ops_web/src", "loader": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@babel-loader/lib/index.js", "options": { "babelrc": false, "presets": [ "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@babel-preset-react-app/index.js" ], "cacheDirectory": true, "plugins": [ "transform-decorators-legacy", [ "import", { "libraryName": "antd", "style": true } ] ] } }, { "test": "/\\.css$/", "use": [ "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@style-loader/index.js", { "loader": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@css-loader/index.js", "options": { "importLoaders": 1 } }, { "loader": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@postcss-loader/lib/index.js", "options": { "ident": "postcss" } } ] }, { "exclude": [ "/\\.(js|jsx|mjs)$/", "/\\.html$/", "/\\.json$/" ], "loader": "/Users/liangsen/Desktop/eleme/tms_ops_web/node_modules/[email protected]@file-loader/dist/cjs.js", "options": { "name": "static/media/[name].[hash:8].[ext]" } } ] } ]

[sam019]

I find the problem...
This is not the problem of this package self. It is happened when use third npm source, and I fix it with fetching package via offcial npm source.

[andreigec]

my quick fix

const path = require('path');
const { compose } = require('react-app-rewired');

function excludeExtension(config, extension) {
const index1 = config.module.rules.findIndex((rule) => typeof (rule.oneOf) !== 'undefined');
config.module.rules[index1].oneOf = config.module.rules[index1].oneOf.filter((rule) => !rule.test || rule.test.toString().indexOf(extension) === -1);

const index2 = config.module.rules[index1].oneOf.findIndex((rule) => rule.loader && typeof rule.loader === 'string' && rule.loader.indexOf(`${path.sep}file-loader${path.sep}`) !== -1);
config.module.rules[index1].oneOf[index2].exclude.push(extension);

return config;

}

function rewireLess(config, env) {
const extension = /.less$/;
config = excludeExtension(config, extension);

config.module.rules.push({
    test: extension,
    use: ['style-loader?sourceMap',
        'css-loader?modules&importLoaders=1&localIdentName=[name]__[local]___[hash:base64:5]',
        'less-loader'],
});

return config;

}

function rewriteSVG(config, env) {
const extension = /.svg$/;
config = excludeExtension(config, extension);

config.module.rules.push({
    test: extension,
    use: [
        { loader: 'svg-react-loader' },
    ],
});

return config;

}

module.exports = compose(rewireLess, rewriteSVG);

[Calerme]

Reloading version 1.1.0 can solve this problem.