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: e5cbb24bacfed2da98e5ec06c110b7c92bc3c8fc
Choose a base ref
...
head repository: documentationjs/documentation
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 3cbe75d7874cc7354b3b96826a38c98764c0bfd2
Choose a head ref
8 contributors

Commits on May 9, 2020

  1. deps: Update chokidar, bump yarn.lock

    @tmcw
    tmcw committed May 9, 2020
    Copy the full SHA
    9f3db52 View commit details

  2. chore: Update Node minimum version to 10 

    BREAKING CHANGE:
documentation.js will now require node 10 or later.
    @tmcw
    tmcw committed May 9, 2020
    Copy the full SHA
    45a5257 View commit details

  3. chore(release): 13.0.0

    @tmcw
    tmcw committed May 9, 2020
    Copy the full SHA
    35359ab View commit details

Commits on Jun 4, 2020

  1. fix: 🐛 Error with flow opaque type and readme command 

    When exporting an opaque Flow type and importing it into an entry file
for documentation to consume, the CLI throws an error when using the
readme command.

✅ Closes: #1322
    @andrewdelprete @tmcw
    andrewdelprete authored and tmcw committed Jun 4, 2020
    Copy the full SHA
    78db9a4 View commit details

  2. fix: 🐛 Fixes an issue when using object spread and $Exact 

    Fixes an issue where documentationjs breaks on build when  using object
spread and Flow utility $Exact (i.g: ...Exact<Type>)

✅ Closes: #1324
    @andrewdelprete @tmcw
    andrewdelprete authored and tmcw committed Jun 4, 2020
    Copy the full SHA
    106945c View commit details

  3. fix comment typo

    @andrewdelprete @tmcw
    andrewdelprete authored and tmcw committed Jun 4, 2020
    Copy the full SHA
    01b1c2e View commit details

  4. refactor: 💡 type section is redundant and not formatted 

    When an object is flow typed, a `type` AND `properties` section is
rendered. The type section seems redundant and isn't formatted, whereas
the properties section is. This PR removes the `type` section when
dealing with an object type.

✅ Closes: #1326
    @andrewdelprete @tmcw
    andrewdelprete authored and tmcw committed Jun 4, 2020
    Copy the full SHA
    71ceea2 View commit details

  5. Fix tests

    @andrewdelprete @tmcw
    andrewdelprete authored and tmcw committed Jun 4, 2020
    Copy the full SHA
    28867f8 View commit details

  6. try fixing test again ;D

    @andrewdelprete @tmcw
    andrewdelprete authored and tmcw committed Jun 4, 2020
    Copy the full SHA
    2da9d6f View commit details

  7. chore: Update dependencies

    @tmcw
    tmcw committed Jun 4, 2020
    Copy the full SHA
    5f55bb4 View commit details

  8. chore(release): 13.0.1

    @tmcw
    tmcw committed Jun 4, 2020
    Copy the full SHA
    78c6a5a View commit details

Commits on Jul 2, 2020

  1. fix: Additional safety around detecting functions in HTML output

    @tmcw
    tmcw committed Jul 2, 2020
    Copy the full SHA
    a8b6ce1 View commit details

  2. deps: Update yargs dependency.

    @tmcw
    tmcw committed Jul 2, 2020
    Copy the full SHA
    325bfad View commit details

  3. chore(release): 13.0.2

    @tmcw
    tmcw committed Jul 2, 2020
    1
    Copy the full SHA
    a366d95 View commit details

Commits on Oct 24, 2020

  1. feat: Add event members to md output (#1336) 

    Co-authored-by: Allart Kooiman <akooiman@nieuwland.nl>
    @allartk
    allartk and Allart Kooiman authored Oct 24, 2020
    Copy the full SHA
    bc3233f View commit details

  2. 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>
    @tmcw @arlac77
    tmcw and arlac77 authored Oct 24, 2020
    Copy the full SHA
    dd71624 View commit details

  3. chore(release): 13.1.0

    @tmcw
    tmcw committed Oct 24, 2020
    Copy the full SHA
    24bbfd4 View commit details

Commits on Nov 14, 2020

  1. docs: Add TypeScript usage example (#1343)

    @walkermatt
    walkermatt authored Nov 14, 2020
    Copy the full SHA
    00b3478 View commit details

  2. Dependency update bumps (#1345)

    @tmcw
    tmcw authored Nov 14, 2020
    Copy the full SHA
    780a8a1 View commit details

Commits on Jan 9, 2021

  1. deps: Update highlight.js. (#1348)

    @francois2metz
    francois2metz authored Jan 9, 2021
    Copy the full SHA
    d775612 View commit details

Commits on Jan 19, 2021

  1. chore(release): 13.1.1

    @tmcw
    tmcw committed Jan 19, 2021
    Copy the full SHA
    3cbe75d View commit details
Showing with 5,327 additions and 3,705 deletions.
  1. +3 −1 .prettierrc
  2. +40 −1 CHANGELOG.md
  3. +3 −0 README.md
  4. +2 −0 __tests__/__snapshots__/index.js.snap
  5. +665 −161 __tests__/__snapshots__/test.js.snap
  6. +10 −10 __tests__/bin-readme.js
  7. +19 −19 __tests__/bin-watch-serve.js
  8. +40 −44 __tests__/bin.js
  9. +4 −0 __tests__/fixture/flow-exported-opaque-type.input.js
  10. +13 −0 __tests__/fixture/nest_events.input.js
  11. +4 −4 __tests__/format_type.js
  12. +3 −3 __tests__/index.js
  13. +29 −67 __tests__/lib/infer/type.js
  14. +2 −1 __tests__/lib/ts_doctrine.js
  15. +2 −2 __tests__/linker.js
  16. +29 −29 __tests__/test.js
  17. +4 −4 __tests__/utils.js
  18. +0 −16 babel.config.js
  19. +40 −41 package.json
  20. +1 −1 src/commands/lint.js
  21. +1 −1 src/commands/serve.js
  22. +8 −8 src/default_theme/assets/anchor.js
  23. +7 −7 src/default_theme/assets/site.js
  24. +4 −3 src/default_theme/index.js
  25. +4 −3 src/extractors/exported.js
  26. +1 −1 src/get-readme-file.js
  27. +1 −1 src/github.js
  28. +3 −6 src/hierarchy.js
  29. +1 −1 src/index.js
  30. +2 −5 src/infer/membership.js
  31. +3 −2 src/infer/params.js
  32. +36 −3 src/infer/properties.js
  33. +3 −1 src/infer/type.js
  34. +3 −3 src/inline_tokenizer.js
  35. +1 −1 src/input/dependency.js
  36. +1 −1 src/input/shallow.js
  37. +3 −3 src/lint.js
  38. +1 −1 src/module_filters.js
  39. +1 −3 src/nest.js
  40. +1 −1 src/output/highlighter.js
  41. +8 −1 src/output/markdown_ast.js
  42. +7 −7 src/output/util/formatters.js
  43. +1 −1 src/output/util/linker_stack.js
  44. +1 −1 src/output/util/reroute_links.js
  45. +3 −3 src/parse.js
  46. +1 −3 src/parse_markdown.js
  47. +4 −4 src/smart_glob.js
  48. +2 −2 src/sort.js
  49. +4,302 −3,224 yarn.lock
4 changes: 3 additions & 1 deletion .prettierrc
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"singleQuote": true
"singleQuote": true,
"trailingComma": "none",
"arrowParens": "avoid"
}
41 changes: 40 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,46 @@
# Change Log
# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [13.1.1](https://github.com/documentationjs/documentation/compare/v13.1.0...v13.1.1) (2021-01-19)

## [13.1.0](https://github.com/documentationjs/documentation/compare/v13.0.2...v13.1.0) (2020-10-24)


### Features

* Add event members to md output ([#1336](https://github.com/documentationjs/documentation/issues/1336)) ([bc3233f](https://github.com/documentationjs/documentation/commit/bc3233fe7e414e65756cf50450ebad069e37506a))

### [13.0.2](https://github.com/documentationjs/documentation/compare/v13.0.1...v13.0.2) (2020-07-02)


### Bug Fixes

* Additional safety around detecting functions in HTML output ([a8b6ce1](https://github.com/documentationjs/documentation/commit/a8b6ce144ea380ad21ba99f03574f6258be10666))

### [13.0.1](https://github.com/documentationjs/documentation/compare/v13.0.0...v13.0.1) (2020-06-04)


### Bug Fixes

* 🐛 Error with flow opaque type and readme command ([78db9a4](https://github.com/documentationjs/documentation/commit/78db9a443a65bbe8ff202083351655e0cfa60004)), closes [#1322](https://github.com/documentationjs/documentation/issues/1322)
* 🐛 Fixes an issue when using object spread and $Exact ([106945c](https://github.com/documentationjs/documentation/commit/106945c6354f0b70335adf737c7b7fa296952cc3)), closes [#1324](https://github.com/documentationjs/documentation/issues/1324)

<a name="13.0.0"></a>
# [13.0.0](https://github.com/documentationjs/documentation/compare/v12.3.0...v13.0.0) (2020-05-09)


### Chores

* Update Node minimum version to 10 ([45a5257](https://github.com/documentationjs/documentation/commit/45a5257))


### BREAKING CHANGES

* documentation.js will now require node 10 or later.



<a name="12.3.0"></a>
# [12.3.0](https://github.com/documentationjs/documentation/compare/v12.2.0...v12.3.0) (2020-04-07)

3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -77,6 +77,9 @@ documentation readme index.js --section=API
# build docs for all values exported by index.js
documentation build --document-exported index.js

# build html docs for a TypeScript project
documentation build index.ts --parse-extension ts -f html -o docs

Commands:
serve [input..] generate, update, and display HTML documentation
build [input..] build documentation
2 changes: 2 additions & 0 deletions __tests__/__snapshots__/index.js.snap
View file
Original file line number Diff line number Diff line change
@@ -64,6 +64,8 @@ Array [
"column": 9,
"line": 1,
},
"filename": undefined,
"identifierName": undefined,
"start": Position {
"column": 0,
"line": 1,
Loading