protocol/packages/typescript-typings
Alex Browne e7d5ceb9c5
feat: Add support for TypeScript project references (#991)
* Update all package.json and tsconfig.json

* fix(contracts): Make test/utils/web3_wrapper.ts compatible with project refs

* Fix webpack config for 0x.js

* Fix linter errors by adding rootDir to tsconfig.json as needed

* Add build:ts and watch:ts commands to package.json

* Update sra-spec to work with project references

* Update tsconfig.json with latest new/removed packages

* Add TypeScript as devDependency at root

* Add missing rootDir to forwarder-helper package

* Use a separate tsconfig file for typedoc

* Fix linter errors

* Apply PR feedback (add comments)

* Fix 0x.js tsconfig
2018-08-29 11:15:30 -07:00
..
2018-03-27 19:16:13 +01:00
2018-08-24 19:11:10 +01:00
2018-08-24 19:11:10 +01:00
2018-03-27 17:47:04 +02:00

@0xproject/typescript-typings

Type repository for external packages used by 0x. This is like our small version of DefinitelyTyped

Installation

yarn add -D @0xproject/typescript-typings

Usage

Add the following line within an compilerOptions section of your tsconfig.json

"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"]

This will allow the TS compiler to first look into that repo and then fallback to DT types.

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0xproject/typescript-typings yarn build

Or continuously rebuild on change:

PKG=@0xproject/typescript-typings yarn watch

Clean

yarn clean

Lint

yarn lint