ts-package-lint

Utility to create typescript based npm modules. Can also strip reference paths for .d.ts files and check TSD configs.

Building strongly typed npm modules using typescript is quite tricky. Especially if your package depends on other packages and you want to offer typings to consumers of your module. This tool checks your package.json, tsconfig.json and tsd.json files to verify your setup.

The goal of this tool is to help you build a package that consumers can ultimately just do the following:

npm install your-cool-page --save

And in some .ts file:

import coolPackage from "your-cool-package".

Installation

Globally

npm install -g ts-package-lint

Usage

Run ts-package-lint in the root of your package to get information about your current setup.

Run ts-package-lint --fix-typings to strip triple slash references from your typing files so that they can be used directly by other packages. Probably this should be part of your build process, after running the typescript compiler. In that case just run npm install ts-package-lint --save-dev and add something like "build": "tsc && ts-package-lint --fix-typings" to the scripts section of your package.json.

As a development dependency

npm install --save-dev ts-package-lint

Then add it to the scripts property of you package.json

...
  "scripts": {
    ...
    "lint-pkg": "ts-package-lint"
    ...
  }
...

And run it...

npm run lint-pkg

Example output

To get an idea of the things ts-package-lint checks, here the output of the tool on different packages:

[ts-package-lint] package.json doesn't declare a 'typings' entry file. Please include an entry file (without extension), e.g: "typings": "lib/index"

[ts-package-lint] typescript is not registered as build dependency, please install it using 'npm install typescript --save-dev'

[ts-package-lint] No 'tsconfig.json' was found. Please use it to define the default build parameters. See: https://github.com/Microsoft/TypeScript/wiki/tsconfig.json

[ts-package-lint] Some dependencies of this package don't ship with own typings. You can install the 'tsd' tool to manage these. Use 'npm install -g tsd'. For more info see: http://definitelytyped.org/tsd/

[ts-package-lint] No *.d.ts files where found in the compilers output directory (.). Please run the typescript compiler first and make sure the 'declaration' option is enabled.

[ts-package-lint] Some dependencies of this package don't ship with their own typings. You can install the 'tsd' tool to manage these. Use 'npm install -g tsd'. For more info see: http://definitelytyped.org/tsd/. Packages without typings:
  lodash, node-uuid, restler, node

[ts-package-lint] It is recommended to set the compiler output directory using the "outDir" option, so that the typescript sources can be put into .npmignore, and the output files and declaration files in .gitignore. e.g: '"outDir": "lib/"'

[ts-package-lint] Please mention in the documentation of your package that the following typings might need to be installed using 'tsd install <package> --save':
  when, rest, node, lodash, xml2js, jsonpath, assertion-error, chai, mocha, promises-a-plus, chai-as-promised, nock

[ts-package-lint] Found '/// <reference path' d.ts file includes in the following .d.ts files:

  ./test/smoke-test.d.ts: /// <reference path="../typings/tsd.d.ts" />

[ts-package-lint] Please remove those references to make your typings usable for package consumers. Keeping triple slash references might collide with typings used in consuming packages. Remove triple slash references by running 'ts-package-lint --fix-typings' as part of your build process.

One might find some of the hints opiniated. If it raises any questions, please feel free to file an isue for an explanation!

FAQ

Please start asking!

Q: Does it work on windows? A: Didn't test, but it should.

Future ideas

• Query tsd/typings to see whether typings are available
• Instead of proposing a solution, apply a solution
• Add option to only fix typings in a specified dir
• Check typescript version (1.6+ required)