Create-react-app: Missing documentation for process.env.CI

Created on 10 Jul 2019 · 2Comments · Source: facebook/create-react-app

The npm run build command is affected by the environment variable CI, but it is not well documented.

This is what the existing documentation says about it:

When creating a build of your application with npm run build linter warnings are not checked by default. Like npm test, you can force the build to perform a linter warning check by setting the environment variable CI. If any warnings are encountered then the build fails.

By looking at the source code or playing with the command, there are several side effects:

Some errors are silenced:
https://github.com/facebook/create-react-app/blob/7b196fa4d6f4a98b93a460440adfef206e214652/test/fixtures/__shared__/util/setup.js#L105
There is no color in the output anymore
Another side effect here

I believe it would be a good choice to have no undocumented side effect.

Use cases where it is a problem:

I want to master my CI pipeline: I can't just set an environment variable without knowing exactly what it does.
I want to treat warnings as errors locally and the only option seems to be to set the CI option (this is a problem in intslef): I would also like to know what it does and keep the colors in the output.
The usage of npm build don't talk about the envinroment variables, neither does npm help build, it is then confusing to see the behavior change between computers.

$ npm build -h  
npm build [<folder>]

Thank you for reading this.

Best,
Simon

proposal

Source

sguillia

👍7

Most helpful comment

I see half a dozen issues with developers asking why this would be a default setting (CI=true means _warnings_ are treated as _errors_). It's bizarre. These other issues are closed and locked without explanation—as I'm sure this one will be too—but instead are brushed off with a "we know best" type of answer.

If my team decides that some lint violation is acceptable as a warning instead of an error, and we make that change to our config, I very much expect _any_ CI to abide by that. Setting process.env.CI=false does appeal to me at all. It's a blackbox flag: I have no idea what it does now, or what it might do in the future. The environment is a CI, why on earth would I turn that setting off?

I appeal to @gaearon and @Timer to stop shutting this down, and either shed a light on the internal discussions y'all had surrounding this, or listen to the community. Over the years of working with CRA I've started to find this kind of cold shoulder (coldly shutting down issues and locking discussions) really off-putting. I apologize for my tone, I respect the work that's been done, and I realize you owe me nor any of us anything, but it's frustrating none-the-less. 😕

_Edit: I'm commenting here because all of the directly-related issues have been locked_

christiannaths on 1 Oct 2020

👍3

All 2 comments

There is a good reason why linting rules separate warning and errors. Warnings are intended to alert the developer to take a look at something. The developer then makes a judgement call on whether there is a real issue. I don't want tooling to make that decision for me. If there is an option that can be set to treat warning as errors that could be very useful and many people might use it. However, it should be an option that is not combined with other behavioural modifications in the build.