Single typing file #2108

guybedford · 2018-04-01T17:14:28Z

This fixes up the main Rollup API typings to be a single curated types.d.ts file, which other internal typings then import from.

It does mean maintaining some exported dependency typing boundaries a little. The only real issue is typings of AST Nodes not passing through, but this doesn't seem to much of an issue (I've just aliased these any for now).

What's also quite nice is the typing catches the difference between code splitting and non code splitting cases an outputs, so gives correct IDE hints through the build.

Fixes #2008 and replaces #2094.

lukastaegert

Great work! I'm a big fan!

lukastaegert · 2018-04-02T19:58:25Z

package.json

@@ -5,7 +5,7 @@
  "main": "dist/rollup.js",


This change also means that we can–and should–move all dependencies back into devDependencies so that rollup is now back to its small and lean footprint!

Ahh I missed that these had grown! Will do.

lukastaegert · 2018-04-02T20:02:00Z

Fixes #2008 and replaces #2094

~~I believe it is the other way around?~~

Ah, I see this is actually correct but I guess this should include the changes from #2094 nevertheless.

lukastaegert · 2018-04-02T20:09:41Z

@diervo, @KingHenne, @jthoms1, @alan-agius4, @chadhietala as you have taken some interest in rollup's typings before, maybe you could take a look by installing rollup via

npm install rollup/rollup#typing-file

and see if this works for you? If there are no hard objections I would love to see this released soon.

alan-agius4 · 2018-04-02T20:22:39Z

src/rollup/types.d.ts

+	pluginCode?: string;
+}
+
+export type VERSION = string;


This doesn't look right, AFAIK VERSION return a string value and thus it should be a const and not type.

The usage I believe is:

import { VERSION } from 'rollup'; const rollupVersion = VERSION:

Therefore the typing should be:

export const VERSION: string;

alan-agius4 · 2018-04-02T20:24:44Z

src/rollup/index.ts

 import ensureArray from '../utils/ensureArray';
 import { SourceMap } from 'magic-string';
 import { createAddons } from '../utils/addons';
 import commondir from '../utils/commondir';
-
-export const VERSION = '<@VERSION@>';


Has this been removed on purpose?

Well caught - yes I removed this one by mistake.

alan-agius4 · 2018-04-02T20:33:06Z

src/rollup/types.d.ts

+	perf?: boolean;
+
+	// deprecated
+	entry?: string;


just a small note, for deprecations, I suggest to use /** @deprecated */ on top of each property that is deprecated, rather than a plain comment like this.

Reason being is that if you have tslint it can warn you that you are using a deprecated property, so do the IDE's or any code analyse tool such as SonarCube.

alan-agius4 · 2018-04-02T20:51:29Z

Good stuff @guybedford!

I tried them out and they do work, Just felt a couple of comment.

Just a small side note @types/node will still need to be installed as a devDependency by the consumers of rollup typings due to the dependency on events module. As otherwise it will cause node_modules/rollup/dist/rollup.d.ts(1,30): error TS2307: Cannot find module 'events'.

What I don't like in all fairness the fact that the types for source-map are copied in the rollup typings, which means that you need to keep the typings of rollup in sync with your code base. (Since now they are not automatically generated via TS) and source-maps interfaces if they do any change.

unstubbable

I also added a few notes, and most importantly when I run $(npm bin)/tsc -p . --noEmit I get 5 compiler errors. (Maybe this should be part of the script that's run by Travis and AppVeyor?).

unstubbable · 2018-04-03T14:19:54Z

package.json

@@ -22,7 +22,7 @@
    "posttest-coverage": "remap-istanbul -i coverage/coverage-final.json -o coverage/coverage-remapped.json -b dist && remap-istanbul -i coverage/coverage-final.json -o coverage/coverage-remapped.lcov -t lcovonly -b dist && remap-istanbul -i coverage/coverage-final.json -o coverage/coverage-remapped -t html -b dist",
    "ci": "npm run test-coverage && codecov < coverage/coverage-remapped.lcov",
    "prebuild": "rm -rf dist",
-    "build": "git rev-parse HEAD > .commithash && rollup -c && tsc -p tsconfig-types.json && chmod a+x bin/rollup",
+    "build": "git rev-parse HEAD > .commithash && rollup -c && cp src/rollup/types.d.ts dist/rollup.d.ts && chmod a+x bin/rollup",


I think tsconfig-types.json is now obsolete and can be removed.

unstubbable · 2018-04-03T14:29:57Z

package.json

@@ -5,7 +5,7 @@
  "main": "dist/rollup.js",
  "module": "dist/rollup.es.js",
  "jsnext:main": "dist/rollup.es.js",
-  "typings": "dist/typings/node-entry.d.ts",
+  "typings": "dist/rollup.d.ts",


Since there are no files in dist/typings and the files in typings are not relevant anymore for the published artifact:

the script "pretest:typescript" can be simplified to "rm -rf test/typescript/dist && cp -r dist test/typescript/" and

"typings/package.json.d.ts" can be removed from "files".

unstubbable · 2018-04-03T14:39:57Z

src/rollup/types.d.ts

@@ -0,0 +1,343 @@
+import { EventEmitter } from 'events';
+
+// ast node types just any, unless acorn public dependency added


Hm, that's kind of a step back. As a plugin author I'm loosing information here since Program and Node are referenced (indirectly) in some of the hooks.

guybedford · 2018-04-03T16:18:18Z

I've removed the unused package.json dependencies and scripts, and updated the dependencies to just reference types/estree and types/node generically.

Thanks all for feedback so far - please try it out again and let me know any further comments.

unstubbable

I think you need to update the package-lock.json file. And there are still compiler errors (now 7). (I executed $(npm bin)/tsc -p . --noEmit.)

unstubbable · 2018-04-04T08:07:16Z

src/rollup/types.d.ts


-// ast node types just any, unless acorn public dependency added
-export type Program = any;
-export type Node = any;


guybedford · 2018-04-04T12:44:30Z

Thanks @KingHenne, I've fixed those remaining type errors.

unstubbable · 2018-04-04T12:59:20Z

package.json

-    "require-relative": "^0.8.7",
-    "rollup-pluginutils": "^2.0.1"
+    "@types/estree": "0.0.38",
+    "@types/node": "*"


This results in npm WARN The package @types/node is included as both a dev and production dependency.. But maybe you still want it to be this way so that the dependency can specify that any version works? Is that even true, i.e. is any version of @types/node compatible with the rollup types?

Thanks, I missed the devDependency here actually (and for some reason my npm wasn't giving a warning on this).

Well EventEmitter has been there since the very start in Node so yes, any version. The star is so that it can work alongside any version a user may install.

unstubbable · 2018-04-04T13:24:59Z

src/Module.ts

@@ -148,7 +134,7 @@ export default class Module {
 	chunk: Chunk;

 	ast: Program;
-	private astClone: Program;
+	private astClone: ESTree.Program;


This confuses me. Shouldn't ast and astClone have the same type?

There are really three things here not two - ast, astClone and enhancedAst. ast doubles as both EStree and the enhanced form, while the cache API for ast and astClone relies only on the EStree interface.

Interesting. Should ast be defined as Program & ESTree.Program then?

Program is a superset of ESTree.Program, so that would be the same thing here I think.

I think that is the confusing part to me, because the ast that is passed to setSource is defined as ESTree.Program (via ModuleJSON). So assigning it to a field of type Program, which is supposed to be a superset, is technically an error then which is hidden by the type cast, right?

The way to think about this is that Module.ast when first assigned is an ESTree.Program but transitions to a Rollup.Program during the enhance call (initiated by analyse). When Module.ast is exported, cloned or copied, even though it is a Rollup.Program it is only needed to be a ESTree.Program through the cache interfaces, as later on enhance will be called again on it.

That's why I say it's really two things - Module.enhancedAst and Module.ast.

Note this problem is only temporary as I am currently working on a branch that will finally separate these two types. In the end, Module.ast will be only a Program while the Program constructor will receive an ESTree.Program as parameter.

Hm, that's tricky. In my opinion, it should really be ESTree.Program | Program then and consequently all five places with compiler errors that result from this change should get a guard so that this won't lead to a cryptic runtime error in the future when someone changes how and when the different methods in Module are called for some reason, e.g.:

if ('bind' in node) { node.bind(); }

or:

if (!('bind' in node)) { throw new Error('Unexpected AST node found. ...'); }

EDIT: Just saw the comment by @lukastaegert. This is then fine for me. 🙂

unstubbable · 2018-04-04T13:25:59Z

src/Module.ts

 			this.astClone = ast;
 		} else {
 			// TODO what happens to comments if AST is provided?
-			this.ast = <any>tryParse(this, this.graph.acornParse, this.graph.acornOptions);
-			this.astClone = clone(this.ast);
+			this.ast = <Program>tryParse(this, this.graph.acornParse, this.graph.acornOptions);


Continuing my previous question: Isn't this.graph.acornParse returning an ESTree.Program?

Yes, but then we mutate this later through enhance, and TypeScript doesn't support mutating a type!

lukastaegert · 2018-04-15T13:08:51Z

Sorry for the wait, will merge this today.

guybedford force-pushed the typing-file branch 2 times, most recently from 543e7c2 to fa33b83 Compare April 1, 2018 17:25

lukastaegert approved these changes Apr 2, 2018

View reviewed changes

alan-agius4 reviewed Apr 2, 2018

View reviewed changes

unstubbable suggested changes Apr 3, 2018

View reviewed changes

unstubbable suggested changes Apr 4, 2018

View reviewed changes

guybedford force-pushed the typing-file branch from baaed0d to 794bd74 Compare April 4, 2018 12:46

unstubbable reviewed Apr 4, 2018

View reviewed changes

unstubbable approved these changes Apr 5, 2018

View reviewed changes

guybedford mentioned this pull request Apr 5, 2018

Better WebAssembly integration #2099

Open

guybedford added 4 commits April 13, 2018 14:41

single interface typing file

3d9c0c1

pr feedback

f9d8300

fix remaining typing warnings, package lock update

332f0ab

remove node type dev dependency

1223784

guybedford force-pushed the typing-file branch from 9d3c8a4 to 1223784 Compare April 13, 2018 12:44

lukastaegert merged commit 1223784 into master Apr 15, 2018

lukastaegert deleted the typing-file branch April 15, 2018 13:20

lukastaegert added this to the 0.58.0 milestone Apr 16, 2018

lukastaegert added the Fixed pending release label Apr 16, 2018

lukastaegert mentioned this pull request Apr 16, 2018

Move @types/acorn dependencies => devDependencies #2094

Closed

lukastaegert removed the fixed pending release label Apr 16, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Single typing file #2108

Single typing file #2108

guybedford commented Apr 1, 2018

lukastaegert left a comment

lukastaegert Apr 2, 2018

guybedford Apr 3, 2018

lukastaegert commented Apr 2, 2018 •

edited

Loading

lukastaegert commented Apr 2, 2018

alan-agius4 Apr 2, 2018 •

edited

Loading

guybedford Apr 3, 2018

alan-agius4 Apr 2, 2018 •

edited

Loading

guybedford Apr 3, 2018

alan-agius4 Apr 2, 2018 •

edited

Loading

alan-agius4 commented Apr 2, 2018 •

edited

Loading

unstubbable left a comment •

edited

Loading

unstubbable Apr 3, 2018

unstubbable Apr 3, 2018 •

edited

Loading

unstubbable Apr 3, 2018

guybedford commented Apr 3, 2018

unstubbable left a comment

unstubbable Apr 4, 2018

guybedford commented Apr 4, 2018

unstubbable Apr 4, 2018

guybedford Apr 4, 2018

unstubbable Apr 4, 2018

guybedford Apr 4, 2018

unstubbable Apr 4, 2018

guybedford Apr 4, 2018

unstubbable Apr 4, 2018

guybedford Apr 4, 2018

lukastaegert Apr 4, 2018

unstubbable Apr 4, 2018 •

edited

Loading

unstubbable Apr 4, 2018

guybedford Apr 4, 2018

lukastaegert commented Apr 15, 2018

		@@ -0,0 +1,343 @@
		import { EventEmitter } from 'events';

		// ast node types just any, unless acorn public dependency added

Single typing file #2108

Single typing file #2108

Conversation

guybedford commented Apr 1, 2018

lukastaegert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukastaegert commented Apr 2, 2018 • edited Loading

lukastaegert commented Apr 2, 2018

alan-agius4 Apr 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alan-agius4 Apr 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alan-agius4 Apr 2, 2018 • edited Loading

Choose a reason for hiding this comment

alan-agius4 commented Apr 2, 2018 • edited Loading

unstubbable left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unstubbable Apr 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guybedford commented Apr 3, 2018

unstubbable left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guybedford commented Apr 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unstubbable Apr 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukastaegert commented Apr 15, 2018

lukastaegert commented Apr 2, 2018 •

edited

Loading

alan-agius4 Apr 2, 2018 •

edited

Loading

alan-agius4 Apr 2, 2018 •

edited

Loading

alan-agius4 Apr 2, 2018 •

edited

Loading

alan-agius4 commented Apr 2, 2018 •

edited

Loading

unstubbable left a comment •

edited

Loading

unstubbable Apr 3, 2018 •

edited

Loading

unstubbable Apr 4, 2018 •

edited

Loading