Have tsd-jsdoc generate default exports #98

alxroyer · 2019-09-02T19:57:20Z

I'm starting a draft PR for issue#96.

Still work to be done on it, but I share the code right now so that one could review it and give me advice on how to lead the things.

Still buggy: module declaration is generated twice.

…t' doclets. => fixed: generation of 'export default' at the end of the module (and not at the beginning) => fixed: duplicate module declaration

module2 test addition.

src/Emitter.ts

`debug()` controled by a specific `debug` option.

'documented' => by default 'exported' => not fully implemented, just prevents non documented doclets to be removed for the moment

@HackbrettXXX

cherry-pick & merge from @HackbrettXXX's commit 312578e

From [PR#74](englercj#74) with fix.

src/typings/dts-jsdoc.d.ts

…e tested.

Lots of them are not enabled yet and need to be fixed.

2.4.0

…ution.

Fix for 'module.exports = {name: }' pattern.

…ass would actually).

… strategy.

…neration strategy. Warn&debug improvements.

…ration strategy.

Instrumentation for jsdoc 3.5.5 vs 3.6.3 investigations.

# Conflicts: # package-lock.json # package.json # test/expected/class_all.d.ts # test/lib/index.ts

alxroyer · 2019-10-03T11:57:02Z

Status on this PR.

At this time, all tests pass successfully, either in 'documented' or 'exported' generation strategies.

Brings improvements and fixes, in particular for the following:

PR#74: ES6 class constructor doclet management
issue#99: Appropriate handling for 'undocumented' doclets with jsdoc@3.6.x
issue#104: Appropriate support for @override tags
PR#103: Native handling for @template tags with jsdoc@3.6.x

What remains to test/do:

issue#96: Default exports not working
- To be tested with real code
- As exeprimented lately, module.exports= in .js does not fit with export default in .d.ts (see stackoverflow.com and TypeScript#2242)
issue#100: Generation strategy : what is documented vs what is actually exported
- To be tested with real code

englercj · 2020-01-05T17:34:22Z

@Alexis-ROYER, Have you had a chance to revisit this now that the holidays are passing behind us?

alxroyer · 2020-01-08T08:43:37Z

Hi @englercj, sure, it has been a while since the last status...

Here's an update:

issue#96: I've had the opportunity to test the things further around default exports: TypeScript syntax & transpilation options, .tsd syntax, node options... I plan to publish a repository that clarifies the way it works, with the recommendations I concluded from my tests.
Now, to my point point of view, the really most important thing remaining is to test it with real code and check it is valid enough.

This is on the way, but as I've been busy on other things, I must admit it has been delayed. I let you known as soon as I get back to it.

See: https://github.com/Alexis-ROYER/tsd-default-export/blob/master/README.md

2.5.0

alxroyer · 2020-04-20T09:17:37Z

I eventually managed to get it done.

Just for the story: while integrating walk-back (commit bf2eaab, Oct 2019) I could not get a .d.ts file working with an ES6 default import / export, which led me to doubts on the way default exports should work.

That's the reason why I went through a dedicated study (see tsd-default-export). This study brought to formulate recommendations on default exports, which recommendations I have applied in commit 1ac9c2c, Apr 2020.

Status on this PR:

On my side, all tests pass successfully:
- Every test is executed twice: first with the documented generation strategy, then with the exported generation strategy
- Addition of 32 tests for default exports
- Addition of constructor_all.js test
Brings improvements and fixes, in particular for the following:
- PR#74: ES6 class constructor doclet management
- issue#99: Appropriate handling for undocumented doclets with jsdoc@3.6.x
- issue#104: Appropriate support for @override tags
- PR#103: Native handling for @template tags with jsdoc@3.6.x, plugin from PR#103 could possibly be rolled back
- issue#96: Default exports
- issue#100: exported generation strategy

Note on the exported generation strategy: requires a @module tag in the .js input file.

Ready for review.

englercj · 2020-04-22T18:27:48Z

Awesome! Thanks for all the hard work @Alexis-ROYER. I'll take a look at this today.

englercj

Wow, thanks again for this PR @Alexis-ROYER. This is a great change.

All my comments were stylistic, and I tried to add suggestions that can be added in directly for most of them. Thanks again!

src/Emitter.ts

'exported' tests were not executed due to a false trailing 'r' after `generationStrategy` in `test/lib/index.ts`.

alxroyer · 2020-05-01T21:45:36Z

@englercj I think I managed to fix all the points so far. Let me know if you have any more questions or remarks.

englercj · 2020-05-02T15:57:01Z

This was awesome @Alexis-ROYER, thanks again for all your hard work!

alxroyer · 2020-05-02T21:21:48Z

My pleasure.

alxroyer added 4 commits September 2, 2019 09:47

Very first 'export default' generation.

23f7c8c

Still buggy: module declaration is generated twice.

Removal of the IExportDefaultDoclet hack.

d398400

Code moved from _createTreeNodes() to _buildTree() for 'export defaul…

a9ad12f

…t' doclets. => fixed: generation of 'export default' at the end of the module (and not at the beginning) => fixed: duplicate module declaration

'module.exports =' pattern management.

96efc52

module2 test addition.

This was referenced Sep 2, 2019

[BOUNTY] Community Improvement Bounty - libp2p - TypeScript bindings for js-libp2p-* ethberlinzwei/Bounties#21

Open

Generation strategy : what is documented vs what is actually exported #100

Open

alxroyer changed the title ~~Export default~~ Have tsd-jsdoc generate default exports Sep 2, 2019

englercj reviewed Sep 3, 2019

View reviewed changes

src/Emitter.ts Outdated Show resolved Hide resolved

englercj reviewed Sep 3, 2019

View reviewed changes

src/Emitter.ts Show resolved Hide resolved

alxroyer and others added 7 commits September 3, 2019 17:11

module3 test addition.

186f4c0

Removal of K&R style braces.

31f17dc

`debug()` controled by a specific `debug` option.

Addition of debug traces.

5d8387e

opts.generationStrategy option addition.

ea81fb1

'documented' => by default 'exported' => not fully implemented, just prevents non documented doclets to be removed for the moment

correctly write doclets at es6 class constructors

3b76685

cherry-pick & merge from @HackbrettXXX's commit 312578e

add a test case for constructors (fails currently)

1cefe92

Constructor generation with documentation.

82e01e4

From [PR#74](englercj#74) with fix.

This was referenced Sep 6, 2019

correctly write doclets at es6 class constructors #74

Open

Wrong handling of 'undocumented' attributes with jsdoc 3.6.x #99

Open

alxroyer commented Sep 7, 2019

View reviewed changes

src/typings/dts-jsdoc.d.ts Show resolved Hide resolved

alxroyer added 5 commits September 9, 2019 23:00

Emitter._buildTree() strengthening with full jsdoc doclets.

ea101c9

First 'exported' generation strategy implementation. Still needs to b…

7602d90

…e tested.

Test additions for testing the 'exported' generation strategy.

d50d96f

Lots of them are not enabled yet and need to be fixed.

Merge tag 'v2.4.0' into export-default

10aa4d7

2.4.0

(Re)named exports.

be91778

alxroyer mentioned this pull request Sep 18, 2019

What support for @override tags? #104

Open

alxroyer added 5 commits September 18, 2019 13:25

Warning addition while waiting for [tsd-jsdoc#104](englercj#104 resol…

390222c

…ution.

'export <named type>' pattern support.

69e1671

Fix for 'module.exports = {name: }' pattern.

Named exports with reference to a type of the same name.

91a44e1

'export default <named type>' pattern support (works like a lambda cl…

99d8827

…ass would actually).

'export default <lambda class>' pattern support.

40e18f1

alxroyer added 10 commits September 25, 2019 17:39

Test class_all.js working with 'exported' generation strategy.

8b205c6

Test constructors.js & enum_all.js working with 'exported' generation…

15f02af

… strategy.

Tests function_all.js and interface_all.js working with 'exported' ge…

c0a06d7

…neration strategy. Warn&debug improvements.

Test namespace_all.js working with 'exported' generation strategy.

741ce56

Tests property_all.js and typedef_all.js working with 'exported' gene…

5898db8

…ration strategy.

'documented' & 'exported' test cases.

d9fbb28

Instrumentation for jsdoc 3.5.5 vs 3.6.3 investigations.

jsdoc@3.6.3 installation.

e86b4ef

jsdoc@3.6.3 fixes.

43d80a5

Merge branch 'master' into export-default

eada5f0

# Conflicts: # package-lock.json # package.json # test/expected/class_all.d.ts # test/lib/index.ts

walk-back.d.ts typescript declaration.

bf2eaab

alxroyer added 2 commits April 18, 2020 21:32

walk-back.d.ts: application of "tsd-default-export" recommendations.

1ac9c2c

See: https://github.com/Alexis-ROYER/tsd-default-export/blob/master/README.md

Merge tag 'v2.5.0' into export-default

fb0a981

2.5.0

alxroyer marked this pull request as ready for review April 20, 2020 09:17

englercj requested changes Apr 22, 2020

View reviewed changes

alxroyer added 3 commits April 25, 2020 22:31

Corrections to @englercj’s remarks.

a024bcd

Merge branch 'master' into export-default

80519d5

Fix merge tag 'v2.5.0' into export-default

20d58b6

'exported' tests were not executed due to a false trailing 'r' after `generationStrategy` in `test/lib/index.ts`.

alxroyer requested a review from englercj April 26, 2020 00:00

Corrections to @englercj’s remarks.

5b826a7

englercj approved these changes May 2, 2020

View reviewed changes

englercj merged commit d759376 into englercj:master May 2, 2020

joemaddalone mentioned this pull request Jan 29, 2022

fix types export joemaddalone/path#17

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Have tsd-jsdoc generate default exports #98

Have tsd-jsdoc generate default exports #98

alxroyer commented Sep 2, 2019

alxroyer commented Oct 3, 2019

englercj commented Jan 5, 2020

alxroyer commented Jan 8, 2020

alxroyer commented Apr 20, 2020

englercj commented Apr 22, 2020

englercj left a comment

alxroyer commented May 1, 2020

englercj commented May 2, 2020

alxroyer commented May 2, 2020

Have tsd-jsdoc generate default exports #98

Have tsd-jsdoc generate default exports #98

Conversation

alxroyer commented Sep 2, 2019

alxroyer commented Oct 3, 2019

englercj commented Jan 5, 2020

alxroyer commented Jan 8, 2020

alxroyer commented Apr 20, 2020

englercj commented Apr 22, 2020

englercj left a comment

Choose a reason for hiding this comment

alxroyer commented May 1, 2020

englercj commented May 2, 2020

alxroyer commented May 2, 2020