react/packages/react-stream
Andrew Clark 112168f31b
Lint rule for unminified errors (#15757)
* Lint rule for unminified errors

Add a lint rule that fails if an invariant message is not part of the
error code map.

The goal is to be more disciplined about adding and modifiying
production error codes. Error codes should be consistent across releases
even if their wording changes, for continuity in logs.

Currently, error codes are added to the error code map via an automated
script that runs right before release. The problem with this approach is
that if someone modifies an error message in the source, but neglects to
modify the corresponding message in the error code map, then the message
will be assigned a new error code, instead of reusing the existing one.

Because the error extraction script only runs before a release, people
rarely modify the error code map in practice. By moving the extraction
step to the PR stage, it forces the author to consider whether the
message should be assigned a new error code. It also allows the reviewer
to review the changes.

The trade off is that it requires more effort and context to land new
error messages, or to modify existing ones, particular for new
contributors who are not familiar with our processes.

Since we already expect users to lint their code, I would argue the
additional burden is marginal. Even if they forget to run the lint
command locally, they will get quick feedback from the CI lint job,
which typically finishes within 2-3 minutes.

* Add unreleased error messages to map
2019-05-29 11:29:04 -07:00
..
npm [Fizz] New Server Rendering Infra (#14144) 2018-11-30 11:38:22 -08:00
src Lint rule for unminified errors (#15757) 2019-05-29 11:29:04 -07:00
index.js [Fizz] New Server Rendering Infra (#14144) 2018-11-30 11:38:22 -08:00
inline-typed.js [Fizz] New Server Rendering Infra (#14144) 2018-11-30 11:38:22 -08:00
inline.dom-browser.js [Fizz] New Server Rendering Infra (#14144) 2018-11-30 11:38:22 -08:00
inline.dom.js [Fizz] New Server Rendering Infra (#14144) 2018-11-30 11:38:22 -08:00
package.json Add directory details to the package.json of all packages (#14628) 2019-01-18 20:21:12 +00:00
README.md [Fizz] New Server Rendering Infra (#14144) 2018-11-30 11:38:22 -08:00

react-stream

This is an experimental package for creating custom React streaming server renderers.

Its API is not as stable as that of React, React Native, or React DOM, and does not follow the common versioning scheme.

Use it at your own risk.

API

var Renderer = require('react-stream');

var HostConfig = {
  // You'll need to implement some methods here.
  // See below for more information and examples.
};

var MyRenderer = Renderer(HostConfig);

var RendererPublicAPI = {
};

module.exports = RendererPublicAPI;