Fix issues with ESLint Import Resolver

configs/eslint.js

@@ -35,7 +35,7 @@ module.exports = {
  },
  plugins: ['@babel', 'react', 'prettier', 'jsdoc', 'import', '@typescript-eslint/eslint-plugin'],
  settings: {
- 'import/resolver': eslintResolver('src'),
+ 'import/resolver': eslintResolver(),
  'import/parsers': {
  '@typescript-eslint/parser': ['.ts', '.tsx'],
  },

example-site/package.json

@@ -1,5 +1,8 @@
 {
  "name": "test-project",
+ "eslintConfig": {
+ "extends": "./../configs/eslint"
+ },
  "dependencies": {
  "prop-types": "^15.8.1"
  }

package.json

@@ -27,6 +27,12 @@
  "bin": {
  "build-tools": "./src/cli.js"
  },
+ "jest": {
+ "testPathIgnorePatterns": [
+ "node_modules",
+ ".yalc"
+ ]
+ },
  "scripts": {
  "test": "jest --verbose",
  "test:watch": "jest --watch --verbose"

src/commands/build.js

@@ -10,6 +10,7 @@ const spinner = ora();
 const { findAllProjectPaths, validateProject } = require('./../utils/projectpaths');
 const { getPackage } = require('./../utils/get-package');
 const dirsExist = require('../utils/dirs-exist');
+const getProjectConfig = require('../utils/get-project-config');
 
 global.buildCount = 0;
 
@@ -114,32 +115,9 @@ exports.handler = async ({
  spinner.start('Building webpack configs.\n');
 
  const configMap = validProjects.map((packageObject) => {
- /**
- * Project config holds all information about a particular project,
- * rather than directly pulling out paths from files or attempting
- * to build them, use what is here.
- */
- const PROJECT_CONFIG = {
- name: packageObject.name,
- version: packageObject.json.version,
- paths: {
- project: path.resolve(packageObject.path),
- config: path.resolve(`${__dirname}/../../configs`),
- src: path.resolve(`${packageObject.path}/src`),
- dist: path.resolve(`${packageObject.path}/dist`),
- clean: [
- `${packageObject.path}/dist/scripts`,
- `${packageObject.path}/dist/styles`,
- `${packageObject.path}/dist/static`,
- ],
- node_modules: path.resolve(packageObject.path, 'node_modules'),
- },
- clean: true,
- copy: true,
- mode,
- };
+ const projectConfig = getProjectConfig(packageObject, mode);
 
- return webpackConfig(PROJECT_CONFIG, mode);
+ return webpackConfig(projectConfig, mode);
  });
 
  let previousHash = '';

src/commands/build/plugins/eslint.js

@@ -1,10 +1,10 @@
 const ESLintPlugin = require('eslint-webpack-plugin');
-const ESLintConfig = require('../../../../configs/eslint');
+const ESLintConfigFunc = require('./../../../utils/esllint-config-func');
 /**
  * Sets the config for the ESLint webpack plugin.
  * @returns ESLintPlugin instance.
  */
-module.exports = () =>
+module.exports = (projectConfig) =>
  new ESLintPlugin({
- baseConfig: ESLintConfig,
+ baseConfig: ESLintConfigFunc(projectConfig),
  });

src/utils/__tests__/projectpaths.test.js

@@ -16,6 +16,9 @@ const packageJson = {
 };
 
 describe('Project paths', () => {
+ let originalWrite;
+ let originalExit;
+
  beforeEach(() => {
  jest.resetModules();
 

src/utils/esllint-config-func.js

@@ -0,0 +1,21 @@
+const eslintConfig = require('../../configs/eslint');
+const { eslintResolver } = require('./get-alias');
+
+/**
+ * Allows for the ESLint Config to be used dynamically in code
+ * with a passed config.
+ * @param {object} projectConfig The project config to add
+ * @returns 
+ */
+module.exports = (projectConfig) => {
+ return {
+ ...eslintConfig,
+ parserOptions: {
+ ...eslintConfig.parserOptions,
+ settings: {
+ ...eslintConfig.parserOptions.settings,
+ 'import/resolver': eslintResolver(projectConfig),
+ }
+ }
+ }
+};

src/utils/get-alias.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const getProjectConfig = require('./get-project-config');
 
 /**
  * Get a list of aliases structured for webpack.
@@ -20,18 +21,19 @@ const webpackAlias = (src) => {
 /**
  * Get and map aliases to the eslint resolver structure.
  *
- * @param {string} src Path to the current target src directory
+ * @param {mixed} paths Paths to the current target directories
  * @returns
  */
-const eslintResolver = ({ src, project }) => {
- const aliases = webpackAlias(src);
+const eslintResolver = (paths = null) => {
+ paths = paths ?? getProjectConfig();
+ const aliases = webpackAlias(paths.paths.src);
  const aliasMap = Object.entries(aliases);
  const pathsList = Array.from(new Set(Object.values(aliases))).map((item) => item + '/*');
 
  return {
  typescript: {
  alwaysTryTypes: true,
- project,
+ project: paths?.paths?.project,
  },
  alias: {
  map: aliasMap,

src/utils/get-project-config.js

@@ -0,0 +1,37 @@
+const path = require('path');
+
+/**
+ * Project config holds all information about a particular project,
+ * rather than directly pulling out paths from files or attempting
+ * to build them, use what is here.
+ */
+module.exports = (
+ packageObject = {
+ name: '',
+ json: {
+ version: 'v0.0.0'
+ },
+ path: './'
+ },
+ mode = 'development'
+) => {
+ return {
+ name: packageObject?.name ?? '',
+ version: packageObject?.json?.version ?? 'v0.0.0',
+ paths: {
+ project: path.resolve(packageObject.path),
+ config: path.resolve(`${__dirname}/../../configs`),
+ src: path.resolve(`${packageObject.path}/src`),
+ dist: path.resolve(`${packageObject.path}/dist`),
+ clean: [
+ path.resolve(`${packageObject.path}/dist/scripts`),
+ path.resolve(`${packageObject.path}/dist/styles`),
+ path.resolve(`${packageObject.path}/dist/static`),
+ ],
+ node_modules: path.resolve(packageObject.path, 'node_modules'),
+ },
+ clean: true,
+ copy: true,
+ mode,
+ };
+}