Auto generate TypeScript definition to allow chaining #884

ivogabe · 2016-05-27T18:52:18Z

I've implemented a generator that will create the TS definitions, with full support for chaining. Writing these type definitions by hand would be a lot of work or inaccurate. See the first comment in types/generator.js for details on how these definitions are created.

Fixes #871. Tests for this would be useful too, see #870.

@jamestalmage @SamVerschueren What do you think?

novemberborn · 2016-05-29T13:58:14Z

Haven't really looked at the generate script, but I think it'd be fine for it to use ES2015 (and thus require Node 6). It's something we'd have to run locally and then check in the results.

SamVerschueren · 2016-05-29T17:15:22Z

types/generate.js

+var base = fs.readFileSync(path.join(__dirname, 'base.d.ts')).toString();
+
+// All suported function names
+var allParts = ['serial', 'before', 'after', 'skip', 'todo', 'failing', 'only', 'beforeEach', 'afterEach', 'cb', 'always'];


It would be nice if it was exported from within the library https://github.com/avajs/ava/blob/master/lib/runner.js#L11. Then if something changes, the generate script shouldn't be adjusted.

But then again, should libraries export stuff because of "documentation" purposes.

Sounds like a good idea, it can be really annoying that the type definitions are not up to date.

ivogabe · 2016-05-29T20:23:23Z

I've addressed most of the comments and fixed the linting issues. Can you take another look?

SamVerschueren · 2016-05-30T09:34:08Z

types/generate.js

@@ -0,0 +1,122 @@
+// TypeScript definitions are generated here.


'use strict'

sindresorhus · 2016-05-30T10:12:45Z

Can you call the file generate.js => make.js instead and add a npm run script for it, like "make-ts": "node types/make.js".

And Travis is failing.

SamVerschueren · 2016-05-30T10:27:09Z

I would make the file executable. './make.js'

jamestalmage · 2016-06-01T21:00:54Z

lib/runner.js

 	return Promise.resolve(this.tests.build(this._bail).run()).then(this._buildStats);
 };
+
+Runner._chainableMethods = chainableMethods.chainableMethods;


Should we wrap these options in a generator function? So we aren't exporting a mutable copy?

@jamestalmage Doesn't matter. It's for internal use only.

jamestalmage · 2016-06-03T18:22:44Z

Are we good here? This all looks good to me. @SamVerschueren - should I merge?

SamVerschueren · 2016-06-03T19:41:01Z

I did not test the output though but generally everything looks good. If you want me to test it more thoroughly, I'm ok with that. If you want to merge, that's ok as well. We can always finetune in follow up commits.

Great work @ivogabe!

jamestalmage · 2016-06-03T19:48:28Z

Should we be storing generated.d.ts in the repo?

Why not add it to .gitignore and create it in a prepublish script?

SamVerschueren · 2016-06-04T11:06:01Z

Good point. Don't see any downside of doing that.

ivogabe · 2016-06-04T11:56:12Z

I usually don't add generated files to a repo, though I had two reasons now: it's still possible to install AVA from GitHub, and you can easily see what changed when you update the generator script.

jamestalmage · 2016-06-04T22:56:04Z

I'd prefer ignoring it if possible.

It would be awesome if npm had a "installed from GitHub" hook

SamVerschueren · 2016-06-05T10:13:47Z

Can it be executed on postinstall maybe? This would overwrite the generated.d.ts shipped with npm though.

ivogabe · 2016-06-08T20:22:04Z

I've added it to .gitignore. postinstall won't work, since the generator script requires NodeJS 6. I think that TS users already know that it's usually not possible to install a package from GitHub. Do you agree?

jamestalmage · 2016-06-08T20:40:33Z

I think that TS users already know that it's usually not possible to install a package from GitHub.

I say we start with it this way, and see if there are lots of complaints.

jamestalmage · 2016-06-13T21:44:44Z

package.json

    "test-win": "tap --no-cov --reporter=classic --timeout=150 test/*.js test/reporters/*.js",
-    "visual": "node test/visual/run-visual-tests.js"
+    "visual": "node test/visual/run-visual-tests.js",
+    "make-ts": "node types/make"


This should probably be a prepublish script. Otherwise I am going to forget this step when publishing.

jamestalmage · 2016-06-13T21:56:56Z

I think that script generation should happen in a prepublish script. Otherwise, I think we are good to go.

ivogabe · 2016-06-15T11:19:21Z

@jamestalmage I would agree, but I'm afraid that the package cannot be published anymore with that change... The generation script uses ES2015, thus needs Node 6, and npm publish is broken on Node 6.

SamVerschueren · 2016-06-15T11:25:44Z

@ivogabe I can't find features that can only be ran on Node 6 (spread operators for instance). Node 4 supports the majority of those features as well.

ivogabe · 2016-06-15T11:37:38Z

That makes life easier then. I've added it in 54a8324.

jamestalmage · 2016-06-15T18:33:23Z

You need to polyfill .includes. I see no reason not to just require('babel-polyfill') for this.

jamestalmage · 2016-06-18T06:54:16Z

types/make.js

+// `after.cb` is fully written, and `cb.after` is emitted as an alias
+// using `typeof after.cb`.
+
+const path = require('path');


const => var throughout. It's not supported on Node 0.12 or 0.10.

Hopefully, that's the last of it. I would like to get this merged.

Same with arrow functions, let, etc, used here. Would be much easier to just require('babel/register') this script.

sindresorhus · 2016-06-29T20:47:15Z

@ivogabe ping :) => #884 (comment)

ivogabe · 2016-07-01T21:00:21Z

Sorry, I've been too busy lately and forgot about this. I've added babel/register, I thought it was easiest to do that in package.json, otherwise I would need to add another file that required babel and the generation script.

sindresorhus · 2016-07-03T22:11:36Z

package.json

-    "visual": "node test/visual/run-visual-tests.js"
+    "visual": "node test/visual/run-visual-tests.js",
+    "prepublish": "npm run make-ts",
+    "make-ts": "node -e \"require('babel-register')({ presets: 'babel-preset-es2015' }); require('./types/make');\""


Actually, we could just use babel-node here instead of node. We just need to add babel-cli as a devDependency. Then we could drop this boilerplate.

https://babeljs.io/docs/usage/cli/#babel-node

This will also fix running it on Node.js 0.10 which is currently failing and would let you remove the polyfills in https://github.com/avajs/ava/pull/884/files#diff-148e5d484548912a06d9d0dd7cd4f891R19

ivogabe · 2016-07-13T07:10:00Z

Does babel-node require more configuration? It still fails on node 0.10 and 0.12. The tests are failing on node 4, has anyone an idea why?

sindresorhus · 2016-07-13T16:51:31Z

@ivogabe Unfortunately yes, since Babel 6 everything needs config.

Replace it with:

"make-ts": "babel-node --presets=babel-preset-es2015 --plugins=transform-runtime types/make.js"

sindresorhus · 2016-07-13T17:49:43Z

Awesome! Thanks for working on this @ivogabe :)

SamVerschueren · 2016-07-13T17:50:00Z

Nice work @ivogabe !

ivogabe · 2016-07-13T17:55:14Z

🎉

ivogabe added 3 commits May 27, 2016 19:30

Generate type definitions that allow chaining

02f0986

Add notRegex to TypeScript definitions

cf9a7b4

Change ava to AVA

724f1e4

SamVerschueren reviewed May 29, 2016
View reviewed changes

Address PR feedback & linting errors

4cf7bd5

SamVerschueren reviewed May 30, 2016
View reviewed changes

types/generate.js

@@ -0,0 +1,122 @@

// TypeScript definitions are generated here.

Copy link

Contributor

SamVerschueren May 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'use strict'

Address code review

a275089

jamestalmage mentioned this pull request Jun 1, 2016

Add support for test macros in Typescript definitions #895

Closed

jamestalmage reviewed Jun 1, 2016
View reviewed changes

Add types/generated.d.ts to gitignore

7a3b4ed

jamestalmage reviewed Jun 13, 2016
View reviewed changes

Add TS generation script as republish script

54a8324

ivogabe added 2 commits June 16, 2016 13:20

Support Node 4 in TS generation script

984184b

Fix linting issue

ef6e73f

jamestalmage reviewed Jun 18, 2016
View reviewed changes

Run TS generation script on old NodeJS versions using Babel

43cd1f8

sindresorhus reviewed Jul 3, 2016
View reviewed changes

ivogabe added 3 commits July 13, 2016 08:39

Merge remote-tracking branch 'avajs/master' into types-generator

353d104

Use babel-node

8008357

Accept PromiseLike instead of Promise (avajs#960)

d7c4fcb

Configure babel-node

322445d

sindresorhus merged commit 1dd6d5b into avajs:master Jul 13, 2016

ChristianMurphy mentioned this pull request Jul 21, 2016

support test macros in typescript definitions #975

Merged

sindresorhus mentioned this pull request Aug 2, 2016

Flow type definition #986

Closed

		@@ -0,0 +1,122 @@
		// TypeScript definitions are generated here.

Auto generate TypeScript definition to allow chaining #884

Auto generate TypeScript definition to allow chaining #884

Uh oh!

Conversation

ivogabe commented May 27, 2016

Uh oh!

novemberborn commented May 29, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivogabe commented May 29, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sindresorhus commented May 30, 2016

Uh oh!

SamVerschueren commented May 30, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jamestalmage commented Jun 3, 2016

Uh oh!

SamVerschueren commented Jun 3, 2016

Uh oh!

jamestalmage commented Jun 3, 2016

Uh oh!

SamVerschueren commented Jun 4, 2016

Uh oh!

ivogabe commented Jun 4, 2016

Uh oh!

jamestalmage commented Jun 4, 2016

Uh oh!

SamVerschueren commented Jun 5, 2016

Uh oh!

ivogabe commented Jun 8, 2016

Uh oh!

jamestalmage commented Jun 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jamestalmage commented Jun 13, 2016

Uh oh!

ivogabe commented Jun 15, 2016

Uh oh!

SamVerschueren commented Jun 15, 2016

Uh oh!

ivogabe commented Jun 15, 2016

Uh oh!

jamestalmage commented Jun 15, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sindresorhus commented Jun 29, 2016

Uh oh!

ivogabe commented Jul 1, 2016

Uh oh!

sindresorhus Jul 3, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivogabe commented Jul 13, 2016

Uh oh!

sindresorhus commented Jul 13, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sindresorhus commented Jul 13, 2016

Uh oh!

SamVerschueren commented Jul 13, 2016

Uh oh!

ivogabe commented Jul 13, 2016

Uh oh!

Reviewers

Assignees

Labels

sindresorhus Jul 3, 2016 •

edited

Loading

sindresorhus commented Jul 13, 2016 •

edited

Loading