Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix jsconfig support with CRA #9324

Merged
merged 2 commits into from
Jan 31, 2020
Merged

Fix jsconfig support with CRA #9324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37f5d27
Fix jsconfig support with CRA
Hypnosphi Jan 4, 2020
b2dae40
Fix tests
Hypnosphi Jan 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions app/react/src/server/__snapshots__/cra-config.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Object {
"resolve": Object {
"alias": Object {
"baseAlias": "base-alias",
"react-native": "react-native-web",
},
"extensions": Array [
".js",
Expand Down Expand Up @@ -109,6 +110,7 @@ Object {
"resolve": Object {
"alias": Object {
"baseAlias": "base-alias",
"react-native": "react-native-web",
},
"extensions": Array [
".js",
Expand Down
22 changes: 1 addition & 21 deletions app/react/src/server/cra-config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
/* eslint-disable jest/no-mocks-import */
import fs from 'fs';
import path from 'path';
import {
applyCRAWebpackConfig,
getModulePath,
getReactScriptsPath,
getTypeScriptRules,
} from './cra-config';
import { applyCRAWebpackConfig, getReactScriptsPath, getTypeScriptRules } from './cra-config';
import mockRules from './__mocks__/mockRules';
import mockConfig from './__mocks__/mockConfig';

Expand Down Expand Up @@ -95,21 +90,6 @@ exit $ret`
rules.every(rule => rule.include.find(filePath => filePath.includes('.storybook')))
).toBe(true);
});

it('should get the baseUrl from a tsconfig.json', () => {
jest.spyOn(path, 'join').mockImplementation(() => 'project/tsconfig.json');
jest.mock(
'project/tsconfig.json',
() => ({
compilerOptions: {
baseUrl: 'src',
},
}),
{ virtual: true }
);
expect(getModulePath()).toEqual('src');
path.join.mockRestore();
});
});

describe('when used with react-scripts < 2.1.0', () => {
Expand Down
32 changes: 7 additions & 25 deletions app/react/src/server/cra-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ import MiniCssExtractPlugin from 'mini-css-extract-plugin';
import { normalizeCondition } from 'webpack/lib/RuleSet';
import { logger } from '@storybook/node-logger';

const JSCONFIG = 'jsconfig.json';
const TSCONFIG = 'tsconfig.json';

const appDirectory = fs.realpathSync(process.cwd());
const cssExtensions = ['.css', '.scss', '.sass'];
const cssModuleExtensions = ['.module.css', '.module.scss', '.module.sass'];
Expand Down Expand Up @@ -114,23 +111,6 @@ export const getTypeScriptRules = (webpackConfigRules: RuleSetRule[], configDir:
}, [] as RuleSetRule[]);
};

export const getModulePath = () => {
// As with CRA, we only support `jsconfig.json` if `tsconfig.json` doesn't exist.
let configName;
if (fs.existsSync(path.join(appDirectory, TSCONFIG))) {
configName = TSCONFIG;
} else if (fs.existsSync(path.join(appDirectory, JSCONFIG))) {
configName = JSCONFIG;
}

if (configName) {
// eslint-disable-next-line import/no-dynamic-require,global-require
const config = require(path.join(appDirectory, configName));
return config.compilerOptions && config.compilerOptions.baseUrl;
}
return false;
};

function mergePlugins(basePlugins: Plugin[], additionalPlugins: Plugin[]) {
return [...basePlugins, ...additionalPlugins].reduce((plugins, plugin) => {
if (
Expand Down Expand Up @@ -171,10 +151,6 @@ export function applyCRAWebpackConfig(baseConfig: Configuration, configDir: stri
const tsExtensions = hasTsSupport ? typeScriptExtensions : [];
const extensions = [...cssExtensions, ...tsExtensions];

// Support for this was added in `react-scripts@3.0.0`.
// https://github.com/facebook/create-react-app/pull/6656
const modulePath = isReactScriptsInstalled('3.0.0') && getModulePath();

// Remove any rules from baseConfig that test true for any one of the extensions
const filteredBaseRules = baseConfig.module.rules.filter(
rule => !rule.test || !extensions.some(normalizeCondition(rule.test))
Expand Down Expand Up @@ -205,7 +181,13 @@ export function applyCRAWebpackConfig(baseConfig: Configuration, configDir: stri
resolve: {
...baseConfig.resolve,
extensions: [...baseConfig.resolve.extensions, ...tsExtensions],
modules: baseConfig.resolve.modules.concat(modulePath || []),
modules: Array.from(
new Set([...baseConfig.resolve.modules, ...(craWebpackConfig.resolve.modules || [])])
),
alias: {
...baseConfig.resolve.alias,
...craWebpackConfig.resolve.alias,
},
},
resolveLoader: {
modules: ['node_modules', path.join(getReactScriptsPath(), 'node_modules')],
Expand Down