Skip to content
This repository has been archived by the owner on Aug 23, 2021. It is now read-only.

makenowjust/mkdo

Repository files navigation

mkdo

mkdo - Markdown task runner

Build Status NPM version

Table of Contents:

Installation

NPM:

$ npm install -D mkdo

Yarn:

$ yarn add --dev mkdo

Tasks

build

Compiles TypeScript files into JavaScript.

$ tsc -p .

format

Runs linter to files.

$ prettier-package-json --write
$ prettier --write readme.md '{bin,src}/**/*.ts'

check

Fixes format error as possible.

$ prettier-package-json --list-different
$ prettier --list-different readmd.md '{bin,src}/**/*.ts'

ci

Tasks for running on CI.

$ yarn build
$ yarn format:check
$ yarn mkdo sync-scripts --mkdo 'ts-node ./bin/mkdo.ts' --check

TODO

  • write better document.
  • add tests.
  • add more executors.
    • javascript
    • typescript
    • python
    • ruby
    • and more...

License

MIT

(C) 2019 TSUYUSATO Kitsune