feat: add support for typescript with jsdoc #568

hugomrdias · 2020-06-02T14:28:20Z

Changes

new eslint jsdoc plugin
add ts cmd with 'check', 'types', 'types-clean', 'docs' modes

Modes:

check checks src and test folders for ts errors
types generates types declarations inline with the source files
types-clean deletes all the *.d.ts files
docs generates documentation based on the type declarations

BREAKING CHANGE: The new jsdoc linter plugin can create new errors!

If we go we this, we still need to swap current documentation with this and add types generation to release cmd.

This PR does not support full typescript projects! This is only for javascript with jsdoc generated types declarations.

- new eslint jsdoc plugin - add ts cmd with 'check', 'types', 'types-clean', 'docs' modes Modes: - `check` checks src and test folders for ts errors - `types` generates types declarations inline with the source files - `type-clean` deletes all the *.d.ts files - `docs` generates documentation based on the type declarations BREAKING CHANGE: The new jsdoc linter plugin can create new errors!

vasco-santos

@hugomrdias can you sync this work with ChainSafe/js-libp2p-gossipsub#77? I would like to not go on different paths here.

cc @wemeetagain

hugomrdias · 2020-06-02T15:48:51Z

@hugomrdias can you sync this work with ChainSafe/js-libp2p-gossipsub#77? I would like to not go on different paths here.

cc @wemeetagain

That's a complete rewrite in ts and not what we want to do with the others repos. Check ipfs/js-ipfs#2945

vasco-santos · 2020-06-02T15:55:30Z

@hugomrdias can you sync this work with ChainSafe/js-libp2p-gossipsub#77? I would like to not go on different paths here.
cc @wemeetagain

That's a complete rewrite in ts and not what we want to do with the others repos. Check ipfs/js-ipfs#2945

What is the reasoning for aegir not supporting things like linting here? I think that we can get to a solution that fits both needs with this. Moreover, I think we should try to leverage the document generation feature that aegir is providing for typescript projects

hugomrdias · 2020-06-02T16:00:10Z

What is the reasoning for aegir not supporting things like linting here?

What do you mean ? linting specific for typescript ?

Moreover, I think we should try to leverage the document generation feature that aegir is providing for typescript projects

Do you mean the current one ? or the one in this PR using typedoc ?

vasco-santos · 2020-06-02T16:10:12Z

What is the reasoning for aegir not supporting things like linting here?

What do you mean ? linting specific for typescript ?

I mean that if aegir supports typescript, for example aegir lint should work for a project like gossipsub. The current PR for gossipsub is moving away from aegir lint, but using the remaining aegir scripts. Ideally, I think that aegir should support this in the context of this PR.

Moreover, I think we should try to leverage the document generation feature that aegir is providing for typescript projects

Do you mean the current one ? or the one in this PR using typedoc ?

I mean this new feature in this PR. I don't want to move gossipsub with a a typescript decision now and later on decide that we want to make things differently to have the automated docs, if we are currently doing both work streams. So, I would like that we see if aegir can support these projects in the basic things now rather than later. If this introduces more complexity now, we can skip it! But at least, I think that it should be considered in this scope.

hugomrdias · 2020-06-02T16:20:21Z

This PR adds support for typescript in the scope of this issue ipfs/js-ipfs#2945 not for full typescript projects.
I updated the description of this PR to be more clear about the scope.

Mixing support for jsdoc type declarations and full typescript projects would be a giant mess.

To implement full ts support we would need another command and another eslint config that would be selected in the lint cmd.

vasco-santos · 2020-06-02T16:26:40Z

This PR adds support for typescript in the scope of this issue ipfs/js-ipfs#2945 not for full typescript projects.
I updated the description of this PR to be more clear about the scope.

Mixing support for jsdoc type declarations and full typescript projects would be a giant mess.

To implement full ts support we would need another command and another eslint config that would be selected in the lint cmd.

Got it. I am still wondering if we should go on the same way on libp2p-gossipsub instead of moving to a minimal typescript version. This was my main goal for raising this, but the conversation moved on a different direction with the description not being clear. But it is @wemeetagain call to decide if going with a minimal typescript version has advantages

achingbrain · 2020-06-05T08:48:22Z

cmds/ts.js

+
+const EPILOG = `
+Presets:
+\`check\` Checks src and test folders for Typescript errors


Will this mean we have to include TS comments on all of our tests?

No, it works as is but it may output errors for some inferred types or defined types in the source code.
Checking the tests enables us to be the users of our own types and be able to identify issues in the types early.

src/utils.js

achingbrain · 2020-06-05T08:50:35Z

src/utils.js

@@ -112,7 +97,7 @@ exports.getPathToNodeModules = () => {
 /**
 * Get the config for Listr.
 *
- * @returns {Object}
+ * @returns {object}


Why has Object changed to object? Is Object not the type?

It's the linter default https://github.com/gajus/eslint-plugin-jsdoc#why-not-capital-case-everything

achingbrain

Questions inline..

achingbrain · 2020-09-11T12:45:56Z

What is left to do on this PR?

hugomrdias · 2020-09-11T15:01:47Z

Nothing its good, just needs to be integrated with the others cmds, by itself its done.

we still need to swap current documentation with this and add types generation to release cmd.

src/config/aegir-tsconfig.json

package.json

src/config/eslintrc.js

Gozala · 2020-09-14T17:53:13Z

src/ts/index.js

+}
+
+const check = async (forwardOptions) => {
+ const configPath = fromRoot('tsconfig-check.json')


I think it would be better to fail if there is no tsconfig.json (which can include single extends directive e.g. { "extends": "aegir/src/config/aegir-tsconfig.json"}) than do this. Otherwise we introduce another instance of other tools like vscode making different assumptions than tools than aegir.

Gozala · 2020-09-14T18:02:41Z

@achingbrain @hugomrdias can I land this, so I could integrate it into ipfs/js-ipfs#3281 ? I think I would want to make some additional changes too, like the ones @Xmader has suggested, because I did run into all those in the mentioned pull. @hugomrdias should I just take over this, or would you rather have me do another pull that builds upon this ?

hugomrdias · 2020-09-15T11:26:37Z

@Gozala just take over this PR or make a new whatever is best to land easy and stable support to ts jsdocs. You already know my main concerns around this topic so just go for it.

Co-authored-by: Xmader <xmader@outlook.com>

Gozala · 2020-09-15T22:01:33Z

So this pull request does following things

ESLint changes (which got superseded by feat: factor eslint config to eslint-config-ipfs #638)
Typedefs generation (also pursued by feat: generate ts types #637)
Docs generation
Type checking

I'll do the the 2nd under #637 and split this up into separate pulls for 3 and 4.

hugomrdias requested a review from achingbrain June 2, 2020 14:29

fix: linter

767bccf

hugomrdias mentioned this pull request Jun 2, 2020

Track: Typescript types support ipfs/js-ipfs#2945

Closed

fix: adds @types mocha and node

01b6551

vasco-santos reviewed Jun 2, 2020

View reviewed changes

hugomrdias changed the title ~~feat: add support for typescript~~ feat: add support for typescript with jsdoc Jun 2, 2020

hugomrdias requested a review from Gozala June 3, 2020 16:12

achingbrain reviewed Jun 5, 2020

View reviewed changes

src/utils.js Outdated Show resolved Hide resolved

achingbrain reviewed Jun 5, 2020

View reviewed changes

achingbrain requested changes Jun 5, 2020

View reviewed changes

fix: typo

6007c29

vasco-santos mentioned this pull request Jun 9, 2020

Support for Typescript users libp2p/js-libp2p#659

Closed

0xjjpa mentioned this pull request Jun 15, 2020

Add Windows-focused compiling tooling to create ready-to-use binary for hopr-chat hoprnet/hopr-core#89

Closed

11 tasks

vasco-santos mentioned this pull request Sep 7, 2020

Add type generation from jsdoc libp2p/js-libp2p-interfaces#64

Merged

achingbrain mentioned this pull request Sep 11, 2020

feat: generate ts types #637

Closed

Xmader reviewed Sep 13, 2020

View reviewed changes

src/config/aegir-tsconfig.json Show resolved Hide resolved

Xmader reviewed Sep 13, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

Xmader reviewed Sep 13, 2020

View reviewed changes

src/config/eslintrc.js Show resolved Hide resolved

Xmader reviewed Sep 13, 2020

View reviewed changes

src/config/eslintrc.js Show resolved Hide resolved

Gozala reviewed Sep 14, 2020

View reviewed changes

Gozala added a commit to ipfs/eslint-config-ipfs that referenced this pull request Sep 14, 2020

chore: pull in changes from ipfs/aegir#568

859c779

Update package.json

226c7ce

Co-authored-by: Xmader <xmader@outlook.com>

Gozala mentioned this pull request Oct 8, 2020

Docs navigation is very confusing ipfs/js-ipfs#3261

Closed

hugomrdias mentioned this pull request Nov 12, 2020

feat: add ts cmd #671

Merged

hugomrdias closed this in #671 Nov 18, 2020

hugomrdias deleted the feat/typescript-support branch February 23, 2021 15:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for typescript with jsdoc #568

feat: add support for typescript with jsdoc #568

hugomrdias commented Jun 2, 2020 •

edited

Loading

vasco-santos left a comment •

edited

Loading

hugomrdias commented Jun 2, 2020

vasco-santos commented Jun 2, 2020

hugomrdias commented Jun 2, 2020

vasco-santos commented Jun 2, 2020

hugomrdias commented Jun 2, 2020

vasco-santos commented Jun 2, 2020

achingbrain Jun 5, 2020

hugomrdias Jun 7, 2020

achingbrain Jun 5, 2020

hugomrdias Jun 7, 2020

achingbrain left a comment

achingbrain commented Sep 11, 2020

hugomrdias commented Sep 11, 2020

Gozala Sep 14, 2020

Gozala commented Sep 14, 2020

hugomrdias commented Sep 15, 2020

Gozala commented Sep 15, 2020

feat: add support for typescript with jsdoc #568

feat: add support for typescript with jsdoc #568

Conversation

hugomrdias commented Jun 2, 2020 • edited Loading

vasco-santos left a comment • edited Loading

Choose a reason for hiding this comment

hugomrdias commented Jun 2, 2020

vasco-santos commented Jun 2, 2020

hugomrdias commented Jun 2, 2020

vasco-santos commented Jun 2, 2020

hugomrdias commented Jun 2, 2020

vasco-santos commented Jun 2, 2020

achingbrain Jun 5, 2020

Choose a reason for hiding this comment

hugomrdias Jun 7, 2020

Choose a reason for hiding this comment

achingbrain Jun 5, 2020

Choose a reason for hiding this comment

hugomrdias Jun 7, 2020

Choose a reason for hiding this comment

achingbrain left a comment

Choose a reason for hiding this comment

achingbrain commented Sep 11, 2020

hugomrdias commented Sep 11, 2020

Gozala Sep 14, 2020

Choose a reason for hiding this comment

Gozala commented Sep 14, 2020

hugomrdias commented Sep 15, 2020

Gozala commented Sep 15, 2020

hugomrdias commented Jun 2, 2020 •

edited

Loading

vasco-santos left a comment •

edited

Loading