npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

typesync

0.5.1 • Public • Published

typesync

Install missing TypeScript typings for dependencies in your package.json.

npm dependency Status devDependency Status Build Status Coveralls npm npm node

TypeSync

Install

npm install -g typesync

You can also use it directly with npx which will install it for you:

npx typesync

Usage

typesync [path/to/package.json] [--dry]

Path is relative to the current working directory. If omitted, defaults to package.json.

If --dry is specified, will not actually write to the file, it only prints added typings,

Note: typesync only modifies your package.json - you still need to run npm install, or — if drinking the k00laid — yarn.

Typings packages

TypeSync will add typings for packages that:

  • have a @types/package available
  • don't already provide typings internally (the typings and types field in package.json)

TypeSync will try to respect semver parity for the code and typings packages, and will fall back to the latest available typings package.

If you use a Semver ^ or ~ for a package, the same prefix will be used for the typings package. If you pin to an exact version ("some-package": "1.2.3"), no prefix will be written.

Monorepos

TypeSync added support for monorepos in v0.4.0. It will look at packages/workspaces globs in package.json and sync every matching file in one fell swoop.

Why?

Installing typings manually sucks. Flow has flow-typed which installs type definitions by looking at a package.json, which would be cool to have for TypeScript. Now we do!

Changelog

See CHANGELOG.md

Author

Jeff Hansen - @Jeffijoe

Keywords

none

install

npm i typesync

Downloadsweekly downloads

5,565

version

0.5.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability