Blame view

node_modules/babel-template/README.md 1.2 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
  # babel-template
  
  > Generate an AST from a string template.
  
  In computer science, this is known as an implementation of quasiquotes.
  
  ## Install
  
  ```sh
  npm install --save-dev babel-template
  ```
  
  ## Usage
  
  ```js
  import template from "babel-template";
  import generate from "babel-generator";
  import * as t from "babel-types";
  
  const buildRequire = template(`
    var IMPORT_NAME = require(SOURCE);
  `);
  
  const ast = buildRequire({
    IMPORT_NAME: t.identifier("myModule"),
    SOURCE: t.stringLiteral("my-module")
  });
  
  console.log(generate(ast).code);
  ```
  
  ```js
  const myModule = require("my-module");
  ```
  
  ## API
  
  ### `template(code, [opts])`
  
  #### code
  
  Type: `string`
  
  #### options
  
  `babel-template` accepts all of the options from [babylon], and specifies
  some defaults of its own:
  
  * `allowReturnOutsideFunction` is set to `true` by default.
  * `allowSuperOutsideMethod` is set to `true` by default.
  
  ##### preserveComments
  
  Type: `boolean`
  Default: `false`
  
  Set this to `true` to preserve any comments from the `code` parameter.
  
  #### Return value
  
  `babel-template` returns a `function` which is invoked with an optional object
  of replacements. See the usage section for an example.
  
  [babylon]: https://github.com/babel/babylon#options