https://github.com/charto/autodts
DEPRECATED (TypeScript 1.8 includes all functionality)
https://github.com/charto/autodts
Last synced: 9 months ago
JSON representation
DEPRECATED (TypeScript 1.8 includes all functionality)
- Host: GitHub
- URL: https://github.com/charto/autodts
- Owner: charto
- License: mit
- Created: 2015-08-03T16:49:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-28T12:12:48.000Z (about 10 years ago)
- Last Synced: 2025-03-21T23:51:15.553Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DEPRECATED
==========
This module will no longer be updated, since TypeScript 1.8 already includes the same functionality.
autodts
=======
[](https://www.npmjs.com/package/autodts) [](https://david-dm.org/charto/autodts)
`autodts` generates `.d.ts` files for publishing TypeScript projects on npm.
Usage
-----
It's best to run `autodts` from the `package.json` file of a Node.js module. Here's an example:
```json
{
"name": "example",
"version": "0.0.1",
"description": "Example of a TypeScript-based package",
"scripts": {
"preinstall": "npm install autodts",
"postinstall": "autodts link",
"prepublish": "tsc && autodts generate"
},
"typescript": {
"definition": "index.d.ts"
},
"dependencies": {
"autodts": "~0.0.6",
"@lib/dependency-example": "0.0.3"
},
"devDependencies": {
"@lib/autodts-generator": "~0.0.1",
"typescript": "~1.5.3"
}
}
```
The `preinstall` command is needed to work around [npm issue #5001](https://github.com/npm/npm/issues/5001).
`autodts link` checks all packages listed in `dependencies`. If their `package.json` file contains a `typescript` section with a `definition` setting, a reference is added to the output file `typings/auto.d.ts`, for example:
```typescript
// Automatically generated file. Edits will be lost.
///
```
This allows pulling the type information of all required modules into a TypeScript source file with a single `/// ` statement.
An entire tree of npm packages written in TypeScript can be installed with correct references to typings if packages referencing types from others add the above `preinstall` and `postinstall` sections in their `package.json`.
It's possible to change the output file path using the `--out` parameter, for example: `autodts link --out typings/tsd.d.ts`.
`autodts generate` calls [autodts-generator](https://www.npmjs.com/package/@lib/autodts-generator) to produce a single `.d.ts` file with all type information in the package. It will be automatically written to the path defined in the `definition` setting in the `typescript` section of your `package.json` file. Using it requires a particular package structure, otherwise it's better to use [dts-generator](https://www.npmjs.com/package/dts-generator) directly.
To use the `generate` command, you should add `@lib/autodts-generator` to your `devDependencies`. `autodts` doesn't automatically require it, because it pulls the entire TypeScript compiler and is not needed for the `link` command.
`autodts link` is meant for the common case of installing TypeScript-based npm packages, `autodts generate` for the rarer event of publishing them.
License
=======
[The MIT License](https://raw.githubusercontent.com/charto/autodts/master/LICENSE)
Copyright (c) 2015 BusFaster Ltd