diff --git a/.npmignore b/.npmignore index 618e05e..4b2af47 100644 --- a/.npmignore +++ b/.npmignore @@ -1,9 +1,12 @@ +.nyc_output/ node_modules/ src/ *.log .npmignore +.travis.yml +mocha.opts tsconfig.json tslint.json yarn.lock diff --git a/README.md b/README.md index da173d5..655d3a4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ It's a chest. With TypeScript inside. -Actually, it's a set of tools to manage TypeScript projects, whether they are stand-alone or workspace-based (either [Yarn](https://yarnpkg.com) or [Lerna](https://lernajs.io). +Actually, it's a set of tools to manage TypeScript projects, whether they are stand-alone or workspace-based (either [Yarn](https://yarnpkg.com) or [Lerna](https://lernajs.io)). # What Problems Get Solved @@ -28,6 +28,36 @@ CHEST will... - Link `@types` dependencies as a `types` array in your `tsconfig.json`, explicitly listing your declaration dependencies. - Propogate desriptive `package.json` properties down to child projects if using [Yarn](https://yarnpkg.com) workspaces. +# Getting Started + +## Command-Line + +If you plan on running `chest` from the command-line: + +```bash +yarn global add @beard/chest +chest +``` + +## Project Package + +If you prefer to install `chest` into a local project: + +```bash +yarn add -D @beard/chest +``` + +Edit your `package.json` file script to perform a post-build action. + +```json +{ + scripts: { + "build": "...", + "postbuild": "chest" + } +} +``` + # Supported Project Management Tools - [Yarn](https://yarnpkg.com) 1.3.2+ diff --git a/package.json b/package.json index f2e0016..dcb301c 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "license": "MIT", "main": "./lib/CLI.js", "typings": "./lib/index.d.ts", - "version": "2.0.0-alpha-1", + "version": "2.0.0-alpha-2", "dependencies": { "chalk": "^2.3.0" }, diff --git a/src/Chest.ts b/src/Chest.ts index 1a6f0be..cece83b 100644 --- a/src/Chest.ts +++ b/src/Chest.ts @@ -1,7 +1,6 @@ import * as path from 'path' -import { Files, NPM, Project, UpdaterType } from './Core' -import { Registry } from 'src'; +import { Files, NPM, Project, Registry, UpdaterType } from './Core' export class Chest { public static async run(root: string, ...args: string[]): Promise {