source.moduleScopes#

• Type: Array<string | Regexp> | Function
• Default: undefined
• Bundler: only support webpack

Restrict importing paths. After configuring this option, all source files can only import code from the specific paths, and import code from other paths is not allowed.

Example#

First, we configure moduleScopes to only include the src directory:

export default {
  source: {
    moduleScopes: ['./src'],
  },
};

Then we import the utils/a module outside the src directory in src/App.tsx:

import a from '../utils/a';

After compiling, there will be a reference path error:

If we configure the utils directory in moduleScopes, the error will disappear.

export default {
  source: {
    moduleScopes: ['./src', './utils'],
  },
};

Array Type#

You can directly set several paths like this:

export default {
  source: {
    moduleScopes: ['./src', './shared', './utils'],
  },
};

Function Type#

moduleScopes also supports setting as a function, which can be modified instead of overriding the default value:

export default {
  source: {
    moduleScopes: scopes => {
      scopes.push('./shared');
    },
  },
};