1 | # Changelog
|
2 |
|
3 | ## 1.1.0 (2018-04-29)
|
4 | - **Feat**
|
5 | - Add `config.outputAST` ([#483](https://github.com/esdoc/esdoc/pull/483)). Thanks [@MattMcFarland](https://github.com/MattMcFarland)
|
6 | - Add `@package` tag ([#486](https://github.com/esdoc/esdoc/pull/486)). Thanks [@bmaupin](https://github.com/bmaupin)
|
7 | - **Fix**
|
8 | - Crash if `config.index` file was not found ([#490](https://github.com/esdoc/esdoc/pull/490)). Thanks [@22a](https://github.com/22a)
|
9 | - **Chore**
|
10 | - Update `marked`. ([#503](https://github.com/esdoc/esdoc/pull/503)) Thanks [@jan-molak](https://github.com/jan-molak)
|
11 | - Update some packages.
|
12 |
|
13 | ## 1.0.4 (2017-11-12)
|
14 | - **Fix**
|
15 | - Fix `import { type foo } from './Bar'` (flowtype syntax). ([#464](https://github.com/esdoc/esdoc/pull/464)) Thanks [@mprobber](https://github.com/mprobber)
|
16 | - Fix decorate that has object literal arguments. ([#472](https://github.com/esdoc/esdoc/pull/472)) Thanks [@mysim1](https://github.com/mysim1)
|
17 |
|
18 | ## 1.0.3 (2017-09-20)
|
19 | - **Fix**
|
20 | - Broken if using `@foo.bar` decorator. ([#439](https://github.com/esdoc/esdoc/issues/439))
|
21 |
|
22 | ## 1.0.2 (2017-09-03)
|
23 | - **Fix**
|
24 | - Broken if code block has `@`. ([#436](https://github.com/esdoc/esdoc/pull/436)) Thanks [@pzuraq](https://github.com/pzuraq)
|
25 | - Broken if anonymous default export is exist. ([#431](https://github.com/esdoc/esdoc/issues/431)) Thanks [@zemzheng](https://github.com/zemzheng)
|
26 | - Broken if expression extends is exist. ([#409](https://github.com/esdoc/esdoc/pull/409)) Thanks [@dimitryvolkov](https://github.com/dimitryvolkov)
|
27 |
|
28 | ## 1.0.1 (2017-07-30)
|
29 | - **Breaking**
|
30 | - Some features were carved out to plugins
|
31 | - [Migration to v1.0](https://esdoc.org/manual/migration.html)
|
32 | - [v0.5 documentation](https://esdoc.org/v0.5/index.html)
|
33 | - **Feat**
|
34 | - [esdoc-publish-markdown-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-publish-markdown-plugin) PoC
|
35 | - [esdoc-flow-type-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-flow-type-plugin) PoC
|
36 | - [esdoc-typescript-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-typescript-plugin) PoC
|
37 | - [esdoc-react-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-react-plugin) PoC
|
38 | - [esdoc-jsx-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-jsx-plugin)
|
39 | - **Note**
|
40 | - `v1.0.0` can not use. Because `v1.0.0` had been used in past.
|
41 |
|
42 | ## 0.5.2 (2017-01-02)
|
43 | - **Fix**
|
44 | - Display error message when invalid function type ([#351](https://github.com/esdoc/esdoc/issues/351)) Thanks [@LukasHechenberger](https://github.com/LukasHechenberger)
|
45 | - Crash when destructure sparse array ([#350](https://github.com/esdoc/esdoc/issues/350))
|
46 | - Crash when guess type of array detructuring ([#301](https://github.com/esdoc/esdoc/issues/301))
|
47 | - A union type in a generics type ([eb051e7](https://github.com/esdoc/esdoc/commit/eb051e729b83bca552a3d4b43351dc1272ee4154))
|
48 | - A union type with a spread type ([199d834](https://github.com/esdoc/esdoc/commit/199d834cfe68ba986212b51cb59ea2d9de55ba1c))
|
49 | - Crash when function was assigned by member expression ([e59820a](https://github.com/esdoc/esdoc/commit/e59820aed2f3e2091f32d35de34925d0132630e0))
|
50 | - Broken to guess type when property has null value or object expression using string key ([5920c1f](https://github.com/esdoc/esdoc/commit/5920c1f91633202ec795f360bb0ac12f68f258f2))
|
51 | - Crash when guess type of return value that has object spread ([#364](https://github.com/esdoc/esdoc/pull/364)) Thanks [vovkasm](https://github.com/vovkasm)
|
52 | - **Feat**
|
53 | - Automatically take a super class description if the method override a super class method. ([7b515f0](https://github.com/esdoc/esdoc/commit/7b515f0367a386ceb732b4606b96abf24bfab627))
|
54 |
|
55 | ## 0.5.1 (2016-12-26)
|
56 | - **Fix**
|
57 | - Fix a message when could not parse the codes ([a98a83c](https://github.com/esdoc/esdoc/commit/a98a83c2cdb2904e2f8a246dee8cf886da47fc48))
|
58 | - Fix a help message ([a16e2c1](https://github.com/esdoc/esdoc/commit/a16e2c121989d7a294d2cf2b6c2b1d1ec32f4277))
|
59 |
|
60 | ## 0.5.0 (2016-12-25)
|
61 | ESDoc logo was out!
|
62 |
|
63 | <img src="https://esdoc.org/manual/asset/image/logo.png" width="100px" class="no-shadow"/>
|
64 |
|
65 | - **Breaking**
|
66 | - Require node v6 or later ([a5b37bd](https://github.com/esdoc/esdoc/commit/a5b37bd0c68304214185f765f617b1077bee81b7))
|
67 | - Switch the ES parser to babylon from espree ([8130a3f](https://github.com/esdoc/esdoc/commit/8130a3f42b497e81f9ec6fc4cf0ef07ed5a7fa22))
|
68 | - `onHandleAST` in plugin is breaking
|
69 | - Remove `config.importPathPrefix` ([a665c5d](https://github.com/esdoc/esdoc/commit/a665c5d8c2c2a58cbe108ab3ecc8afc346c80ccf))
|
70 | - Use [ESDoc Import Path Plugin](https://github.com/esdoc/esdoc-importpath-plugin) instead of it
|
71 | - Remove `badge tag` in README ([6869b06](https://github.com/esdoc/esdoc/commit/6869b06e293c2471978ef96882baef6cc14c1766))
|
72 | - Use badge of [ESDoc Hosting Service](https://doc.esdoc.org)
|
73 | - **Feature: ES2015**
|
74 | - Support `arrow function` ([964eda3](https://github.com/esdoc/esdoc/commit/964eda3d4e2da6e5d92b3a6502a4b2d01422b692))
|
75 | - **Feature: ES2016**
|
76 | - Support `exponentiation operator` ([29f6ccc](https://github.com/esdoc/esdoc/commit/29f6ccced4256016fed4ac8eb5b98320cd78c4d7))
|
77 | - **Feature: ES2017**
|
78 | - Support `async function` ([50452a1](https://github.com/esdoc/esdoc/commit/50452a1e44a1c8908da1fb377d3aa51eba220256))
|
79 | - Support `trailing comma` ([dc9ba0f](https://github.com/esdoc/esdoc/commit/dc9ba0fd904adbc1519f27c15fab104f1a4414a5))
|
80 | - **Feature: ECMAScript Proposal** (see [here](https://esdoc.org/manual/usage/feature.html#ecmascript-proposal))
|
81 | - Support `class properties` ([c7b4d9b](https://github.com/esdoc/esdoc/commit/c7b4d9b415812cf18c451b1a452c9725593d3891))
|
82 | - Support `object rest spread` ([b58aa05](https://github.com/esdoc/esdoc/commit/b58aa054620e7335d7dcf8e0c81d4cb221e1fc6e))
|
83 | - Support `do expressions` ([33daf5a](https://github.com/esdoc/esdoc/commit/33daf5a89dcdd3cd72a3d8b74829861f2c08e18e))
|
84 | - Support `function bind` ([5b7a7d0](https://github.com/esdoc/esdoc/commit/5b7a7d06028e432d1e23b43963905c1a76b102b2))
|
85 | - Support `function sent` ([fe8a265](https://github.com/esdoc/esdoc/commit/fe8a2656a93cfae51c0a541f291f3f32330aec3b))
|
86 | - Support `async generators` ([e6dc2f2](https://github.com/esdoc/esdoc/commit/e6dc2f2cd00bff0e24f71a7485baedb79949ee94))
|
87 | - Support `decorators` ([c941951](https://github.com/esdoc/esdoc/commit/c9419512b7dda5e8f0b906945fb2a91f0b4621b3))
|
88 | - Support `export extensions` (parsing syntax only) ([8803005](https://github.com/esdoc/esdoc/commit/8803005b5927615027939ed42633bb06d060adaa))
|
89 | - Support `dynamic import` ([d729f5f](https://github.com/esdoc/esdoc/commit/d729f5f4e6ad7d7693888b43ab5d42cb78bc15dd))
|
90 | - **Feature: Manual** (see [here](https://esdoc.org/manual/usage/feature.html#integration-manual))
|
91 | - Support new sections(`advanced` and `design`) to manual ([2ebb2c6](https://github.com/esdoc/esdoc/commit/2ebb2c60e9141b4b562c0a684c21e7cfdfc94857))
|
92 | - Improve new manual index page ([0d30880](https://github.com/esdoc/esdoc/commit/0d30880e58264f3bc0069246df4a6a3e6058a69b))
|
93 | - Use manual as global index ([a887852](https://github.com/esdoc/esdoc/commit/a887852316c2c29ea377ed67d9415bf11dc1b630))
|
94 | - **Feature: Config**
|
95 | - Support automatically finding config ([08fa2bc](https://github.com/esdoc/esdoc/commit/08fa2bc296b552168f86538561174e010a3a2f14))
|
96 | - `.esdoc.json` in current directory
|
97 | - `.esdoc.js` in current directory
|
98 | - `esdoc` property in `package.json`
|
99 | - **Internal**
|
100 | - Update to babel6 ([149914e](https://github.com/esdoc/esdoc/commit/149914e84cb3bb061f2bdf2e43af00178b131a9e))
|
101 | - Refactor test codes ([#324](https://github.com/esdoc/esdoc/pull/324))
|
102 | - Remove internal private tags ([#325](https://github.com/esdoc/esdoc/pull/325))
|
103 | - Use ESLint ([#326](https://github.com/esdoc/esdoc/pull/326))
|
104 |
|
105 | ## 0.4.8 (2016-08-07)
|
106 | - **Feat**
|
107 | - Through more info to plugins ([#263](https://github.com/esdoc/esdoc/pull/263)) Thanks [@typhonrt](https://github.com/typhonrt)
|
108 | - **Fix**
|
109 | - Not work ``@link`` at property description ([#246](https://github.com/esdoc/esdoc/issues/246))
|
110 | - Crash when function name includes member expression ([#297](https://github.com/esdoc/esdoc/issues/297))
|
111 |
|
112 | ## 0.4.7 (2016-05-02)
|
113 | - **Fix**
|
114 | - Broken if identifier name is stared with ``B`` ([#224](https://github.com/esdoc/esdoc/issues/224))
|
115 | - Broken dependency package
|
116 |
|
117 | ## 0.4.6 (2016-03-06)
|
118 | - **Fix**
|
119 | - Crash when the manual has HTML comments ([#231](https://github.com/esdoc/esdoc/issues/231), [#239](https://github.com/esdoc/esdoc/pull/239)) Thanks [@staltz](https://github.com/staltz)
|
120 | - Broken output when repository url is ``git+https://`` style ([#235](https://github.com/esdoc/esdoc/issues/235), [#236](https://github.com/esdoc/esdoc/pull/236)) Thanks [@jamsyoung](https://github.com/jamsyoung)
|
121 |
|
122 | ## 0.4.5 (2016-02-14)
|
123 | - **Fix**
|
124 | - Make a mistake lint for array destructuring ([#178](https://github.com/esdoc/esdoc/issues/178))
|
125 | - Comment syntax(white space) is too strict ([#181](https://github.com/esdoc/esdoc/issues/181))
|
126 | - Broken param parsed result if description has ``{}`` ([#185](https://github.com/esdoc/esdoc/issues/185))
|
127 | - Link does not work when identifier name has ``$`` ([#218](https://github.com/esdoc/esdoc/issues/218))
|
128 |
|
129 | ## 0.4.4 (2016-02-06)
|
130 | - **Feat**
|
131 | - Can resolve import file path that has no file extension ([#160](https://github.com/esdoc/esdoc/issues/160))
|
132 | - ``onHandleHTML`` has the target filename ([#175](https://github.com/esdoc/esdoc/pull/175)) Thanks [@skratchdot](https://github.com/skratchdot)
|
133 | - **Fix**
|
134 | - Breaking document if comment has tab ([#127](https://github.com/esdoc/esdoc/issues/127)) Thanks [@developit](https://github.com/developit)
|
135 | - Crash indirect instance export ([#166](https://github.com/esdoc/esdoc/issues/166)) Thanks [@kogai](https://github.com/kogai)
|
136 |
|
137 | ## 0.4.3 (2015-11-02)
|
138 | - **Fix**
|
139 | - Lock npm modules
|
140 |
|
141 | ## 0.4.2 (2015-11-01)
|
142 | - **Fix**
|
143 | - Crash when not initialized declaration ([#126](https://github.com/esdoc/esdoc/issues/126))
|
144 | - Crash when ``@param`` description has ``{@link foo}`` ([#129](https://github.com/esdoc/esdoc/issues/129))
|
145 | - Allow particular HTML tags in each descriptions ([#130](https://github.com/esdoc/esdoc/issues/130))
|
146 | - Crash when record + union type is exists ([#152](https://github.com/esdoc/esdoc/issues/152))
|
147 |
|
148 | ## 0.4.1 (2015-10-18)
|
149 | - **Breaking**
|
150 | - Support multi files in manual ([#124](https://github.com/esdoc/esdoc/issues/124))
|
151 | - **Feat**
|
152 | - Support tutorial and configuration in manual ([#122](https://github.com/esdoc/esdoc/issues/122))
|
153 | - Support image in manual ([#123](https://github.com/esdoc/esdoc/issues/123))
|
154 | - **Fix**
|
155 | - Crash if method is generator + computed + member-expression ([#107](https://github.com/esdoc/esdoc/issues/107))
|
156 | - Not resolved ``@link`` in summary ([#110](https://github.com/esdoc/esdoc/issues/110))
|
157 | - Invalid param name when description has ``@link`` ([#119](https://github.com/esdoc/esdoc/issues/119))
|
158 |
|
159 | ## 0.4.0 (2015-10-04)
|
160 | - **Feat**
|
161 | - Support manual(overview, installation, usage, etc) into documentation ([#102](https://github.com/esdoc/esdoc/issues/102))
|
162 | - Support documentation lint ([#103](https://github.com/esdoc/esdoc/issues/103))
|
163 |
|
164 | ## 0.3.1 (2015-09-27)
|
165 | - **Fix**
|
166 | - Multi-line description truncated in summary ([#85](https://github.com/esdoc/esdoc/issues/85))
|
167 |
|
168 | ## 0.3.0 (2015-09-21)
|
169 | - **Breaking**
|
170 | - Change side bar navigation style ([#84](https://github.com/esdoc/esdoc/issues/84))
|
171 | - **Fix**
|
172 | - Inner link in user markdown ([#80](https://github.com/esdoc/esdoc/issues/80))
|
173 |
|
174 | ## 0.2.6 (2015-09-13)
|
175 | - **Fix**
|
176 | - Crash when array destructuring is exist ([#77](https://github.com/esdoc/esdoc/pull/77) Thanks @noraesae, [#76](https://github.com/esdoc/esdoc/issues/76))
|
177 | - Crash when computed property method is exist ([#78](https://github.com/esdoc/esdoc/pull/78) Thanks @noraesae, [#73](https://github.com/esdoc/esdoc/issues/73))
|
178 | - Crash when loading config without .js and .json ([#74](https://github.com/esdoc/esdoc/issues/74))
|
179 | - Crash when unknown class new expression variable is exist ([#75](https://github.com/esdoc/esdoc/issues/75))
|
180 |
|
181 | ## 0.2.5 (2015-09-06)
|
182 | - **Feat**
|
183 | - Support JavaScript code as esdoc config ([#71](https://github.com/esdoc/esdoc/pull/71) Thanks @raveclassic)
|
184 | - Add ``config.includeSource`` ([#67](https://github.com/esdoc/esdoc/issues/67), [#68](https://github.com/esdoc/esdoc/issues/68))
|
185 | - If you do not want to include source code into documentation, set ``config.includeSource: false``
|
186 | - Display undocument lines in source file ([#61](https://github.com/esdoc/esdoc/issues/61))
|
187 | - **Fix**
|
188 | - Excludes member that has same name getter/setter/method ([#64](https://github.com/esdoc/esdoc/issues/64), [#70](https://github.com/esdoc/esdoc/issues/70))
|
189 | - Crash when destructuring is exist at top ([#65](https://github.com/esdoc/esdoc/issues/65))
|
190 |
|
191 | ## 0.2.4 (2015-08-30)
|
192 | - **Fix**
|
193 | - Crash if un-initialized let/const variables are exist ([#60](https://github.com/esdoc/esdoc/issues/60))
|
194 | - Invalid documentation when computed members(``this[prop] = 123``) are exist ([#59](https://github.com/esdoc/esdoc/issues/59))
|
195 |
|
196 | ## 0.2.3 (2015-08-29)
|
197 | - **Fix**
|
198 | - Fail if config.source is ``./`` ([#56](https://github.com/esdoc/esdoc/issues/56))
|
199 | - Not match ``includes, excludes`` in config ([#57](https://github.com/esdoc/esdoc/issues/57))
|
200 | - Not process ``@param`` in ``@typedef`` of function ([#58](https://github.com/esdoc/esdoc/issues/58))
|
201 |
|
202 | ## 0.2.2 (2015-08-23)
|
203 | - **Fix**
|
204 | - Badge color ([645a256](https://github.com/esdoc/esdoc/commit/645a2569c4d814a0a494d3759d2b3be47c68f25f))
|
205 | - Crash if package.json is not exits ([#50](https://github.com/esdoc/esdoc/issues/50))
|
206 | - **Deprecated**
|
207 | - config.importPathPrefix ([#46](https://github.com/esdoc/esdoc/issues/46))
|
208 | - coverage badge in README.md ([#47](https://github.com/esdoc/esdoc/issues/47))
|
209 |
|
210 | ## 0.2.1 (2015-08-09)
|
211 | - **Fix**
|
212 | - Fail loading plugin ([#44](https://github.com/esdoc/esdoc/issues/44))
|
213 |
|
214 | ## 0.2.0 (2015-08-03)
|
215 | - **Feat**
|
216 | - Support coverage badge ([#34](https://github.com/h13i32maru/esdoc/issues/34))
|
217 | - Plugin feature ([#27](https://github.com/h13i32maru/esdoc/issues/27))
|
218 | - **Fix**
|
219 | - Anonymous class document tag ([#38](https://github.com/h13i32maru/esdoc/issues/38))
|
220 | - Repository style in package.json ([#39](https://github.com/esdoc/esdoc/pull/39)) Thanks [@r7kamura](https://github.com/r7kamura)
|
221 | - Repeat @typedef in document ([#40](https://github.com/esdoc/esdoc/issues/40))
|
222 |
|
223 | ## 0.1.4 (2015-07-20)
|
224 | - **Feat**
|
225 | - Support Complex class extends ([#26](https://github.com/h13i32maru/esdoc/issues/26))
|
226 | - Support caption tag in ``@example`` ([#33](https://github.com/h13i32maru/esdoc/issues/33))
|
227 | - Support separated function and variable exporting ([#30](https://github.com/h13i32maru/esdoc/issues/30))
|
228 | - **Fix**
|
229 | - Crash when object pattern argument does not have @param ([#24](https://github.com/h13i32maru/esdoc/issues/24))
|
230 |
|
231 | ## 0.1.3 (2015-07-05)
|
232 | - **Feat**
|
233 | - Support instance export([#11](https://github.com/h13i32maru/esdoc/issues/11), [#19](https://github.com/h13i32maru/esdoc/issues/19))
|
234 | - ``export default new Foo()``
|
235 | - ``export let foo = new Foo()``
|
236 | - Support anonymous class/function export ([#13](https://github.com/h13i32maru/esdoc/issues/13))
|
237 | - ``export default class{}`` and ``export default function(){}``
|
238 | - Show a detail log when ESDoc could not process a input code ([#14](https://github.com/h13i32maru/esdoc/issues/14))
|
239 | - Support ``git@github.com:foo/bar.git`` style url ([#22](https://github.com/h13i32maru/esdoc/issues/22))
|
240 | - **Fix**
|
241 | - Broken ``@desc`` when it has html code ([#12](https://github.com/h13i32maru/esdoc/issues/12))
|
242 | - Crash complex ``ExportDefaultDeclaration`` and ``ExportNamedDeclaration``([957d61a](https://github.com/h13i32maru/esdoc/commit/957d61a8febb4fe3dda4d65bae8dc1cbc210250c))
|
243 | - Crash when a class extends unexported class ([bf87643](https://github.com/h13i32maru/esdoc/commit/bf876430c49937932b2ba07602363b6927f211cc))
|
244 | - Tab in document tag ([#20](https://github.com/h13i32maru/esdoc/pull/20))
|
245 | - **Internal**
|
246 | - Change internal tags name ([#23](https://github.com/h13i32maru/esdoc/issues/23))
|
247 |
|
248 | ## 0.1.2 (2015-06-06)
|
249 | - **Breaking Changes**
|
250 | - drop `esdoc ./path/to/dir` implementation ([b4d2121](https://github.com/h13i32maru/esdoc/commit/b4d21219221b8307a155fdee85e2ed5fed9c4429))
|
251 | - **Fix**
|
252 | - Fail parsing of React JSX syntax ([#3](https://github.com/h13i32maru/esdoc/pull/3)). Thank you [@koba04](https://github.com/koba04)
|
253 | - Home link does not work as expected ([97f47cf](https://github.com/h13i32maru/esdoc/commit/97f47cf8a8e90cdd6066417fbe9ce835e8a370c8))
|
254 | - Separated export is not shown in document ([6159c3a](https://github.com/h13i32maru/esdoc/commit/6159c3ad28f5c0736d2a2c22f39c94e2e1b6de61))
|
255 | - Crash when a class extends nested super class. ([2d634d0](https://github.com/h13i32maru/esdoc/commit/2d634d06f7a9475e92fae5c0773dfae579b5b314))
|
256 | - Web font loading protocol ([5ba8d82](https://github.com/h13i32maru/esdoc/commit/5ba8d82684d84a498e5285c929bbfcccc5ca6013))
|
257 |
|
258 | ## 0.1.1 (2015-05-10)
|
259 | - **Feat**
|
260 | - Support Windows ([edd09cb](https://github.com/h13i32maru/esdoc/commit/edd09cbdf5f4032aa59a5e6e59ab62727475a61a) , [2d34d46](https://github.com/h13i32maru/esdoc/commit/2d34d464f4584820450041bff2e64888b08b5aad))
|
261 |
|
262 | ## 0.1.0 (2015-05-05)
|
263 | - First release
|