Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: documentationjs/documentation
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: b27af251d2ba66a31ee70aaca1c0031f58ca91f1
Choose a base ref
...
head repository: documentationjs/documentation
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 6b9e5ce2579bc285647a62086447c05588c209b6
Choose a head ref
31 contributors

Commits on May 29, 2018

  1. chore(package): update p-event to version 2.0.0

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed May 29, 2018
    Copy the full SHA
    b1b52d2 View commit details

  2. chore(yarn): Update yarn.lock

    @tmcw
    tmcw committed May 29, 2018
    Copy the full SHA
    693eb53 View commit details

  3. chore(package): update flow-bin to version 0.73.0

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed May 29, 2018
    Copy the full SHA
    5ac1715 View commit details

  4. chore(yarn): Update yarn.lock

    @tmcw
    tmcw committed May 29, 2018
    Copy the full SHA
    9d622bd View commit details

  5. chore(package): update babel-jest to version 23.0.1 

    Closes #1080
    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed May 29, 2018
    Copy the full SHA
    de0dec1 View commit details

  6. chore(yarn): Update yarn.lock

    @tmcw
    tmcw committed May 29, 2018
    Copy the full SHA
    12c55fe View commit details

Commits on Jun 4, 2018

  1. 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
    @jaydenseric @tmcw
    jaydenseric authored and tmcw committed Jun 4, 2018
    Copy the full SHA
    ca6217f View commit details

  2. chore(release): 8.0.0

    @tmcw
    tmcw committed Jun 4, 2018
    Copy the full SHA
    068005e View commit details

Commits on Jul 16, 2018

  1. Tweaks to default theme to correct grouping for html output from .yml… 

    … config file.
    @nharris-star2star @tmcw
    nharris-star2star authored and tmcw committed Jul 16, 2018
    Copy the full SHA
    f6616f2 View commit details

  2. Fix typo and return function signature div.

    @nharris-star2star @tmcw
    nharris-star2star authored and tmcw committed Jul 16, 2018
    Copy the full SHA
    67abc7d View commit details

  3. Don't show signature for notes.

    @nharris-star2star @tmcw
    nharris-star2star authored and tmcw committed Jul 16, 2018
    Copy the full SHA
    eac3cf1 View commit details

  4. chore: Update snapshots

    @tmcw
    tmcw committed Jul 16, 2018
    Copy the full SHA
    1cbf3d2 View commit details

  5. fix(package): update read-pkg-up to version 4.0.0

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Jul 16, 2018
    Copy the full SHA
    c700d3f View commit details

  6. chore: Update lockfile

    @tmcw
    tmcw committed Jul 16, 2018
    Copy the full SHA
    1968f7c View commit details

  7. chore(package): update regenerator-runtime to version 0.12.0

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Jul 16, 2018
    Copy the full SHA
    fe2c81c View commit details

  8. chore: Update lockfile

    @tmcw
    tmcw committed Jul 16, 2018
    Copy the full SHA
    1f3ab04 View commit details

  9. chore(release): 8.0.1

    @tmcw
    tmcw committed Jul 16, 2018
    Copy the full SHA
    a319cdf View commit details

Commits on Jul 20, 2018

  1. fix(package): update git-url-parse to version 10.0.1

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Jul 20, 2018
    Copy the full SHA
    91ade89 View commit details

  2. chore: Update yarn.lock

    @tmcw
    tmcw committed Jul 20, 2018
    Copy the full SHA
    53df432 View commit details

  3. chore(release): 8.0.2

    @tmcw
    tmcw committed Jul 20, 2018
    Copy the full SHA
    f1bb4da View commit details

Commits on Jul 24, 2018

  1. fix(package): update get-port to version 4.0.0

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Jul 24, 2018
    Copy the full SHA
    9ca8c06 View commit details

  2. chore: Update yarn.lock

    @tmcw
    tmcw committed Jul 24, 2018
    Copy the full SHA
    d8f4509 View commit details

  3. chore(package): update fs-extra to version 7.0.0

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Jul 24, 2018
    Copy the full SHA
    b1399e9 View commit details

  4. chore: update yarn.lock

    @tmcw
    tmcw committed Jul 24, 2018
    Copy the full SHA
    3384c08 View commit details

Commits on Aug 3, 2018

  1. feat: added project description

    @mxschmitt @tmcw
    mxschmitt authored and tmcw committed Aug 3, 2018
    Copy the full SHA
    45a9ea9 View commit details

  2. chore: Update lint-staged

    @tmcw
    tmcw committed Aug 3, 2018
    Copy the full SHA
    9146560 View commit details

  3. chore: Move version number back, inadvertent change

    @tmcw
    tmcw committed Aug 3, 2018
    Copy the full SHA
    17ac32b View commit details

  4. chore(release): 8.1.0

    @tmcw
    tmcw committed Aug 3, 2018
    Copy the full SHA
    fb37789 View commit details

Commits on Aug 17, 2018

  1. fix: Serve on correct port 

    Update serve command to pass object to get-port
    @gburnett @tmcw
    gburnett authored and tmcw committed Aug 17, 2018
    Copy the full SHA
    4d59f6f View commit details

  2. chore(release): 8.1.1

    @tmcw
    tmcw committed Aug 17, 2018
    Copy the full SHA
    d577256 View commit details

Commits on Aug 19, 2018

  1. chore: cache dependencies (#1073)

    @DanielRuf @tmcw
    DanielRuf authored and tmcw committed Aug 19, 2018
    Copy the full SHA
    c09fee1 View commit details

  2. Update pify to the latest version 🚀 (#1116) 

    * fix(package): update pify to version 4.0.0

* chore: Update yarn.lock
    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Aug 19, 2018
    Copy the full SHA
    1b7309c View commit details

  3. chore(package): update eslint to version 5.0.1 

    Closes #1096
    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Aug 19, 2018
    Copy the full SHA
    9a030fd View commit details

  4. chore: Update yarn.lock

    @tmcw
    tmcw committed Aug 19, 2018
    Copy the full SHA
    7fd02a7 View commit details

  5. chore(package): update eslint-config-prettier to version 3.0.1 

    Closes #1118
    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Aug 19, 2018
    Copy the full SHA
    63d2f80 View commit details

  6. chore: Update yarn.lock

    @tmcw
    tmcw committed Aug 19, 2018
    Copy the full SHA
    255d8ee View commit details

Commits on Aug 23, 2018

  1. 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
    @NumminorihSF @tmcw
    NumminorihSF authored and tmcw committed Aug 23, 2018
    Copy the full SHA
    40b1783 View commit details

  2. chore(release): 8.1.2

    @tmcw
    tmcw committed Aug 23, 2018
    Copy the full SHA
    fb2595e View commit details

Commits on Sep 21, 2018

  1. 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.
    @vicapow @tmcw
    vicapow authored and tmcw committed Sep 21, 2018
    Copy the full SHA
    49c0f72 View commit details

  2. chore: upgrade dependencies

    @tmcw
    tmcw committed Sep 21, 2018
    Copy the full SHA
    8c6ea4d View commit details

  3. chore: Create and use new sortable deps

    @tmcw
    tmcw committed Sep 21, 2018
    Copy the full SHA
    7ff4399 View commit details

  4. chore: Update test fixture

    @tmcw
    tmcw committed Sep 21, 2018
    Copy the full SHA
    0ecb68d View commit details

  5. chore(release): 9.0.0-alpha.0

    @tmcw
    tmcw committed Sep 21, 2018
    Copy the full SHA
    7ce2a6a View commit details

  6. chore(package): update flow-bin to version 0.81.0 

    Closes #1089
    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Sep 21, 2018
    Copy the full SHA
    5903d5c View commit details

  7. chore(package): update lockfile yarn.lock

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Sep 21, 2018
    Copy the full SHA
    372c8ca View commit details

Commits on Oct 21, 2018

  1. Update README.md

    @tmcw
    tmcw authored Oct 21, 2018
    Copy the full SHA
    ecf99f8 View commit details

Commits on Oct 24, 2018

  1. test: Make tests resilient even for tagged semvers

    @tmcw
    tmcw committed Oct 24, 2018
    Copy the full SHA
    23b8ee8 View commit details

  2. chore(package): update @babel/cli to version 7.1.2

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Oct 24, 2018
    Copy the full SHA
    cb881ea View commit details

  3. chore(package): update @babel/core to version 7.1.2

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Oct 24, 2018
    Copy the full SHA
    a2710a0 View commit details

  4. chore(package): update @babel/generator to version 7.1.3

    @greenkeeper @tmcw
    greenkeeper[bot] authored and tmcw committed Oct 24, 2018
    Copy the full SHA
    c7121f1 View commit details
Showing with 12,066 additions and 5,183 deletions.
  1. +0 −15 .babelrc
  2. +15 −7 .circleci/config.yml
  3. +1 −1 .editorconfig
  4. +1 −7 .eslintrc
  5. +0 −13 .flowconfig
  6. +0 −1 .gitignore
  7. +1 −0 .prettierignore
  8. +319 −0 CHANGELOG.md
  9. +66 −12 CODE_OF_CONDUCT.md
  10. +13 −13 README.md
  11. +12 −6 __tests__/__snapshots__/bin-readme.js.snap
  12. +661 −131 __tests__/__snapshots__/bin.js.snap
  13. +4 −0 __tests__/__snapshots__/index.js.snap
  14. +4,096 −907 __tests__/__snapshots__/test.js.snap
  15. +9 −9 __tests__/bin-watch-serve.js
  16. +48 −36 __tests__/bin.js
  17. +1 −0 __tests__/fixture/class.input.js
  18. +4 −1 __tests__/fixture/es6-import.input.js
  19. +17 −2 __tests__/fixture/es6.input.js
  20. +6 −0 __tests__/fixture/flow-optional-chaining.input.js
  21. +3 −0 __tests__/fixture/flow-unnamed-params.input.js
  22. +2 −0 __tests__/fixture/interface.input.js
  23. +10 −0 __tests__/fixture/resolve/index.js
  24. +8 −0 __tests__/fixture/resolve/node.js
  25. +14 −0 __tests__/fixture/resolve/package.json
  26. +0 −5 __tests__/fixture/system-import.input.js
  27. +1 −0 __tests__/fixture/vue.input.vue
  28. +8 −1 __tests__/lib/flow_doctrine.js
  29. +21 −5 __tests__/lib/git/find_git.js
  30. +19 −6 __tests__/lib/git/url_prefix.js
  31. +8 −4 __tests__/lib/github.js
  32. +311 −0 __tests__/lib/infer/__snapshots__/params.js.snap
  33. +59 −4 __tests__/lib/infer/access.js
  34. +24 −2 __tests__/lib/infer/augments.js
  35. +57 −0 __tests__/lib/infer/implements.js
  36. +88 −7 __tests__/lib/infer/kind.js
  37. +210 −0 __tests__/lib/infer/membership.js
  38. +6 −0 __tests__/lib/infer/name.js
  39. +95 −1 __tests__/lib/infer/params.js
  40. +58 −15 __tests__/lib/infer/properties.js
  41. +122 −3 __tests__/lib/infer/return.js
  42. +191 −5 __tests__/lib/infer/type.js
  43. +4 −2 __tests__/lib/merge_config.js
  44. +89 −4 __tests__/lib/parse.js
  45. +1 −1 __tests__/lib/parsers/parse_to_ast.js
  46. +407 −0 __tests__/lib/ts_doctrine.js
  47. +3 −3 __tests__/test.js
  48. +26 −0 __tests__/utils.js
  49. +16 −0 babel.config.js
  50. +1 −1 bin/documentation.js
  51. +8 −1 declarations/comment.js
  52. +1 −3 docs/FAQ.md
  53. +2 −2 docs/GETTING_STARTED.md
  54. +86 −56 docs/NODE_API.md
  55. +25 −3 docs/RECIPES.md
  56. +2 −2 docs/THEMING.md
  57. +2 −2 docs/TROUBLESHOOTING.md
  58. +5 −0 docs/USAGE.md
  59. +63 −53 package.json
  60. +2 −4 src/commands/build.js
  61. +0 −2 src/commands/index.js
  62. +1 −3 src/commands/lint.js
  63. +35 −11 src/commands/readme.js
  64. +2 −4 src/commands/serve.js
  65. +25 −4 src/commands/shared_options.js
  66. +1 −1 src/default_theme/README.md
  67. +2 −2 src/default_theme/assets/anchor.js
  68. +754 −558 src/default_theme/assets/split.js
  69. +20 −13 src/default_theme/assets/style.css
  70. +18 −16 src/default_theme/index._
  71. +1 −4 src/default_theme/index.js
  72. +1 −1 src/default_theme/note._
  73. +12 −8 src/default_theme/section._
  74. +3 −10 src/extractors/comments.js
  75. +6 −11 src/extractors/exported.js
  76. +2 −4 src/filter_access.js
  77. +6 −6 src/flow_doctrine.js
  78. +1 −2 src/garbage_collect.js
  79. +1 −3 src/get-readme-file.js
  80. +16 −11 src/git/find_git.js
  81. +24 −7 src/git/url_prefix.js
  82. +9 −10 src/github.js
  83. +2 −0 src/index.js
  84. +14 −6 src/infer/access.js
  85. +6 −5 src/infer/augments.js
  86. +3 −5 src/infer/finders.js
  87. +38 −0 src/infer/implements.js
  88. +41 −8 src/infer/kind.js
  89. +113 −34 src/infer/membership.js
  90. +2 −4 src/infer/name.js
  91. +75 −28 src/infer/params.js
  92. +23 −15 src/infer/properties.js
  93. +73 −7 src/infer/return.js
  94. +29 −11 src/infer/type.js
  95. +0 −2 src/inline_tokenizer.js
  96. +43 −23 src/input/dependency.js
  97. +1 −6 src/input/shallow.js
  98. +0 −2 src/is_jsdoc_comment.js
  99. +7 −9 src/lint.js
  100. +5 −7 src/merge_config.js
  101. +2 −7 src/module_filters.js
  102. +4 −6 src/nest.js
  103. +1 −2 src/output/highlighter.js
  104. +2 −4 src/output/html.js
  105. +2 −4 src/output/json.js
  106. +2 −4 src/output/markdown.js
  107. +23 −24 src/output/markdown_ast.js
  108. +2 −3 src/output/util/format_type.js
  109. +5 −6 src/output/util/formatters.js
  110. +5 −9 src/output/util/linker_stack.js
  111. +1 −2 src/output/util/reroute_links.js
  112. +45 −13 src/parse.js
  113. +1 −2 src/parse_markdown.js
  114. +9 −8 src/parsers/javascript.js
  115. +50 −23 src/parsers/parse_to_ast.js
  116. +1 −3 src/parsers/vue.js
  117. +1 −2 src/serve/error_page.js
  118. +5 −18 src/serve/server.js
  119. +3 −4 src/smart_glob.js
  120. +9 −22 src/sort.js
  121. +178 −0 src/ts_doctrine.js
  122. +21 −0 src/type_annotation.js
  123. +2 −4 src/walk.js
  124. +2,945 −2,794 yarn.lock
15 changes: 0 additions & 15 deletions .babelrc
View file

This file was deleted.

22 changes: 15 additions & 7 deletions .circleci/config.yml
View file
Original file line number Diff line number Diff line change
@@ -2,9 +2,8 @@ workflows:
version: 2
node-multi-build:
jobs:
- node-v6
- node-v8
- node-latest
- node-v10

version: 2
jobs:
@@ -13,15 +12,24 @@ jobs:
- image: node
steps:
- checkout
- restore_cache:
name: Restore Yarn Package Cache
keys:
- yarn-packages-{{ .Branch }}-{{ checksum "yarn.lock" }}
- yarn-packages-{{ .Branch }}
- yarn-packages-master
- yarn-packages-
- run:
name: Install dependencies
command: yarn --frozen-lockfile
- run:
name: Test
command: yarn test-ci
- run:
name: coverage
command: ./node_modules/.bin/coveralls < coverage/lcov.info
- save_cache:
name: Save Yarn Package Cache
key: yarn-packages-{{ .Branch }}-{{ checksum "yarn.lock" }}
paths:
- node_modules/
node-v6:
<<: *node-base
docker:
@@ -30,7 +38,7 @@ jobs:
<<: *node-base
docker:
- image: node:8
node-latest:
node-v10:
<<: *node-base
docker:
- image: node:latest
- image: node:10
2 changes: 1 addition & 1 deletion .editorconfig
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**.js]
[*.{js,css}]
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
8 changes: 1 addition & 7 deletions .eslintrc
View file
Original file line number Diff line number Diff line change
@@ -4,9 +4,6 @@
"parserOptions": {
"sourceType": "module"
},
"plugins": [
"flowtype"
],
"rules": {
"no-var": 2,
"prefer-const": 2,
@@ -27,13 +24,10 @@
"no-eq-null": 2,
"strict": [2, "global"],
"no-shadow": 0,
"no-undef": 2,
"flowtype/define-flow-type": 1,
"flowtype/use-flow-type": 1
"no-undef": 2
},
"extends": [
"eslint:recommended",
"plugin:flowtype/recommended",
"prettier"
],
"env": {
13 changes: 0 additions & 13 deletions .flowconfig
View file

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/lib
coverage
.nyc_output
/node_modules
1 change: 1 addition & 0 deletions .prettierignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__tests__/fixture
Loading