esdoc/CHANGELOG.md

Good Documentation Generator For JavaScript

# Changelog

## 1.1.0 (2018-04-29)
- **Feat**
  - Add `config.outputAST` ([#483](https://github.com/esdoc/esdoc/pull/483)). Thanks [@MattMcFarland](https://github.com/MattMcFarland)
  - Add `@package` tag ([#486](https://github.com/esdoc/esdoc/pull/486)). Thanks [@bmaupin](https://github.com/bmaupin)
- **Fix**
  - Crash if `config.index` file was not found ([#490](https://github.com/esdoc/esdoc/pull/490)). Thanks [@22a](https://github.com/22a)
- **Chore**
  - Update `marked`. ([#503](https://github.com/esdoc/esdoc/pull/503)) Thanks [@jan-molak](https://github.com/jan-molak)
  - Update some packages.

## 1.0.4 (2017-11-12)
- **Fix**
  - Fix `import { type foo } from './Bar'` (flowtype syntax). ([#464](https://github.com/esdoc/esdoc/pull/464)) Thanks [@mprobber](https://github.com/mprobber)
  - Fix decorate that has object literal arguments. ([#472](https://github.com/esdoc/esdoc/pull/472)) Thanks [@mysim1](https://github.com/mysim1)

## 1.0.3 (2017-09-20)
- **Fix**
  - Broken if using `@foo.bar` decorator. ([#439](https://github.com/esdoc/esdoc/issues/439))

## 1.0.2 (2017-09-03)
- **Fix**
  - Broken if code block has `@`. ([#436](https://github.com/esdoc/esdoc/pull/436)) Thanks [@pzuraq](https://github.com/pzuraq)
  - Broken if anonymous default export is exist. ([#431](https://github.com/esdoc/esdoc/issues/431)) Thanks [@zemzheng](https://github.com/zemzheng)
  - Broken if expression extends is exist. ([#409](https://github.com/esdoc/esdoc/pull/409)) Thanks [@dimitryvolkov](https://github.com/dimitryvolkov)

## 1.0.1 (2017-07-30)
- **Breaking**
  - Some features were carved out to plugins
    - [Migration to v1.0](https://esdoc.org/manual/migration.html)
    - [v0.5 documentation](https://esdoc.org/v0.5/index.html)
- **Feat**
  - [esdoc-publish-markdown-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-publish-markdown-plugin) PoC
  - [esdoc-flow-type-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-flow-type-plugin) PoC
  - [esdoc-typescript-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-typescript-plugin) PoC
  - [esdoc-react-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-react-plugin) PoC
  - [esdoc-jsx-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-jsx-plugin)
- **Note**
  - `v1.0.0` can not use. Because `v1.0.0` had been used in past.

## 0.5.2 (2017-01-02)
- **Fix**
  - Display error message when invalid function type ([#351](https://github.com/esdoc/esdoc/issues/351)) Thanks [@LukasHechenberger](https://github.com/LukasHechenberger)
  - Crash when destructure sparse array ([#350](https://github.com/esdoc/esdoc/issues/350))
  - Crash when guess type of array detructuring ([#301](https://github.com/esdoc/esdoc/issues/301))
  - A union type in a generics type ([eb051e7](https://github.com/esdoc/esdoc/commit/eb051e729b83bca552a3d4b43351dc1272ee4154))
  - A union type with a spread type ([199d834](https://github.com/esdoc/esdoc/commit/199d834cfe68ba986212b51cb59ea2d9de55ba1c))
  - Crash when function was assigned by member expression ([e59820a](https://github.com/esdoc/esdoc/commit/e59820aed2f3e2091f32d35de34925d0132630e0))
  - Broken to guess type when property has null value or object expression using string key ([5920c1f](https://github.com/esdoc/esdoc/commit/5920c1f91633202ec795f360bb0ac12f68f258f2))
  - 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)
- **Feat**
  - Automatically take a super class description if the method override a super class method. ([7b515f0](https://github.com/esdoc/esdoc/commit/7b515f0367a386ceb732b4606b96abf24bfab627))

## 0.5.1 (2016-12-26)
- **Fix**
  - Fix a message when could not parse the codes ([a98a83c](https://github.com/esdoc/esdoc/commit/a98a83c2cdb2904e2f8a246dee8cf886da47fc48))
  - Fix a help message ([a16e2c1](https://github.com/esdoc/esdoc/commit/a16e2c121989d7a294d2cf2b6c2b1d1ec32f4277))

## 0.5.0 (2016-12-25)
ESDoc logo was out!

<img src="https://esdoc.org/manual/asset/image/logo.png" width="100px" class="no-shadow"/>

- **Breaking**
  - Require node v6 or later ([a5b37bd](https://github.com/esdoc/esdoc/commit/a5b37bd0c68304214185f765f617b1077bee81b7))
  - Switch the ES parser to babylon from espree ([8130a3f](https://github.com/esdoc/esdoc/commit/8130a3f42b497e81f9ec6fc4cf0ef07ed5a7fa22))
    - `onHandleAST` in plugin is breaking
  - Remove `config.importPathPrefix` ([a665c5d](https://github.com/esdoc/esdoc/commit/a665c5d8c2c2a58cbe108ab3ecc8afc346c80ccf))
    - Use [ESDoc Import Path Plugin](https://github.com/esdoc/esdoc-importpath-plugin) instead of it
  - Remove `badge tag` in README ([6869b06](https://github.com/esdoc/esdoc/commit/6869b06e293c2471978ef96882baef6cc14c1766)) 
    - Use badge of [ESDoc Hosting Service](https://doc.esdoc.org)
- **Feature: ES2015**
  - Support `arrow function` ([964eda3](https://github.com/esdoc/esdoc/commit/964eda3d4e2da6e5d92b3a6502a4b2d01422b692))
- **Feature: ES2016**
  - Support `exponentiation operator` ([29f6ccc](https://github.com/esdoc/esdoc/commit/29f6ccced4256016fed4ac8eb5b98320cd78c4d7))
- **Feature: ES2017**
  - Support `async function` ([50452a1](https://github.com/esdoc/esdoc/commit/50452a1e44a1c8908da1fb377d3aa51eba220256))
  - Support `trailing comma` ([dc9ba0f](https://github.com/esdoc/esdoc/commit/dc9ba0fd904adbc1519f27c15fab104f1a4414a5))
- **Feature: ECMAScript Proposal** (see [here](https://esdoc.org/manual/usage/feature.html#ecmascript-proposal))
  - Support `class properties` ([c7b4d9b](https://github.com/esdoc/esdoc/commit/c7b4d9b415812cf18c451b1a452c9725593d3891))
  - Support `object rest spread` ([b58aa05](https://github.com/esdoc/esdoc/commit/b58aa054620e7335d7dcf8e0c81d4cb221e1fc6e))
  - Support `do expressions` ([33daf5a](https://github.com/esdoc/esdoc/commit/33daf5a89dcdd3cd72a3d8b74829861f2c08e18e))
  - Support `function bind` ([5b7a7d0](https://github.com/esdoc/esdoc/commit/5b7a7d06028e432d1e23b43963905c1a76b102b2))
  - Support `function sent` ([fe8a265](https://github.com/esdoc/esdoc/commit/fe8a2656a93cfae51c0a541f291f3f32330aec3b))
  - Support `async generators` ([e6dc2f2](https://github.com/esdoc/esdoc/commit/e6dc2f2cd00bff0e24f71a7485baedb79949ee94))
  - Support `decorators` ([c941951](https://github.com/esdoc/esdoc/commit/c9419512b7dda5e8f0b906945fb2a91f0b4621b3))
  - Support `export extensions` (parsing syntax only) ([8803005](https://github.com/esdoc/esdoc/commit/8803005b5927615027939ed42633bb06d060adaa))
  - Support `dynamic import` ([d729f5f](https://github.com/esdoc/esdoc/commit/d729f5f4e6ad7d7693888b43ab5d42cb78bc15dd))
- **Feature: Manual** (see [here](https://esdoc.org/manual/usage/feature.html#integration-manual))
  - Support new sections(`advanced` and `design`) to manual ([2ebb2c6](https://github.com/esdoc/esdoc/commit/2ebb2c60e9141b4b562c0a684c21e7cfdfc94857))
  - Improve new manual index page ([0d30880](https://github.com/esdoc/esdoc/commit/0d30880e58264f3bc0069246df4a6a3e6058a69b))
  - Use manual as global index ([a887852](https://github.com/esdoc/esdoc/commit/a887852316c2c29ea377ed67d9415bf11dc1b630))
- **Feature: Config**
  - Support automatically finding config ([08fa2bc](https://github.com/esdoc/esdoc/commit/08fa2bc296b552168f86538561174e010a3a2f14))
    - `.esdoc.json` in current directory
    - `.esdoc.js` in current directory
    - `esdoc` property in `package.json`
- **Internal**
  - Update to babel6 ([149914e](https://github.com/esdoc/esdoc/commit/149914e84cb3bb061f2bdf2e43af00178b131a9e))
  - Refactor test codes ([#324](https://github.com/esdoc/esdoc/pull/324))
  - Remove internal private tags ([#325](https://github.com/esdoc/esdoc/pull/325))
  - Use ESLint ([#326](https://github.com/esdoc/esdoc/pull/326))

## 0.4.8 (2016-08-07)
- **Feat**
  - Through more info to plugins ([#263](https://github.com/esdoc/esdoc/pull/263)) Thanks [@typhonrt](https://github.com/typhonrt)
- **Fix**
  - Not work ``@link`` at property description ([#246](https://github.com/esdoc/esdoc/issues/246))
  - Crash when function name includes member expression ([#297](https://github.com/esdoc/esdoc/issues/297))

## 0.4.7 (2016-05-02)
- **Fix**
  - Broken if identifier name is stared with ``B`` ([#224](https://github.com/esdoc/esdoc/issues/224))
  - Broken dependency package

## 0.4.6 (2016-03-06)
- **Fix**
  - 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)
  - 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)

## 0.4.5 (2016-02-14)
- **Fix**
  - Make a mistake lint for array destructuring ([#178](https://github.com/esdoc/esdoc/issues/178))
  - Comment syntax(white space) is too strict ([#181](https://github.com/esdoc/esdoc/issues/181))
  - Broken param parsed result if description has ``{}`` ([#185](https://github.com/esdoc/esdoc/issues/185))
  - Link does not work when identifier name has ``$`` ([#218](https://github.com/esdoc/esdoc/issues/218))

## 0.4.4 (2016-02-06)
- **Feat**
  - Can resolve import file path that has no file extension ([#160](https://github.com/esdoc/esdoc/issues/160))
  - ``onHandleHTML`` has the target filename ([#175](https://github.com/esdoc/esdoc/pull/175)) Thanks [@skratchdot](https://github.com/skratchdot)
- **Fix**
  - Breaking document if comment has tab ([#127](https://github.com/esdoc/esdoc/issues/127)) Thanks [@developit](https://github.com/developit)
  - Crash indirect instance export ([#166](https://github.com/esdoc/esdoc/issues/166)) Thanks [@kogai](https://github.com/kogai)

## 0.4.3 (2015-11-02)
- **Fix**
  - Lock npm modules

## 0.4.2 (2015-11-01)
- **Fix**
  - Crash when not initialized declaration ([#126](https://github.com/esdoc/esdoc/issues/126))
  - Crash when ``@param`` description has ``{@link foo}`` ([#129](https://github.com/esdoc/esdoc/issues/129))
  - Allow particular HTML tags in each descriptions ([#130](https://github.com/esdoc/esdoc/issues/130))
  - Crash when record + union type is exists ([#152](https://github.com/esdoc/esdoc/issues/152))

## 0.4.1 (2015-10-18)
- **Breaking**
  - Support multi files in manual ([#124](https://github.com/esdoc/esdoc/issues/124))
- **Feat**
  - Support tutorial and configuration in manual ([#122](https://github.com/esdoc/esdoc/issues/122))
  - Support image in manual ([#123](https://github.com/esdoc/esdoc/issues/123))
- **Fix**
  - Crash if method is generator + computed + member-expression ([#107](https://github.com/esdoc/esdoc/issues/107))
  - Not resolved ``@link`` in summary ([#110](https://github.com/esdoc/esdoc/issues/110))
  - Invalid param name when description has ``@link`` ([#119](https://github.com/esdoc/esdoc/issues/119))

## 0.4.0 (2015-10-04)
- **Feat**
  - Support manual(overview, installation, usage, etc) into documentation ([#102](https://github.com/esdoc/esdoc/issues/102))
  - Support documentation lint ([#103](https://github.com/esdoc/esdoc/issues/103))

## 0.3.1 (2015-09-27)
- **Fix**
  - Multi-line description truncated in summary ([#85](https://github.com/esdoc/esdoc/issues/85))

## 0.3.0 (2015-09-21)
- **Breaking**
  - Change side bar navigation style ([#84](https://github.com/esdoc/esdoc/issues/84))
- **Fix**
  - Inner link in user markdown ([#80](https://github.com/esdoc/esdoc/issues/80))

## 0.2.6 (2015-09-13)
- **Fix**
  - Crash when array destructuring is exist ([#77](https://github.com/esdoc/esdoc/pull/77) Thanks @noraesae, [#76](https://github.com/esdoc/esdoc/issues/76))
  - 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))
  - Crash when loading config without .js and .json ([#74](https://github.com/esdoc/esdoc/issues/74))
  - Crash when unknown class new expression variable is exist ([#75](https://github.com/esdoc/esdoc/issues/75))

## 0.2.5 (2015-09-06)
- **Feat**
  - Support JavaScript code as esdoc config ([#71](https://github.com/esdoc/esdoc/pull/71) Thanks @raveclassic)
  - Add ``config.includeSource`` ([#67](https://github.com/esdoc/esdoc/issues/67), [#68](https://github.com/esdoc/esdoc/issues/68))
    - If you do not want to include source code into documentation, set ``config.includeSource: false``
  - Display undocument lines in source file ([#61](https://github.com/esdoc/esdoc/issues/61))
- **Fix**
  - 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))
  - Crash when destructuring is exist at top ([#65](https://github.com/esdoc/esdoc/issues/65))

## 0.2.4 (2015-08-30)
- **Fix**
  - Crash if un-initialized let/const variables are exist ([#60](https://github.com/esdoc/esdoc/issues/60))
  - Invalid documentation when computed members(``this[prop] = 123``) are exist ([#59](https://github.com/esdoc/esdoc/issues/59))

## 0.2.3 (2015-08-29)
- **Fix**
  - Fail if config.source is ``./`` ([#56](https://github.com/esdoc/esdoc/issues/56))
  - Not match ``includes, excludes`` in config ([#57](https://github.com/esdoc/esdoc/issues/57))
  - Not process ``@param`` in ``@typedef`` of function ([#58](https://github.com/esdoc/esdoc/issues/58))

## 0.2.2 (2015-08-23)
- **Fix**
  - Badge color ([645a256](https://github.com/esdoc/esdoc/commit/645a2569c4d814a0a494d3759d2b3be47c68f25f))
  - Crash if package.json is not exits ([#50](https://github.com/esdoc/esdoc/issues/50))
- **Deprecated**
  - config.importPathPrefix ([#46](https://github.com/esdoc/esdoc/issues/46))
  - coverage badge in README.md ([#47](https://github.com/esdoc/esdoc/issues/47))

## 0.2.1 (2015-08-09)
- **Fix**
  - Fail loading plugin ([#44](https://github.com/esdoc/esdoc/issues/44))

## 0.2.0 (2015-08-03)
- **Feat**
  - Support coverage badge ([#34](https://github.com/h13i32maru/esdoc/issues/34))
  - Plugin feature ([#27](https://github.com/h13i32maru/esdoc/issues/27))
- **Fix**
  - Anonymous class document tag ([#38](https://github.com/h13i32maru/esdoc/issues/38))
  - Repository style in package.json ([#39](https://github.com/esdoc/esdoc/pull/39)) Thanks [@r7kamura](https://github.com/r7kamura)
  - Repeat @typedef in document ([#40](https://github.com/esdoc/esdoc/issues/40))

## 0.1.4 (2015-07-20)
- **Feat**
  - Support Complex class extends ([#26](https://github.com/h13i32maru/esdoc/issues/26))
  - Support caption tag in ``@example`` ([#33](https://github.com/h13i32maru/esdoc/issues/33))
  - Support separated function and variable exporting ([#30](https://github.com/h13i32maru/esdoc/issues/30))
- **Fix**
  - Crash when object pattern argument does not have @param ([#24](https://github.com/h13i32maru/esdoc/issues/24))

## 0.1.3 (2015-07-05)
- **Feat**
  - Support instance export([#11](https://github.com/h13i32maru/esdoc/issues/11), [#19](https://github.com/h13i32maru/esdoc/issues/19))
    - ``export default new Foo()``
    - ``export let foo = new Foo()``
  - Support anonymous class/function export ([#13](https://github.com/h13i32maru/esdoc/issues/13))
    - ``export default class{}`` and ``export default function(){}``
  - Show a detail log when ESDoc could not process a input code ([#14](https://github.com/h13i32maru/esdoc/issues/14))
  - Support ``git@github.com:foo/bar.git`` style url ([#22](https://github.com/h13i32maru/esdoc/issues/22))
- **Fix**
  - Broken ``@desc`` when it has html code ([#12](https://github.com/h13i32maru/esdoc/issues/12))
  - Crash complex ``ExportDefaultDeclaration`` and ``ExportNamedDeclaration``([957d61a](https://github.com/h13i32maru/esdoc/commit/957d61a8febb4fe3dda4d65bae8dc1cbc210250c))
  - Crash when a class extends unexported class ([bf87643](https://github.com/h13i32maru/esdoc/commit/bf876430c49937932b2ba07602363b6927f211cc))
  - Tab in document tag ([#20](https://github.com/h13i32maru/esdoc/pull/20))
- **Internal**
  - Change internal tags name ([#23](https://github.com/h13i32maru/esdoc/issues/23))

## 0.1.2 (2015-06-06)
- **Breaking Changes**
  - drop `esdoc ./path/to/dir` implementation ([b4d2121](https://github.com/h13i32maru/esdoc/commit/b4d21219221b8307a155fdee85e2ed5fed9c4429))
- **Fix**
  - Fail parsing of React JSX syntax ([#3](https://github.com/h13i32maru/esdoc/pull/3)). Thank you [@koba04](https://github.com/koba04)
  - Home link does not work as expected ([97f47cf](https://github.com/h13i32maru/esdoc/commit/97f47cf8a8e90cdd6066417fbe9ce835e8a370c8))
  - Separated export is not shown in document ([6159c3a](https://github.com/h13i32maru/esdoc/commit/6159c3ad28f5c0736d2a2c22f39c94e2e1b6de61))
  - Crash when a class extends nested super class. ([2d634d0](https://github.com/h13i32maru/esdoc/commit/2d634d06f7a9475e92fae5c0773dfae579b5b314))
  - Web font loading protocol ([5ba8d82](https://github.com/h13i32maru/esdoc/commit/5ba8d82684d84a498e5285c929bbfcccc5ca6013))

## 0.1.1 (2015-05-10)
- **Feat**
  - Support Windows ([edd09cb](https://github.com/h13i32maru/esdoc/commit/edd09cbdf5f4032aa59a5e6e59ab62727475a61a) , [2d34d46](https://github.com/h13i32maru/esdoc/commit/2d34d464f4584820450041bff2e64888b08b5aad))

## 0.1.0 (2015-05-05)
- First release