From d4bc082bb9bd3139739ad77812185dabaf0af03d Mon Sep 17 00:00:00 2001 From: Sebastian McKenzie Date: Sun, 16 Nov 2014 19:19:46 +1100 Subject: [PATCH] add new filenameRelative, sourceRoot and moduleRoot option documentation --- doc/usage.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/doc/usage.md b/doc/usage.md index 554583d337..d784703123 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -83,6 +83,10 @@ to5.transformFile("filename.js", options, function (err, result) { // Default: "unknown" filename: "filename", + // Filename relative to `sourceRoot` + // Default: `filename` option. + filenameRelative: "", + // List of transformers to EXCLUDE. // Run `6to5 --help` to see a full list of transformers. blacklist: [], @@ -103,13 +107,20 @@ to5.transformFile("filename.js", options, function (err, result) { sourceMap: true, // Set `file` on returned source map. - // Default: `filename` option. + // Default: `filenameRelative` option. sourceMapName: "filename", // Set `sources[0]` on returned source map. - // Default: `filename` option. + // Default: `filenameRelative` option. sourceFileName: "filename", + // The root from which all sources are relative + sourceRoot: "assets/scripts", + + // Optional prefix for the AMD module formatter that will be prepend to the + // filename on module definitions + moduleRoot: "my-app", + // Optionally replace all 6to5 helper declarations with a referenece to this // variable. If set to `true` then the default namespace is used "to5Runtime". // Default: false