128 Commits

Author SHA1 Message Date
Tom MacWright
71f778bcb1 Simplify destructuring types 2015-12-10 16:55:02 -05:00
Tom MacWright
4b252ebf00 Avoid traversal where possible. Fixes #293 2015-12-10 16:11:44 -05:00
Tom MacWright
71a52e5ed1 Support membership inference in class expressions. Fixes #284 2015-12-07 18:37:26 -05:00
Tom MacWright
bb9fc5f8e5 Infer augments tag from extends keyword. Fixes #195 2015-12-07 18:17:05 -05:00
Tom MacWright
931f48eefc Implement five tags:
- version
- author
- license
- copyright
- since

These are flattened and output in Markdown. HTML output will
require an update in the theme module
2015-12-07 17:53:00 -05:00
Tom MacWright
8e0f960db0 Move type formatting helper to utils package 2015-12-07 16:26:14 -05:00
John Firebaugh
0a1de4f343 Theme API 2.0 2015-12-07 16:09:24 -05:00
Tom MacWright
b756c0ce58 Support alias tag. Refs #9 2015-12-07 13:04:01 -05:00
Tom MacWright
73d6118e1c Implement all doctrine-emitted types. Fixes #249 2015-12-07 12:44:15 -05:00
Anand Thakker
571137a77d Merge pull request #277 from documentationjs/refactor-commands-new
Refactor commands into modules
2015-12-06 21:28:11 -05:00
Tom MacWright
a6f0435bfe Fix coverage of array destructuring 2015-12-06 19:57:14 -05:00
Tom MacWright
1d1aba82ab Improve parameter inference for destructuring and defaults
Fixes #271
2015-12-06 19:29:04 -05:00
Anand Thakker
b609664ed8 Add another note about command modules 2015-12-06 18:39:28 -05:00
Anand Thakker
0022934d90 Fix lint errors 2015-12-06 18:16:41 -05:00
Anand Thakker
e492be67d1 Add some comments re: command plugins 2015-12-06 18:13:17 -05:00
Anand Thakker
5c8459d957 Reorganize argument parsing
Arg parsing is now split into common options (in bin/documentation.js)
and command-specific options (in each command module, exported as
parseArgs).

This includes moving `--private` and `--github` to the common args
instead of having them under the build/serve commands.  Reason: these
two args are options understood by the main module, as opposed to args
like `--format` which are only understood by the actual output piece
in build/serve.

Also removes `args.js`, which had previously exported the argument
parsing for use in situations like documentation-readme.  The need
for this, I think, is largely made irrelevant in the face of slightly
generalizing the CLI to use commands.
2015-12-06 18:13:17 -05:00
Anand Thakker
795d1e3794 Refactor commands to separate modules 2015-12-06 18:12:19 -05:00
Tom MacWright
bcc4b2c6b2 Enforce semi: 2 2015-12-06 18:01:55 -05:00
Tom MacWright
d069b6a40b Support new node versions, including v4 and v5
* Compare strings as lowercase, to permit for v4+ compatibility
* Fix bad reference to loc.name
* Update README badge and fixture
* Remove brfs dependency
* Remove traverse
* Remove browser transform support
2015-12-01 15:34:50 -05:00
Tom MacWright
d470b54213 Correctly interpret name tag. Fixes #205 2015-11-28 11:50:29 -05:00
Tom MacWright
6b8cc62eef Trim later to protect against sha HEAD files with newlines 2015-11-28 10:53:31 -05:00
Tom MacWright
7084147d51 Fix and test detached url prefixes. Fixes #251 2015-11-25 15:00:39 -05:00
Tom MacWright
57b2452353 Use setColor to produce more readable colors
Fixes #258
2015-11-25 14:39:15 -05:00
Tom MacWright
8fd36f986a Fix and cover bug in walk, make highlighting functional 2015-11-25 14:19:55 -05:00
Iilei
ebcee3ae07 Pass though hljs options: Enable hljs highlightAuto and languages
By providing a hljs object within the configuration, `@example` tags in
a variety of languages are parsed properly.
2015-11-25 17:31:58 +01:00
Tom MacWright
cd0e8143db Simplify extension check, add coverage 2015-11-24 13:00:32 -05:00
Kevin Wenner
356616ea1e Add an extension option
This new option change the previous behavior of parsing every input files
from module-deps except json. But if one use browserify to require json file
they may require other file types that cant be supported by documentationjs,
the new behaviour is to parse files whose extension match one in a whitelist
2015-11-24 12:35:16 -05:00
kketch
c1962457c9 add an external option
add an external option for the cli and permit the use of multiple patterns / globs
in an array. Use micromatch.any() instead of micromatch.matcher()
2015-11-24 12:18:48 -05:00
Tom MacWright
fe82dde727 Fix HTML validity with default template 2015-11-24 11:35:17 -05:00
Tom MacWright
50aaf9d35b --watch and --serve flags
These new flags replace the functionality of
dev-documentation
2015-11-24 11:21:11 -05:00
Tom MacWright
432151bce8 Fix nullable type support. Fixes #245 2015-11-17 11:12:42 -05:00
Lucas Wojciechowski
a8581b41e7 Fix exception when formatting lint errors 2015-11-11 09:35:00 -05:00
Tom MacWright
463bb4e62f Improve test coverage 2015-11-09 13:08:56 -05:00
Tom MacWright
33552c6e8a Fix type merging. Fixes #233
Some params cannot be identified with only param.name. This
changes the algorithm to transform parameters into doc objects
first, and then using the value of doc.name, which is defined
even for parameters with default values.
2015-11-09 12:51:15 -05:00
Tom MacWright
eed48f7840 Support github links in markdown output 2015-11-09 12:04:52 -05:00
Tom MacWright
8a2ec3efad Allow param tag type to be inferred and merged with description 2015-11-05 14:48:41 -05:00
Tom MacWright
012a16f246 Fix name-annotated rest annotations 2015-11-04 17:56:59 -05:00
Tom MacWright
70cc7d0718 Infer Flow type aliases into typedefs. Fixes #227
Given the `type` tag introduced with Flow, this can infer
a typedef statement, as well as infer its potentially
nested properties and their types.

This also includes

* Refactor of Markdown AST generation that fixes #228
* Refactor of nest.js to handle multi-level nesting
2015-11-04 11:25:32 -05:00
Tom MacWright
55f79ebf14 Infer rest parameters. Fixes #223 2015-11-03 17:40:33 -05:00
Tom MacWright
b53f94766e Nest both properties and params. Fixes #164 2015-11-03 11:59:17 -05:00
Tom MacWright
51d4478ac2 Refactor Markdown AST representation. Fixes #216 2015-11-03 10:50:18 -05:00
Tom MacWright
e17b481f03 Use Boolean trick for Markdown AST as well 2015-10-31 20:51:29 -04:00
Tom MacWright
5c62d23d4f Simplify, remove extend 2015-10-31 11:02:14 -04:00
Ilya Radchenko
127082327d Fix default theme resolve 2015-10-30 22:56:14 -04:00
Tom MacWright
ac5b04183f Improve internal documentation, upgrade theme-default. Refs #115 2015-10-30 15:44:46 -04:00
Tom MacWright
7ee83b655f Fix default formatting 2015-10-30 13:44:03 -04:00
Tom MacWright
493d2b7fe5 Change version flag meaning 2015-10-30 12:46:08 -04:00
Tom MacWright
8886ac6157 Switch from babylon to babel-core. Fixes #201 2015-10-30 12:37:56 -04:00
Tom MacWright
63c0ca633f Fix type applications creating accidental elements in Markdown 2015-10-28 17:12:54 -04:00
Tom MacWright
eb1089e594 Stop inferring parameters if fn is within a call.
Fixes #191

This a specific exception for the case identified in 191: we could,
instead, include only cases of clear proximity, like var foo = function,
or function foo.
2015-10-27 17:52:28 -04:00