archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity
2,150 Commits 10 Branches 386 Tags
Commit Graph

200 Commits

Author SHA1 Message Date
Jeff Williams
d661c1886e Publish 
- @jsdoc/cli@0.2.4
 - @jsdoc/core@0.3.3
 - @jsdoc/eslint-config@1.1.5
 - @jsdoc/task-runner@0.1.9
 - @jsdoc/test-matchers@0.1.5
 - @jsdoc/util@0.2.3
 - jsdoc@4.0.0-dev.14
 2020-12-24 15:08:27 -08:00
Jeff Williams
df319bc3d1 refactor(jsdoc-core): add Syntax to @jsdoc/core 2020-12-24 15:07:47 -08:00
Jeff Williams
e816766f6c chore(jsdoc): remove jsdoc/env from astnode 2020-12-24 14:59:36 -08:00
Jeff Williams
ad6d74e937 chore(jsdoc): remove jsdoc/env from parser tests 2020-12-24 14:59:16 -08:00
Jeff Williams
081cddf43d chore(jsdoc): remove jsdoc/env from parser 2020-12-24 14:46:53 -08:00
Jeff Williams
5dccf920ef chore(jsdoc): remove jsdoc/env from astbuilder 2020-12-24 14:37:45 -08:00
Jeff Williams
b70ee2ea9a chore(deps): update dependency ow to ^0.21.0 2020-12-24 13:41:00 -08:00
renovate[bot]
699f6718c0
fix(deps): update dependency @babel/parser to ^7.12.11 (#1888) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-12-24 13:29:24 -08:00
Jeff Williams
b10fb33462 chore: update ESLint rules 2020-12-24 09:10:50 -08:00
renovate[bot]
f57374e325
chore(deps): update dependency eslint to v7.16.0 (#1885) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-12-24 08:47:38 -08:00
Jeff Williams
eaa2cfb807 fix: correctly track interface members 
When an interface is a) defined as an ES2015 class and b) assigned to a variable, JSDoc sometimes used the wrong `longname` and `memberof` for members of the interface (specifically, for instance properties).

The root cause was that we weren't resolving `this` correctly within this type of interface. As a result, if you added a JSDoc comment to something like `this.foo = 'bar'`, the doclet for `this.foo` had the wrong `longname` and `memberof`.

Fixing that issue uncovered another issue: When we merged the constructor's doclet with the interface's doclet, we preferred the constructor's doclet. However, the constructor's doclet used the wrong `kind` in this case; we already had code to fix up the `longname` and `memberof` of the combined doclet, but not the `kind`. The fix was to prefer the interface's doclet for all properties.

Manual cherry-pick of 95e3192525310b9f1567e034c22489da3a5847a1.
 2020-12-12 19:24:20 -08:00
Jeff Williams
c9b12b09ec fix: prevent circular refs when params have the same type expression 
Catharsis caches parse results by default; if you parse the same type expression twice, with the same options, you get the same object each time.

When the user passes the `--debug` flag, we expose the parsed type for each parameter as an enumerable property of the doclet. If two parameters used the same type expression, the resulting doclet could contain a circular reference.

This change disables the Catharsis cache, so that Catharsis returns a new object for each parsed type, which prevents circular references. As a result, this change fixes an issue with the `-X` flag, and with some JSDoc templates.
 2020-12-12 19:22:10 -08:00
renovate[bot]
152773690f
chore(deps): update dependency eslint to v7.14.0 (#1882) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-11-24 16:09:39 -08:00
Jeff Williams
de09ebb5b3 chore(deps): update dependencies 2020-11-23 10:10:42 -08:00
renovate[bot]
3151eff464
chore(deps): update dependency eslint to v7.12.1 (#1851) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-11-01 12:47:16 -08:00
renovate[bot]
c01ba6c323
fix(deps): update dependency @babel/parser to ^7.11.4 (#1844) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-21 21:34:37 +00:00
renovate[bot]
c823799a77
fix(deps): update dependency p-queue to ^6.6.1 (#1838) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-18 05:12:58 +00:00
renovate[bot]
fea45ee6ae
chore(deps): update dependency eslint to v7.7.0 (#1834) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-16 00:33:21 +00:00
renovate[bot]
370ef1c013
fix(deps): update dependency lodash to ^4.17.20 (#1831) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-14 19:28:42 +00:00
renovate[bot]
5c217497e6
fix(deps): update dependency yargs-parser to v19 (#1829) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-11 01:07:40 +00:00
renovate[bot]
5ccead8436
fix(deps): update dependency @babel/parser to ^7.11.3 (#1828) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-09 22:18:01 +00:00
renovate[bot]
a7c6622e2b
fix(deps): update dependency @babel/parser to ^7.11.2 (#1827) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-06 17:34:35 +00:00
renovate[bot]
6a2e98b02e
fix(deps): update dependency cosmiconfig to v7 (#1824) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-03 04:39:08 +00:00
renovate[bot]
d33d535f7b
chore(deps): update dependency eslint to v7.6.0 (#1823) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-08-02 01:59:53 +00:00
renovate[bot]
bf96d669fa
fix(deps): update dependency @babel/parser to ^7.11.0 (#1822) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-31 23:33:45 +00:00
renovate[bot]
80b1a5a3b8
fix(deps): update dependency p-queue to ^6.6.0 (#1819) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-20 23:20:11 +00:00
renovate[bot]
a024820329
chore(deps): update dependency eslint to v7.5.0 (#1818) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-19 20:59:58 +00:00
renovate[bot]
c95769fdef
fix(deps): update dependency @babel/parser to ^7.10.5 (#1816) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-15 20:34:22 +00:00
renovate[bot]
fe42e77b85
fix(deps): update dependency strip-json-comments to ^3.1.1 (#1815) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-13 18:51:46 +00:00
Jeff Williams
ff3eeab056 Publish 
- @jsdoc/cli@0.2.3
 - @jsdoc/core@0.3.2
 - @jsdoc/eslint-config@1.1.4
 - @jsdoc/task-runner@0.1.8
 - @jsdoc/util@0.2.2
 - jsdoc@4.0.0-dev.13
 2020-07-11 16:02:11 -07:00
renovate[bot]
e1a36ab08f
fix(deps): update dependency lodash to ^4.17.19 (#1813) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-09 20:16:59 +00:00
renovate[bot]
f27ebf53dd
fix(deps): update dependency emittery to ^0.7.1 (#1811) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-07 06:28:38 +00:00
Jeff Williams
c9270a4fb5 fix(jsdoc): use the correct scope for exported classes with constructors 
Previously, if a module exported an ES2015 class, and the class had a constructor, the generated docs claimed that the class was in the `inner` scope. But `inner` means that the class is _not_ exported.

This issue occurred because we generate separate doclets for the class declaration and constructor. When we merged the two, we incorrectly gave priority to properties in the constructor's doclet, rather than the class declaration's doclet. The constructor's doclet uses the `inner` scope; the class declaration's doclet uses the `static` scope.
 2020-07-04 18:31:08 -07:00
renovate[bot]
f11bc773ee
chore(deps): update dependency eslint to v7.4.0 (#1809) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-04 22:45:29 +00:00
renovate[bot]
c4efd34bd3
fix(deps): update dependency p-queue to ^6.5.0 (#1807) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-02 17:33:10 +00:00
renovate[bot]
e60a1fa233
fix(deps): update dependency @babel/parser to ^7.10.4 (#1806) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-07-01 15:32:10 +00:00
renovate[bot]
99602b5d4b
chore(deps): update dependency eslint to v7.3.1 (#1804) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-24 08:50:56 +00:00
renovate[bot]
98451df89d
fix(deps): update dependency @babel/parser to ^7.10.3 (#1802) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-21 21:47:57 +00:00
renovate[bot]
9142fe8858
chore(deps): update dependency eslint to v7.3.0 (#1799) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-20 19:30:42 +00:00
renovate[bot]
d2bb80fb0f
fix(deps): update dependency catharsis to ^0.9.0 (#1798) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-15 21:27:48 +00:00
renovate[bot]
5748091d38
chore(deps): update dependency lerna to ^3.22.1 (#1796) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-10 03:37:24 +00:00
Jeff Williams
f495f01333 refactor(jsdoc): remove Markdown parser from JSDoc 
BREAKING CHANGE: Removed `markdown` plugin. Templates are now responsible for converting Markdown to HTML where appropriate.
 2020-06-07 17:38:21 -07:00
Jeff Williams
fa693fdd85 fix: make the --readme flag usable 
+ fix(jsdoc): resolve the path to the README file
+ fix(jsdoc-cli): don't treat --readme as a boolean
 2020-06-07 16:41:06 -07:00
renovate[bot]
495093600d
chore(deps): update dependency eslint to v7.2.0 (#1794) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-07 16:21:31 -07:00
renovate[bot]
10c5fffd01
fix(deps): update dependency strip-json-comments to ^3.1.0 (#1758) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-06-07 16:20:47 -07:00
Jeff Williams
4db0787711 feature(jsdoc): temporarily remove README from output 
This will become the template's responsibility.

BREAKING CHANGE: README files are no longer converted to HTML. The default template does not include them in its output.
 2020-06-06 20:29:29 -07:00
renovate[bot]
60eb9b396d
fix(deps): update dependency @babel/parser to ^7.10.2 (#1791) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-05-31 23:44:27 +00:00
renovate[bot]
8c4a07de68
fix(deps): update dependency @babel/parser to ^7.10.1 (#1790) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2020-05-29 02:24:04 +00:00
Jeff Williams
81df42f593 fix(jsdoc-core): restore old behavior of toParts() 2020-05-25 11:29:17 -07:00
Jeff Williams
65e2226eb0 feature(jsdoc): temporarily remove tutorial support 
To be replaced by more flexible support for additional content.

BREAKING CHANGE: Removed support for tutorials.
 2020-05-25 11:06:23 -07:00