Skip to content

Commit

Permalink
docs(readme): updated readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
spiltcoffee committed Jan 26, 2021
1 parent debaa00 commit a7e8dba
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 43 deletions.
18 changes: 9 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You will need the following software to help develop this project:
Before running any commands, you'll likely have to run the following:

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn install
```

Expand All @@ -60,7 +60,7 @@ $ yarn install
In order to see all of the operations that would be run in the Continuous Integration, run:

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn ci
```

Expand All @@ -71,15 +71,15 @@ We use `prettier` for formatting and `eslint` with `typescript-eslint` for linti
To see the linting and formatting issues, run:

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn lint:check
$ yarn format:check
```

To have as many issues as possible fixed by the tools, run:

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn lint:fix
$ yarn format:fix
```
Expand All @@ -91,7 +91,7 @@ Make sure to run `format:fix` last, as that's what the CI will perform. If there
`postdfm` uses TypeScript and Nearley.js, so some compilation is required. Run:

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn compile
```

Expand All @@ -100,7 +100,7 @@ $ yarn compile
`postdfm` uses Jest to run and report coverage of all tests in the project. Run:

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn test
```

Expand All @@ -109,7 +109,7 @@ $ yarn test
Besides the README.md files for each project, `postdfm` uses TypeDoc to produce basic API documentation (viewable online at http://spiltcoffee.com).

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn docs
```

Expand All @@ -118,7 +118,7 @@ $ yarn docs
The release step is performed automatically by the CI. You can run the command, but it won't do anything.

```bash
~/postdfm (master)
~/postdfm (main)
$ yarn release
```

Expand All @@ -135,7 +135,7 @@ When making a commit, your code in the commit will be automatically linted, form
You should try to fix whatever problems are occurring, but if you can't (like you're trying to add failing tests), please commit using the following:

```bash
~/postdfm (master)
~/postdfm (main)
$ git commit --no-verify
```

Expand Down
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
>
> Inspired by the excellent PostCSS tool, motivated by my rage at the Delphi IDE.
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=package.json)

## Table of Contents
Expand All @@ -18,12 +18,14 @@

## Packages

| Package | Version |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
| [`postdfm`](/packages/postdfm) | [![npm](https://img.shields.io/npm/v/postdfm.svg?label=npm)](https://www.npmjs.com/package/postdfm) |
| [`@postdfm/ast`](/packages/@postdfm/ast) | [![npm](https://img.shields.io/npm/v/@postdfm/ast.svg?label=npm)](https://www.npmjs.com/package/@postdfm/ast) |
| [`@postdfm/ast2dfm`](/packages/@postdfm/ast2dfm) | [![npm](https://img.shields.io/npm/v/@postdfm/ast2dfm.svg?label=npm)](https://www.npmjs.com/package/@postdfm/ast2dfm) |
| [`@postdfm/dfm2ast`](/packages/@postdfm/dfm2ast) | [![npm](https://img.shields.io/npm/v/@postdfm/dfm2ast.svg?label=npm)](https://www.npmjs.com/package/@postdfm/dfm2ast) |
| Package | Version |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| [`postdfm`](/packages/postdfm) | [![npm](https://img.shields.io/npm/v/postdfm.svg?label=npm)](https://www.npmjs.com/package/postdfm) |
| [`@postdfm/ast`](/packages/@postdfm/ast) | [![npm](https://img.shields.io/npm/v/@postdfm/ast.svg?label=npm)](https://www.npmjs.com/package/@postdfm/ast) |
| [`@postdfm/ast2dfm`](/packages/@postdfm/ast2dfm) | [![npm](https://img.shields.io/npm/v/@postdfm/ast2dfm.svg?label=npm)](https://www.npmjs.com/package/@postdfm/ast2dfm) |
| [`@postdfm/dfm2ast`](/packages/@postdfm/dfm2ast) | [![npm](https://img.shields.io/npm/v/@postdfm/dfm2ast.svg?label=npm)](https://www.npmjs.com/package/@postdfm/dfm2ast) |
| [`@postdfm/plugin`](/packages/@postdfm/plugin) | [![npm](https://img.shields.io/npm/v/@postdfm/plugin.svg?label=npm)](https://www.npmjs.com/package/@postdfm/plugin) |
| [`@postdfm/transform`](/packages/@postdfm/transform) | [![npm](https://img.shields.io/npm/v/@postdfm/transform.svg?label=npm)](https://www.npmjs.com/package/@postdfm/transform) |

## Installation

Expand All @@ -50,12 +52,7 @@ const cisDfm = fs.readFileSync(
);

const runner = postdfm({
transformers: [
function (ast) {
//transform and return the ast
return transformedAst;
},
],
transformers: [new Plugin()],
});

const transDfm = runner.processSync(dfm, {
Expand Down
4 changes: 2 additions & 2 deletions packages/@postdfm/ast/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @postdfm/ast

[![npm](https://img.shields.io/npm/v/@postdfm/ast.svg?label=npm)](https://www.npmjs.com/package/@postdfm/ast)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=packages/@postdfm/ast/package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=packages/@postdfm/ast/package.json)

Sub-package for `postdfm`.
Expand Down
4 changes: 2 additions & 2 deletions packages/@postdfm/ast2dfm/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @postdfm/ast2dfm

[![npm](https://img.shields.io/npm/v/@postdfm/ast2dfm.svg?label=npm)](https://www.npmjs.com/package/@postdfm/ast2dfm)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=packages/@postdfm/ast2dfm/package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=packages/@postdfm/ast2dfm/package.json)

Sub-package for `postdfm`.
Expand Down
4 changes: 2 additions & 2 deletions packages/@postdfm/dfm2ast/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @postdfm/dfm2ast

[![npm](https://img.shields.io/npm/v/@postdfm/dfm2ast.svg?label=npm)](https://www.npmjs.com/package/@postdfm/dfm2ast)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=packages/@postdfm/dfm2ast/package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=packages/@postdfm/dfm2ast/package.json)

Sub-package for `postdfm`.
Expand Down
4 changes: 2 additions & 2 deletions packages/@postdfm/plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @postdfm/plugin

[![npm](https://img.shields.io/npm/v/@postdfm/plugin.svg?label=npm)](https://www.npmjs.com/package/@postdfm/plugin)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=packages/@postdfm/plugin/package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=packages/@postdfm/plugin/package.json)

Sub-package for `postdfm`.
Expand Down
4 changes: 2 additions & 2 deletions packages/@postdfm/transform/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @postdfm/transform

[![npm](https://img.shields.io/npm/v/@postdfm/transform.svg?label=npm)](https://www.npmjs.com/package/@postdfm/transform)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=packages/@postdfm/transform/package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=packages/@postdfm/transform/package.json)

Sub-package for `postdfm`.
Expand Down
15 changes: 5 additions & 10 deletions packages/postdfm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
> Inspired by the excellent PostCSS tool, motivated by my rage at the Delphi IDE.
[![npm](https://img.shields.io/npm/v/postdfm.svg?label=npm)](https://www.npmjs.com/package/postdfm)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/master.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/master.svg)](https://codecov.io)
[![CircleCI branch](https://img.shields.io/circleci/project/github/spiltcoffee/postdfm/main.svg)](https://circleci.com)
[![Codecov branch](https://img.shields.io/codecov/c/gh/spiltcoffee/postdfm/main.svg)](https://codecov.io)
[![Known Vulnerabilities](https://snyk.io/test/github/spiltcoffee/postdfm/badge.svg?targetFile=packages/postdfm/package.json)](https://snyk.io/test/github/spiltcoffee/postdfm?targetFile=packages/postdfm/package.json)

## Table of Contents
Expand Down Expand Up @@ -42,12 +42,7 @@ const cisDfm = fs.readFileSync(
);

const runner = postdfm({
transformers: [
function (ast) {
//transform and return the ast
return transformedAst;
},
],
transformers: [new Plugin()],
});

const transDfm = runner.processSync(dfm, {
Expand Down Expand Up @@ -85,7 +80,7 @@ Process a file through the runner synchronously.

Options to pass to an instance of `Runner`.

#### `options.transformers: Transformer[]`
#### `options.plugins: Plugin[]`

Array of transformations to perform on AST.

Expand Down Expand Up @@ -135,7 +130,7 @@ You can find the generated `typedoc` documentation [here](https://spiltcoffee.co

Bug reports and feature requests are greatly appreciated, as are pull requests.

Please see the [Contributing Guide](https://github.com/spiltcoffee/postdfm/blob/master/.github/CONTRIBUTING.md) for instructions on how to contribute to this project.
Please see the [Contributing Guide](https://github.com/spiltcoffee/postdfm/blob/main/.github/CONTRIBUTING.md) for instructions on how to contribute to this project.

## License

Expand Down

0 comments on commit a7e8dba

Please sign in to comment.