www.aleph1.co.uk Git - yaffs-website/blob - node_modules/tsml/README.md

   1 # tsml
   2
   3 **ES6 template string tag for multi-line cleaning - squash multi-line strings into a single line**
   4
   5 Use template strings to split up complex string creation over multiple lines and have the newlines and newline white-space prefixes cleaned for you.
   6
   7 `tsml` is primarily for code readability. Split up template strings over newlines, indent or add additional blank lines to space things out.
   8
   9 ## Example
  10
  11 From [changelog-maker](https://github.com/rvagg/changelog-maker):
  12
  13 ```js
  14 const tsml = require('tsml')
  15
  16 function toStringSimple (data) {
  17   return tsml`
  18
  19     * [${data.sha.substr(0, 10)}] -
  20     ${data.semver.length ? '(' + data.semver.join(', ').toUpperCase() + ') ' : ''}
  21     ${data.revert ? 'Revert "' : ''}
  22     ${data.group ? data.group + ': ' : ''}
  23     ${data.summary}
  24     ${data.revert ? '"' : ''}
  25     ${data.author ? '(' + data.author + ') ' : ''}
  26     ${data.pr}
  27
  28   `
  29 }
  30
  31 // -> * [7e88a9322c] - src: make accessors immune to context confusion (Ben Noordhuis) #1238
  32 ```
  33
  34 ## License
  35
  36 **tsml** is Copyright (c) 2015 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.