|
2 | 2 |
|
3 | 3 | > An Ember CLI Deploy plugin to use a JSON index rather than an HTML one as provided by [`ember-cli-deploy-s3-index`](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index).
|
4 | 4 |
|
| 5 | +[](https://travis-ci.org/peopledoc/ember-cli-deploy-index-json) |
| 6 | + |
5 | 7 | This JSON index file is meant to be consumed by some application embedding yours.
|
6 | 8 |
|
7 | 9 | ```
|
@@ -49,7 +51,7 @@ s3: {},
|
49 | 51 | }
|
50 | 52 | ```
|
51 | 53 |
|
52 |
| -*In depth:* The idea is that `revision-data`, `s3-index` and `index-json` have the same `filePattern` value. `index-json` is not present in this example because we're using its default `filePattern` value. |
| 54 | +_In depth:_ The idea is that `revision-data`, `s3-index` and `index-json` have the same `filePattern` value. `index-json` is not present in this example because we're using its default `filePattern` value. |
53 | 55 |
|
54 | 56 | ## Usage
|
55 | 57 |
|
@@ -79,39 +81,39 @@ For detailed information on how configuration of plugins works, please refer to
|
79 | 81 |
|
80 | 82 | Files matching this pattern will be included in the index.
|
81 | 83 |
|
82 |
| -*Default:* `'**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}'` |
| 84 | +_Default:_ `'**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}'` |
83 | 85 |
|
84 | 86 | ### fileIgnorePattern
|
85 | 87 |
|
86 |
| -Files matching this pattern will *not* be included in the index even if they match filePattern. |
| 88 | +Files matching this pattern will _not_ be included in the index even if they match filePattern. |
87 | 89 |
|
88 |
| -*Default:* `null` |
| 90 | +_Default:_ `null` |
89 | 91 |
|
90 | 92 | ### indexPath
|
91 | 93 |
|
92 | 94 | The JSON index file name. If changed, you should adapt `revision-data` and `s3-index` plugins configs accordingly.
|
93 | 95 |
|
94 |
| -*Default:* `'index.json'` |
| 96 | +_Default:_ `'index.json'` |
95 | 97 |
|
96 | 98 | ### distDir
|
97 | 99 |
|
98 | 100 | Directory where assets have been written to
|
99 | 101 |
|
100 |
| -*Default:* the `distDir` property of the deployment context |
| 102 | +_Default:_ the `distDir` property of the deployment context |
101 | 103 |
|
102 | 104 | ### distFiles
|
103 | 105 |
|
104 | 106 | The Array of built assets.
|
105 | 107 |
|
106 |
| -*Default:* the `distFiles` property of the deployment context |
| 108 | +_Default:_ the `distFiles` property of the deployment context |
107 | 109 |
|
108 | 110 | ## Prerequisites
|
109 | 111 |
|
110 | 112 | No properties are expected to be present on the deployment context object.
|
111 | 113 |
|
112 | 114 | ## Tests
|
113 | 115 |
|
114 |
| -* yarn test |
| 116 | +- yarn test |
115 | 117 |
|
116 | 118 | ## Why `ember test` doesn't work
|
117 | 119 |
|
|
0 commit comments