From 2cdd69b0054032dc47a4fe1a34ad1d9cadcc679b Mon Sep 17 00:00:00 2001 From: cdaringe Date: Tue, 12 Feb 2019 22:49:11 -0800 Subject: [PATCH] fix: patch bogus interfaces import --- README.md | 24 +++++++++++++----------- readme.template.md | 10 ++-------- src/interfaces.ts | 1 - website/src/pages/docs.md | 12 ++++++++++-- 4 files changed, 25 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7edf370..1b56f9b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@

- +

# 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. @@ -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. + + +## 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). + + ### 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)). @@ -338,10 +346,4 @@ const rule: criptRule = create({ # logo credit -[margdking](https://github.com/margdking) - -# todo - -- add persistent urls to - - baked in rules - - `TaskPayload` \ No newline at end of file +[margdking](https://github.com/margdking) \ No newline at end of file diff --git a/readme.template.md b/readme.template.md index f2eb424..9cc19af 100644 --- a/readme.template.md +++ b/readme.template.md @@ -1,13 +1,13 @@

- +

# 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. @@ -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` diff --git a/src/interfaces.ts b/src/interfaces.ts index 2064023..c57ed7f 100644 --- a/src/interfaces.ts +++ b/src/interfaces.ts @@ -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' diff --git a/website/src/pages/docs.md b/website/src/pages/docs.md index 302ce21..326e2ff 100644 --- a/website/src/pages/docs.md +++ b/website/src/pages/docs.md @@ -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. + + +## 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). + + ### 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)).