generate-soy-source-maps v0.2.7-alpha

Soy SourceMaps ·

Generates a source map for Closure template (Soy templates) based on the implementation described here. The parsed code is the compiled to incremental Dom that is made here.

Considering a map of origin for Soy, you guarantee some benefits:

• Tests coverage - With soy.js files being mapped by the tests you would never be able to cover all use cases, some are just implementations to cover older versions of soy, with source maps you will only cover the parts of interest without affecting the end result.
• Debugger - With the source map of soy files you will be able to debug in a simple way the same way you write in the syntax of Soy. You do not need to know the generated soy.js file.

Table of Contents

• Install
• CLI
  • Usage
  • All CLI Options
• Integration
  • Using with webpack and metalsoy
• Roadmap
• Contributing
• License

Install

Via NPM:

$ npm install --global generate-soy-source-maps

or via Yarn:

$ yarn add --global generate-soy-source-maps

CLI

Usage

$ soy-sourcemaps

All CLI Options

  Usage
    $ soy-sourcemaps [options]

  Options
    --input      The path of the Soy file
    --output     The path to the final file

Integration

Using with webpack and metalsoy

You may want to integrate the Soy source map generator with your Webpack into your current stack. To do this, the webpack should take the source map generated from outside its scope, consider installing the source-map-loader loader that does exactly that.

npm install -D source-map-loader

In your webpack configuration file, consider adding this new rule:

module.exports = {
  module: {
    rules: [
      //...
      {
        enforce: 'pre',
        test: /\.js$/,
        loader: 'source-map-loader',
      }
      //...
    ]
  }
  //...
};

For a better integration with metalsoy, if you have some task to run the build, consider running the source maps CLI after metalsoy:

{
  "scripts": {
    "build": "metalsoy && soy-sourcemaps --input './src' && webpack"
  }
}

Roadmap

Here's what's coming up for Soy Sourcemaps:

• Typescript support
• CLI: Generate sourcemaps for multiple files
• Integration with metal-tools-soy
• Parse HTML in soy files (with Sourcemaps for the generated)

Contributing

Feel free to open up problems or send pull requests. We will always be looking at these problems and we will be responding whenever possible.

Before opening a issue make sure it exists.

License

MIT License