Skip to content

Commit

Permalink
fix: patch bogus interfaces import
Browse files Browse the repository at this point in the history
  • Loading branch information
cdaringe committed Feb 13, 2019
1 parent 7537c31 commit 2cdd69b
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 22 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- AUTO GENERATED - DO NOT EDIT -->
<p align="center"><img height="80px" src="https://github.com/cdaringe/counsel/raw/master/img/counsel.png" /></p>
<p align="center">
<img src="img/demo-apply.svg" />
<img src="https://cdaringe.github.io/counsel/static/demo-apply-bef8a2b7283196e26d7cc45340443922.svg" />
</p>

# counsel

[![CircleCI](https://circleci.com/gh/cdaringe/counsel.svg?style=svg)](https://circleci.com/gh/cdaringe/counsel) ![](https://img.shields.io/badge/standardjs-%E2%9C%93-brightgreen.svg) [![TypeScript package](https://img.shields.io/badge/language-typescript-blue.svg)](https://www.typescriptlang.org)

the end of boilerplate. bake structure, opinions, and rules into projects.
the end of boilerplate. bake structure, opinions, and rules into projects. see the [documentation site](https://cdaringe.github.io/counsel/).

it's similar to the popular [yeoman/yo](http://yeoman.io/) package, but manages
projects programmatically versus using boilerplate.
Expand Down Expand Up @@ -216,13 +216,21 @@ const installRule: Rule = {
by using [semver](https://www.npmjs.com/package/semver) ranges, you can pin dependencies
with moderate precision or flexibility.

<a name='typings'></a>

## typings

it is worth brief mention that the majority of counsel's interfaces/typings are packed nicely
into a < 100 LOC file [here, for your viewing](https://github.com/cdaringe/counsel/blob/master/src/interfaces.ts).


<a name='taskpayload'></a>

### TaskPayload

`plan` and `check` received a task payload as input. the payload is rich with
`plan` and `check` receive a task payload as input. the payload is rich with
data and async functions to help plan and check. check out the typings in the
[api documentation](https://counsel.github.io/api#taskpayload).
[source code](https://github.com/cdaringe/counsel/blob/7537c31c3cce4bdaaaae18718b53cf9719bb29fb/src/interfaces.ts#L67) ([1](https://github.com/cdaringe/counsel/blob/7537c31c3cce4bdaaaae18718b53cf9719bb29fb/src/interfaces.ts#L28), [2](https://github.com/cdaringe/counsel/blob/7537c31c3cce4bdaaaae18718b53cf9719bb29fb/src/interfaces.ts#L46)).

<a name='batteries'></a>

Expand Down Expand Up @@ -338,10 +346,4 @@ const rule: criptRule = create({

# logo credit

[margdking](https://github.com/margdking)

# todo

- add persistent urls to
- baked in rules
- `TaskPayload`
[margdking](https://github.com/margdking)
10 changes: 2 additions & 8 deletions readme.template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p align="center"><img height="80px" src="https://github.com/cdaringe/counsel/raw/master/img/counsel.png" /></p>
<p align="center">
<img src="img/demo-apply.svg" />
<img src="https://cdaringe.github.io/counsel/static/demo-apply-bef8a2b7283196e26d7cc45340443922.svg" />
</p>

# counsel

[![CircleCI](https://circleci.com/gh/cdaringe/counsel.svg?style=svg)](https://circleci.com/gh/cdaringe/counsel) ![](https://img.shields.io/badge/standardjs-%E2%9C%93-brightgreen.svg) [![TypeScript package](https://img.shields.io/badge/language-typescript-blue.svg)](https://www.typescriptlang.org)

the end of boilerplate. bake structure, opinions, and rules into projects.
the end of boilerplate. bake structure, opinions, and rules into projects. see the [documentation site](https://cdaringe.github.io/counsel/).

it's similar to the popular [yeoman/yo](http://yeoman.io/) package, but manages
projects programmatically versus using boilerplate.
Expand All @@ -21,9 +21,3 @@ projects programmatically versus using boilerplate.
# logo credit

[margdking](https://github.com/margdking)

# todo

- add persistent urls to
- baked in rules
- `TaskPayload`
1 change: 0 additions & 1 deletion src/interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { Context } from './counsel' // eslint-disable-line no-unused-vars
import { createLogger } from './logger'
import * as fs from 'fs-extra'
import * as path from 'path'
Expand Down
12 changes: 10 additions & 2 deletions website/src/pages/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,13 +201,21 @@ const installRule: Rule = {
by using [semver](https://www.npmjs.com/package/semver) ranges, you can pin dependencies
with moderate precision or flexibility.

<a name='typings'></a>

## typings

it is worth brief mention that the majority of counsel's interfaces/typings are packed nicely
into a < 100 LOC file [here, for your viewing](https://github.com/cdaringe/counsel/blob/master/src/interfaces.ts).


<a name='taskpayload'></a>

### TaskPayload

`plan` and `check` received a task payload as input. the payload is rich with
`plan` and `check` receive a task payload as input. the payload is rich with
data and async functions to help plan and check. check out the typings in the
[api documentation](https://counsel.github.io/api#taskpayload).
[source code](https://github.com/cdaringe/counsel/blob/7537c31c3cce4bdaaaae18718b53cf9719bb29fb/src/interfaces.ts#L67) ([1](https://github.com/cdaringe/counsel/blob/7537c31c3cce4bdaaaae18718b53cf9719bb29fb/src/interfaces.ts#L28), [2](https://github.com/cdaringe/counsel/blob/7537c31c3cce4bdaaaae18718b53cf9719bb29fb/src/interfaces.ts#L46)).

<a name='batteries'></a>

Expand Down

0 comments on commit 2cdd69b

Please sign in to comment.