Standard package.json key for .ts files

[appsforartists]

A common TypeScript module structure looks like this:

src/index.ts
dist/index.js
dist/index.d.ts

and a package.json that looks like this:

  "main": "dist/index.js",
  "types": "dist/index.d.ts",

There's a convention to use the package.json key jsnext:main to point to a variant of main that uses ES2015 module syntax. Can we develop a similar convention to point at .ts files, e.g. typescript:main?

Consider a TypeScript project that is sharded across many microlibraries (e.g. my-project-core, my-project-thing-plugin, my-project-other-thing-plugin). I'd like to be able to configure my bundler to import from src/*.ts files for any module whose name starts with my-project. Otherwise, it will be looking in dist/*.js and I'll have to rebuild the plugins any time I make changes in them.

Of course, I could use jsnext:main for this purpose now, but any consumers who aren't using TypeScript would get syntax errors for any files that contained TS-specific syntax like types. Similarly, I could make up my own package.json key and configure my bundler to look there first, but it behooves the community to have a convention here. That will allow bundlers like Webpack, Browserify, Rollup, and Pundle to look in the right place by default.

[appsforartists]

This may be a Feature Request more than a Question. tsc and/or Language Services should follow the same rule, otherwise autocomplete across packages would be broken until a new build occurs.

[blakeembrey]

Side note (in case anyone else references the OP): the types field would usually point to dist/index.d.ts and not src.

[appsforartists]

@blakeembrey fixed.

[appsforartists]

I have this working in both Pundle (http://codereview.cc/D2470) and Webpack (http://codereview.cc/D2472).

And I'm considering opening PRs against RxJS, Cycle, xstream, and Angular to test it with common packages.

[DanielRosenwasser]

I don't see the harm in it, but I'm not sure whether or not I understand the implications.

Consider a TypeScript project that is sharded across many microlibraries (e.g. my-project-core, my-project-thing-plugin, my-project-other-thing-plugin). I'd like to be able to configure my bundler to import from src/*.ts files for any module whose name starts with my-project. Otherwise, it will be looking in dist/*.js and I'll have to rebuild the plugins any time I make changes in them.

The thing is that if I'm not mistaken, this will still require a full type-check across all of your code (though it can avoid scanning/parsing/binding/sometimes emitting for individual files). @mhegazy is that correct?

[mhegazy]

I do not think sharing sources between projects is something i would recommend. .d.ts files are meant for the sharing scenario. jsxnext:main is meant for bundelers, and is already well defined; but this is a different scenario.