91 Commits

Author SHA1 Message Date
Tom MacWright
bbc988e9fd
Patch 11 (#1289)
* specify page lang in HTML template

Good practise to include this.
REF: https://www.w3.org/International/questions/qa-html-language-declarations

* Update snapshot
2019-10-11 12:58:05 -07:00
Vladimir Agafonkin
27a29be207 fix: Git submodule support for repo names with a dot (#1271) 2019-08-01 15:38:33 -07:00
Vladimir Agafonkin
ec36b41aa9 feat: Add git submodules support to github linking (#1270)
* add git submodules support in github linking

* more reliable submodule origin parsing
2019-07-31 16:40:22 -07:00
Tom MacWright
f9039e9614
fix: Allow skipped array arguments in destructuring. Fixes #1247 (#1266) 2019-07-22 14:01:43 -07:00
Tom MacWright
4fd8552dbb deps: Upgrade vfile 2019-07-09 21:56:26 -07:00
Tom MacWright
ca17de55ff fix: Fix parsing of optional parameters with annotations 2019-05-08 14:49:45 -07:00
Tom MacWright
4ea3a95539 test: Fix markdown test snapshots 2019-05-07 12:46:58 -07:00
Tom MacWright
fa1b0b51d2 feat: Enable all parser plugins
BREAKING CHANGE: this removes support for legacy decorators, because
in one place we had legacy and in another we didn't.
2019-05-07 12:46:58 -07:00
Devon Govett
3773e02949 feat: TypeScript support & inference 2019-04-25 08:13:33 -07:00
Devon Govett
7947e974d8 feat: Add flow inference for generators 2019-04-18 09:47:51 -07:00
Devon Govett
8e3cd47906 feat: Support generator functions 2019-04-18 09:47:51 -07:00
Devon Govett
d31c3b70d6 feat: Support async functions 2019-04-18 09:47:51 -07:00
Devon Govett
d1ee0f3983 Merge explicit and inferred param defaults (#1230) 2019-04-18 09:37:48 -07:00
Tom MacWright
64c9ca6dac
feat: Add inner section (#1212)
* Add Inner Member section

* Update tests
2019-02-27 14:22:22 -08:00
Jonas Bögle
5b045f26c0 feat: Add favicon option (#1207) 2019-02-22 08:11:26 -08:00
Jonas Bögle
fb0a27f695 fix(default theme): only render either note or section (fixes #1113) (#1206)
* fix(default theme): only render either note or section

Fixes notes also showing up as duplicate sections.

fix #1113

* undo revertion of c5f32ae

* update test snapshot
2019-02-22 08:10:00 -08:00
Tom MacWright
c5f32ae6ae
refactor: remove text/css from default theme #1203, #1200 2019-01-25 13:41:39 -08:00
Szymon Nowacki
2d0bd0e0f7 fix: inferred properties duplicating explicitly specified ones 2018-12-21 10:01:38 -08:00
Luca Nils Schmid
ca5a681be6 feat: support spead types 2018-12-17 10:22:53 -08:00
Tom MacWright
c3aaa86dc2
refactor: remove flow and related dependencies, test on 10 not latest, skip slow tests 2018-12-09 16:56:56 -08:00
Tom MacWright
58d2a2ff53
feat: Support for the logical assignment operator
* 

Fixes #1172

* chore: Update test fixture to last release
2018-12-01 13:10:45 -08:00
Tom MacWright
35c635f0f5
test(snapshots): Update test snapshots for alpha.1 (#1190) 2018-12-01 12:57:56 -08:00
Hugo Dias
a4107dc991 fix: add tests 2018-10-24 11:07:05 -07:00
Tom MacWright
23b8ee8a62 test: Make tests resilient even for tagged semvers 2018-10-24 09:21:18 -07:00
Tom MacWright
0ecb68d6a6 chore: Update test fixture 2018-09-20 23:22:30 -07:00
Victor
49c0f72793 feat: Babel 7 support
BREAKING CHANGE: This moves documentation.js to Babel 7. From now on,
documentation.js will only support Babel 7: please stick to older
releases if you need to support Babel 6. Additionally, this work
temporarily disables support for following dynamic imports.
2018-09-20 23:21:14 -07:00
Konstantin Petryaev
40b17839a6 fix: membership infering for methods (#1122)
* Fix membership infering for methods

Improve inferMembership to allow to use next code:
```js
/**
 * @memberof BigFeature
 */
class MyClass {
  method() {}
}
```
Before this improvement, we have `method` inside
 `global.MyClass` instead of `global.BigFeature.MyClass`

* Add tests fir membership infering for methods
2018-08-23 09:55:03 -07:00
gburnett
4d59f6fdc3 fix: Serve on correct port
Update serve command to pass object to get-port
2018-08-17 07:40:53 -07:00
Max Schmitt
45a9ea924a feat: added project description 2018-08-03 15:35:25 -07:00
Tom MacWright
1cbf3d28a9 chore: Update snapshots 2018-07-15 20:43:11 -07:00
Jayden Seric
ca6217fb19 feat: Semantic markdown headings (#1087)
- Previously, headers were displayed using `p` and `strong` tags. This is semantically incorrect, and would cause subheadings to display larger than headings for nested sections on platforms such as Github.
- “Parameters”, “Properties”, and “Examples” now render as headings with a dynamic level greater than the heading they are nested under.

BREAKING CHANGE: changes Markdown output
2018-06-04 11:51:09 -07:00
Felix Gnass
46ee751f45 test: flow comment types 2018-05-26 10:17:24 -07:00
Tom MacWright
4fd776b16a
feat: Auto-detect readme filename
BREAKING CHANGE: the --readme-file option now has a smart default value
2018-05-21 20:44:59 -07:00
Tom MacWright
8f9bc7b353
fix(vue): Make vue parser tolerant of components that don't contain scripts (#1061)
Fixes #1060
2018-04-24 13:14:16 -07:00
Reinier Battenberg
9d7bd2eff6 fix: adding vue support broke tests that are not file based (#1058)
* fix: adding vue support broke tests that are not file based

fix #1057

* Got the tests and code working for supporting non-file documenting

* Added fresh snapshot
2018-04-23 10:53:07 -07:00
Tom MacWright
f60d90cf9e
feat: Vue Support
Thanks to @batje, documentation.js now supports Vue! .vue files are parsed for their JavaScript contents by default.
2018-04-20 11:45:14 -07:00
Tom MacWright
0e23b7cdc0 test: Another tweak to make tests resistant to versioning 2018-04-11 11:51:22 -07:00
Bohdan Lyzanets
630625d04e fix: get rid of shelljs dependency 2018-04-11 10:33:25 -07:00
Tom MacWright
b309d39e93 feat(doctrine): Support decorator syntax in examples
Support decorators is an unspecified part of JSDoc: we're just going forward and implementing a new
syntax here because it's unlikely that JSDoc will move fast enough.

Fixes #1016
2018-04-11 10:33:09 -07:00
Tom MacWright
22d8740c23 feat(inferTypes): Support class properties
Previously we did not properly infer params on methods that were located on class properties. This
changes things so that we do. It carefully tries to avoid messing up the existing support of class
type annotations, which are similar to class properties at the AST level, but do not have an
associated node, only a type alias.

Fixes #1043
2018-04-11 10:16:38 -07:00
Tom MacWright
6bf3f9716d
test: Make tests resilient between versions: no more annoying chores (#1045) 2018-04-11 09:10:07 -07:00
Tim De Pauw
4ed5edf88d feat: Support class property @type tag (#1028) 2018-03-07 16:12:17 -08:00
Maciej Kasprzyk
99ad49b833 fix: lends with object property using literal key (#1035) 2018-03-03 17:25:51 -08:00
Tom MacWright
e1528c4ace
chore: update tests for new version 2018-03-02 08:18:30 -08:00
Tom MacWright
23315346a4
chore: update tests for last version 2018-03-01 22:25:00 -08:00
Tom MacWright
ccce516b49
feat: documentation.js now requires node v6 or newer. (#1034)
BREAKING CHANGE: documentation.js requires node v6 or newer.
2018-03-01 22:19:53 -08:00
Tom MacWright
ab494dd1b3
feat: use reference links for Markdown output, improving brevity
* Use reference links in Markdown.

Fixes https://github.com/documentationjs/documentation/issues/948.

This approach might be problematic when inserting markdown under a readme heading if the readme already has link references with conflicting ID’s.

* Reference links edits:

- fix broken normalize() utility in test suite so that it produces
  output that doesn't choke referenceLinks.
- add DocumentationConfig option `--noReferenceLinks` which will be
  **internal only**, and turns off reference links for `readme` mode
- rebuilds test output with these changes

unrelated but minor

- includes .prettierrc and updates calls to prettier to use that instead
  of CLI options

* chore: update test snapshots

* Update readme snap
2018-03-01 15:18:20 -08:00
Anatoly Bubenkov
64f660dc87 feat: Support --shallow argument for lint command. Closes #956 (#995) 2018-03-01 12:07:44 -08:00
Bob Lannon
37a91b2199 fix: github links for @typedef comments should link to comment, not context (#1024)
* github link to typedef points to comment lines

* adding test for typedef github links

* adding comment.loc for flow check

* reverting to original formatting

* use afterEach to restore mock even if tests fail

* fixing line numbers in expected value
2018-03-01 12:01:35 -08:00
John Firebaugh
487336fcd8 chore: Update tests for release (#1017) 2018-02-20 15:49:04 -08:00