51 Commits

Author SHA1 Message Date
Anton Shchekota
abb781a69a refactor: replace module-deps-sortable on own implementation to control how parse files
BREAKING CHANGE:
all Extensions whould contains '.' so that mean if you have just 'ts' then need to convert to '.ts'
2021-11-11 11:52:31 +03:00
Anton Shchekota
e3c59d77e4 fix: external was removed as prefer of input usages
BREAKING CHANGE:
external parameter was removed
Migration plan propose to move all external resources to input usages
Motivation: packages has many inputs which describe in package.json
so that mean need each time to parse all package.json of exsternal resources to understand which etry point need to pick.
But it is base on guesses because entry point may could not contains a documentation and the best way to handle it manualy.
2021-11-11 11:52:31 +03:00
Anton Shchekota
61ed5dd002 deps: update unist and highlight.js 2021-10-28 11:49:37 +03:00
Anton Shchekota
810e08b6fd fix: The server parameter deprecated and will be remove in next Major version fixed #1413
BREAKING CHANGE:
The serve parametr was remove, you can use any other tools which could be refresh and store your html site
The private parameter has removed, use a access
2021-10-25 13:23:47 +03:00
Anton Shchekota
db74e7cac9 deps: update remark deps 2021-10-20 16:51:02 +03:00
Anton Shchekota
05026ce390 refactor: convert project to ESM 2021-10-19 16:38:44 +03:00
Anton Shchekota
0e1172ea32 deps: update babel dependencies 2021-05-14 11:27:12 +03:00
Anton Shchekota
4b711da2b2 refactor: use singleton config for execution
It will be easy to not put config as parameter each time
2021-05-14 11:27:12 +03:00
Anton
806defa191
refactoring (#1376)
* refactor: replace leftPad on native implementation padStart

* refactor: migrate on new Buffer API
2021-05-04 16:25:36 +03:00
Anton
6b5bc2548d
fix: add gfm format for remark fixed #1374 (#1375)
Plugins for remark was reworks because @link should be catch by first then autolink
2021-04-24 16:02:17 -07:00
Anton
f4a46b134f
deps: update remark on last version fixed #1349 (#1370)
1. New plugins was created parse jsDoc links and remove position
2. spread: false - to remove new line after each listItem
2021-04-20 13:25:06 -07:00
Anton
f2fa522070
refactor: switch off position for remark, it is reduce size of tests and check on position (#1369) 2021-04-16 08:18:06 -07:00
Tom MacWright
dd71624412
deps: Update babel dependencies and module-deps-sortable
* fix(deps): bump @babel/core

* fix(deps): bump @babel/generator

* fix(deps): bump @babel/types

* fix(deps): bump @babel/types

* fix(deps): bump @babel/traverse

* fix(deps): bump @babel/plugin-syntax-import-meta

* fix(deps): bump @babel/preset-env

* fix(deps): bump @babel/plugin-proposal-class-properties

* fix(deps): bump @babel/plugin-proposal-*

* fix(deps): bump @babel/parser

* fix(deps): bump to unreleased module-deps-sortable

* Use new tag of module-deps-sortable

Co-authored-by: Markus Felten <Markus.Felten@gmx.de>
2020-10-24 13:48:43 -07:00
Andrew Del Prete
28867f8ebc Fix tests 2020-06-03 20:19:43 -07:00
Jason Quense
d0ec029e75 feat: upgrade babel dependencies
- Fix private method parsing/traversal
- Add TS bigint primitive
- Add flow symbol primitive
2020-04-07 08:15:29 -07:00
Tom MacWright
48bb7a283e feat: support for the @see tag in Markdown & HTML
* add @see ref support for parsing to html

* edit tests

* fix markdown issue with @see ref

* edit related title so it would not generate with see ref every time

* edit tests

* Fix tests

Co-authored-by: Vladimir Berezovsky <berezovsky@ex.ua>
2020-03-30 23:35:32 -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
ca17de55ff fix: Fix parsing of optional parameters with annotations 2019-05-08 14:49:45 -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
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
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
Max Schmitt
45a9ea924a feat: added project description 2018-08-03 15:35:25 -07:00
Felix Gnass
46ee751f45 test: flow comment types 2018-05-26 10:17:24 -07:00
Bohdan Lyzanets
630625d04e fix: get rid of shelljs dependency 2018-04-11 10:33:25 -07: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
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
Anton Shchekota
7d74060caf Eslint add new rules - no-var and prefer-const 2018-01-24 14:10:41 +03:00
Anton Shchekota
337b7a639e chore: updated jest 21 version 2017-09-29 11:56:03 +03:00
Tom MacWright
de19175980 test: Add tests for moduleFilters, tiny typo fix 2017-09-14 17:04:34 -07:00
Tom MacWright
2605a3b5fd test: Tests for dependency resolution 2017-09-14 17:04:34 -07:00
Tom MacWright
61b6976594 test: More tests 2017-09-14 17:04:34 -07:00
Tom MacWright
8779369ce5 test: Add stronger jest tests for inference 2017-09-14 16:17:15 -07:00
Tom MacWright
adf1bd04c0 test: Add specific test for quoted properties in type definitions 2017-09-14 15:57:13 -07:00
Ryan Hendrickson
5bdbf1f870 fix: cover more hideconstructor cases 2017-09-04 16:37:30 -04:00
Ryan Hendrickson
a04b6fd61d fix: @name tag disconnects comment (#897)
The previous support for @name tags suppressing inference from
surrounding code was ad-hoc and incomplete. This commit makes a @name
tag (or a tag acting as a @kind/@name shorthand combo, like @function)
detach the `ast` field from the comment context, so that the surrounding
code will be universally ignored per the JSDoc spec.
2017-09-03 23:44:55 -07:00
Ryan Hendrickson
c94412a7aa feat: groups in toc (#895) 2017-09-03 23:44:31 -07:00
Ryan Hendrickson
7a07d5118d feat: implement @hideconstructor (#898)
Per usejsdoc.org, this tag goes either in a comment attached to a
function that has declared that function to be a class, or in a comment
on an ES6 class constructor.
2017-09-03 23:07:13 -07:00
Andrew Hutchings
23aa981c30 feat: convert Flow's ThisTypeAnnotation to a doctrine NameExpression (#870) 2017-08-09 09:21:54 -07:00
Anton
aa3496af90 fix: alphabetical sort and add flow notation to sort file (#861)
* Removed sort by memberof, when the memberOf is the same of items then sort function doesn't works correctly.

Added Unit Tests
Fixed #838

* Flow.js : added flow notation for sort.js
2017-08-08 14:27:10 -07:00
Anton
ecf16bdaa0 fix: cli options should override package.json options
The first priority from CLI(from user) settings then package.json.

Fixed #845
2017-08-04 11:29:05 -07:00
Tom MacWright
5b373ff2fe revert(polyglot): Remove polyglot mode
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
2017-07-27 13:58:49 -04:00
Anton
ea69608e92 fix: Report nesting errors instead of throwing them as errors
Check on parent element: foo.bar sub-parametr should be documeted with parent.
Fixed #832 issue
2017-07-07 15:37:26 -04:00
Tom MacWright
290fc09b91 test: Improve coverage of infer/kind, remove unused filterAccess line (#776) 2017-05-11 10:33:45 -04:00