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

Adds TSC_COMPILE_ON_ERROR env var... #6931

Merged
merged 7 commits into from Oct 1, 2019
Merged

Adds TSC_COMPILE_ON_ERROR env var... #6931

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c1c56de
Adds TSC_COMPILE_ON_ERROR env var to allow users to run and properly …
kylebebak Apr 26, 2019
1955a07
Documents TSC_COMPILE_ON_ERROR env var; changes message printed to co…
kylebebak Jul 15, 2019
c6c9bd8
Update docusaurus/docs/adding-typescript.md
kylebebak Aug 8, 2019
e837044
Print tsc errors with chalk.yellow instead of chalk.red
kylebebak Aug 8, 2019
92e381c
Merge branch 'master' of github.com:facebook/create-react-app
kylebebak Aug 8, 2019
1d86b8a
Document TSC_COMPILE_ON_ERROR in advanced-configuration
kylebebak Aug 12, 2019
1bedff1
Doesn't even implicitly encourage disabling TypeScript error check to…
kylebebak Sep 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/react-dev-utils/README.md
View file
Open in desktop
Expand Up @@ -337,6 +337,7 @@ The `args` object accepts a number of properties:
- **urls** `Object`: To provide the `urls` argument, use `prepareUrls()` described below.
- **useYarn** `boolean`: If `true`, yarn instructions will be emitted in the terminal instead of npm.
- **useTypeScript** `boolean`: If `true`, TypeScript type checking will be enabled. Be sure to provide the `devSocket` argument above if this is set to `true`.
- **tscCompileOnError** `boolean`: If `true`, errors in TypeScript type checking will not prevent start script from running app, and will not cause build script to exit unsuccessfully. Also downgrades all TypeScript type checking error messages to warning messages.
ianschmitz marked this conversation as resolved.
Show resolved Hide resolved
- **webpack** `function`: A reference to the webpack constructor.

##### `prepareProxy(proxySetting: string, appPublicFolder: string): Object`
Expand Down
19 changes: 16 additions & 3 deletions packages/react-dev-utils/WebpackDevServerUtils.js
View file
Open in desktop
Expand Up @@ -108,6 +108,7 @@ function createCompiler({
urls,
useYarn,
useTypeScript,
tscCompileOnError,
webpack,
}) {
// "Compiler" is a low-level interface to Webpack.
Expand Down Expand Up @@ -190,16 +191,28 @@ function createCompiler({

const messages = await tsMessagesPromise;
clearTimeout(delayedMsg);
statsData.errors.push(...messages.errors);
if (tscCompileOnError) {
statsData.warnings.push(...messages.errors);
} else {
statsData.errors.push(...messages.errors);
}
statsData.warnings.push(...messages.warnings);

// Push errors and warnings into compilation result
// to show them after page refresh triggered by user.
stats.compilation.errors.push(...messages.errors);
if (tscCompileOnError) {
stats.compilation.warnings.push(...messages.errors);
} else {
stats.compilation.errors.push(...messages.errors);
}
stats.compilation.warnings.push(...messages.warnings);

if (messages.errors.length > 0) {
devSocket.errors(messages.errors);
if (tscCompileOnError) {
devSocket.warnings(messages.errors);
} else {
devSocket.errors(messages.errors);
}
} else if (messages.warnings.length > 0) {
devSocket.warnings(messages.warnings);
}
Expand Down
12 changes: 9 additions & 3 deletions packages/react-scripts/scripts/build.js
View file
Open in desktop
Expand Up @@ -122,9 +122,15 @@ checkBrowsers(paths.appPath, isInteractive)
);
},
err => {
console.log(chalk.red('Failed to compile.\n'));
printBuildError(err);
process.exit(1);
const tscCompileOnError = process.env.TSC_COMPILE_ON_ERROR === 'true';
if (tscCompileOnError) {
console.log(chalk.yellow('Compiled with warnings.\n'));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should state here that due to the flag, these warnings may be serious. Or just say that there were errors that the user has chosen to ignore with the flag.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, we could make it more obvious that there were type errors on compilation. How about this:

console.log(chalk.red(
  'Compiled with the following type errors (you may want to check these before deploying your app):\n'
));

printBuildError(err);
} else {
console.log(chalk.red('Failed to compile.\n'));
printBuildError(err);
process.exit(1);
}
}
)
.catch(err => {
Expand Down
2 changes: 2 additions & 0 deletions packages/react-scripts/scripts/start.js
View file
Open in desktop
Expand Up @@ -95,6 +95,7 @@ checkBrowsers(paths.appPath, isInteractive)
const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
const appName = require(paths.appPackageJson).name;
const useTypeScript = fs.existsSync(paths.appTsConfig);
const tscCompileOnError = process.env.TSC_COMPILE_ON_ERROR === 'true';
const urls = prepareUrls(protocol, HOST, port);
const devSocket = {
warnings: warnings =>
Expand All @@ -110,6 +111,7 @@ checkBrowsers(paths.appPath, isInteractive)
urls,
useYarn,
useTypeScript,
tscCompileOnError,
webpack,
});
// Load proxy config
Expand Down