README.md

react-tools

This package compliments the usage of React. It ships with tools that are often used in conjunction.

JSX

This package installs a jsx executable that can be used to transform JSX into vanilla JS. This is often used as part of a build step. This transform is also exposed as an API.

Usage

Command Line

Usage: jsx [options] <source directory> <output directory> [<module ID> [<module ID> ...]]

Options:

  -h, --help                               output usage information
  -V, --version                            output the version number
  -c, --config [file]                      JSON configuration file (no file or - means STDIN)
  -w, --watch                              Continually rebuild
  -x, --extension <js | coffee | ...>      File extension to assume when resolving module identifiers
  --relativize                             Rewrite all module identifiers to be relative
  --follow-requires                        Scan modules for required dependencies
  --cache-dir <directory>                  Alternate directory to use for disk cache
  --no-cache-dir                           Disable the disk cache
  --source-charset <utf8 | win1252 | ...>  Charset of source (default: utf8)
  --output-charset <utf8 | win1252 | ...>  Charset of output (default: utf8)
  --harmony                                Turns on JS transformations such as ES6 Classes etc.
  --source-map-inline                      Embed inline sourcemap in transformed source
  --strip-types                            Strips out type annotations

API

transform(inputString, options)

option	values	default
sourceMap	true: append inline source map at the end of the transformed source	false
harmony	true: enable ES6 features	false
sourceFilename	the output filename for the source map	"source.js"
stripTypes	true: strips out type annotations	false

var reactTools = require('react-tools');

reactTools.transform(string, options);

transformWithDetails(inputString, options)

Just like transform, but outputs an object:

{
  code: outputString,
  sourceMap: theSourceMap // Only if the `sourceMap` option is `true`.
}