Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.nyc_output/
node_modules/
src/

*.log

.npmignore
.travis.yml
mocha.opts
tsconfig.json
tslint.json
yarn.lock
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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+
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
3 changes: 1 addition & 2 deletions src/Chest.ts
Original file line number Diff line number Diff line change
@@ -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<void> {
Expand Down