6.22.0-prerelease • Published 7 years ago

babel-core-after-pr-4729 v6.22.0-prerelease

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
7 years ago

babel-core-after-pr-4729

This is just babel-core at ce0c620a9fd309c3a20483e8b709288d27e510f3, after PR #4729 was merged. It only exists because there hasn't yet been a release since then and depending on a git sha doesn't work for packages inside a monorepo. Once there is a babel-core release beyond 6.21.0, this package will be obsolete.

The way I use this fork is to install it as a normal dependency and then use a postinstall script that removes babel-core and symlinks babel-core to babel-core-after-pr-4729 (since other packages explicitly depend on babel-core):

{
  "scripts": {
    "postinstall": "rm -rf node_modules/babel-core && ln -s ./babel-core-after-pr-4729 node_modules/babel-core"
  }
}

The preexisting babel-core README follows.

babel-core

Babel compiler core.

var babel = require("babel-core");
import { transform } from 'babel-core';
import * as babel from 'babel-core';

All transformations will use your local configuration files (.babelrc or in package.json). See options to disable it.

babel.transform(code: string, options?: Object)

Transforms the passed in code. Returning an object with the generated code, source map, and AST.

babel.transform(code, options) // => { code, map, ast }

Example

var result = babel.transform("code();", options);
result.code;
result.map;
result.ast;

babel.transformFile(filename: string, options?: Object, callback: Function)

Asynchronously transforms the entire contents of a file.

babel.transformFile(filename, options, callback)

Example

babel.transformFile("filename.js", options, function (err, result) {
  result; // => { code, map, ast }
});

babel.transformFileSync(filename: string, options?: Object)

Synchronous version of babel.transformFile. Returns the transformed contents of the filename.

babel.transformFileSync(filename, options) // => { code, map, ast }

Example

babel.transformFileSync("filename.js", options).code;

babel.transformFromAst(ast: Object, code?: string, options?: Object)

Given, an AST, transform it.

const code = "if (true) return;";
const ast = babylon.parse(code, { allowReturnOutsideFunction: true });
const { code, map, ast } = babel.transformFromAst(ast, code, options);

Options

Following is a table of the options you can use:

OptionDefaultDescription
filename"unknown"Filename for use in errors etc.
filenameRelative(filename)Filename relative to sourceRoot.
presets[]List of presets (a set of plugins) to load and use.
plugins[]List of plugins to load and use.
parserOpts{}An object containing the options to be passed down to the babel parser, babylon
generatorOpts{}An object containing the options to be passed down to the babel code generator, babel-generator
highlightCodetrueANSI highlight syntax error code frames
onlynullA glob, regex, or mixed array of both, matching paths to only compile. Can also be an array of arrays containing paths to explicitly match. When attempting to compile a non-matching file it's returned verbatim.
ignorenullOpposite to the only option. ignore is disregarded if only is specified.
auxiliaryCommentBeforenullAttach a comment before all non-user injected code.
auxiliaryCommentAfternullAttach a comment after all non-user injected code.
sourceMapsfalseIf truthy, adds a map property to returned output. If set to "inline", a comment with a sourceMappingURL directive is added to the bottom of the returned code. If set to "both" then a map property is returned as well as a source map comment appended. This does not emit sourcemap files by itself! To have sourcemaps emitted using the CLI, you must pass it the --source-maps option.
inputSourceMapnullA source map object that the output source map will be based on.
sourceMapTarget(filenameRelative)Set file on returned source map.
sourceFileName(filenameRelative)Set sources[0] on returned source map.
sourceRoot(moduleRoot)The root from which all sources are relative.
moduleRoot(sourceRoot)Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions.
moduleIdsfalseIf truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)
moduleIdnullSpecify a custom name for module ids.
getModuleIdnullSpecify a custom callback to generate a module id with. Called as getModuleId(moduleName). If falsy value is returned then the generated module id is used.
resolveModuleSourcenullResolve a module source ie. import "SOURCE"; to a custom value. Called as resolveModuleSource(source, filename).
codetrueEnable code generation
no-babelrcCLI flagSpecify whether or not to use .babelrc and .babelignore files. Only available when using the CLI.
asttrueInclude the AST in the returned object
compact"auto"Do not include superfluous whitespace characters and line terminators. When set to "auto" compact is set to true on input sizes of >500KB.
minifiedfalseShould the output be minified (not printing last semicolons in blocks, printing literal string values instead of escaped ones, stripping () from new when safe)
commentstrueOutput comments in generated output.
shouldPrintCommentnullAn optional callback that controls whether a comment should be output or not. Called as shouldPrintComment(commentContents). NOTE: This overrides the comment option when used.
env{}This is an object of keys that represent different environments. For example, you may have: { env: { production: { /* specific options */ } } } which will use those options when the enviroment variable BABEL_ENV is set to "production". If BABEL_ENV isn't set then NODE_ENV will be used, if it's not set then it defaults to "development"
retainLinesfalseRetain line numbers. This will lead to wacky code but is handy for scenarios where you can't use source maps. (NOTE: This will not retain the columns)
extendsnullA path to an .babelrc file to extend