包详细信息

@emdaer/cli

emdaer137MIT3.2.31

emdaer CLI

README

自述文件

@emdaer/cli · Travis Documented with emdaer Maintained with lerna

emdaer CLI

Usage

@emdaer/cli is the emdaer cli – see the emdaer monorepo for more information

Documentation

Adding emdaer to your project

We recommend using emdaer with lint-staged and husky.

Install dependencies:

npm install --save-dev @emdaer/cli @emdaer/plugin-value-from-package lint-staged husky

or with yarn:

yarn add @emdaer/cli @emdaer/plugin-value-from-package lint-staged husky -D

Follow the lint-staged setup instructions.

{
  "scripts": {
+   "emdaer": "emdaer && git add *.md",
+   "precommit": "lint-staged"
  }
}

In your lint-staged config file add an entry for emdaer:

module.exports = {
  '*.js': ['eslint --fix', 'prettier --write', 'git add'],
+ '*.emdaer.md': ['emdaer --yes', 'git add'],
};

NOTE: In the case of a precommit hook (or CI/other automation), we don’t want to be prompted about anything. The --yes flag will automatically answer “yes” to any prompts. For example, it will make emdaer write your READMEs without prompting about overwritting direct changes to a destination README file.

Add a .emdaer/README.emdaer.md file:

md # <!--emdaer-p - '@emdaer/plugin-value-from-package' - value: name -->

And give it a whirl:

npm run emdaer

When you commit your changes, lint-staged will run emdaer on any *.emdaer.md files you may have changed.

Manual Usage

emdaer can be run manually against files by providing space separated file paths:

npm run emdaer -- .emdaer/README.emdaer.md .emdaer/CONTRIBUTING.emdaer.md

If emdaer is not provided a path, the default glob .emdaer/*/.emdaer.md is searched:

npm run emdaer

NOTE: By default, emdaer checks for existing changes to your READMEs before writing. If it detects changes, it will provide a prompt asking if you would like to overwrite the README with the newly generated content. If you accidentally edited the README directly, you will want to answer n to the prompt, move any changes to the respective .emdaer/*.emdaer.md file, and rerun emdaer. If you would like to discard those changes, answer Y to the prompt or use the --yes flag to skip the prompt all together. In both cases, emdaer will overwrite the README with the newly generated content.

更新日志

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.2.31 (2020-04-09)

Note: Version bump only for package @emdaer/cli

3.2.30 (2020-04-09)

Bug Fixes

3.2.29 (2020-04-09)

Note: Version bump only for package @emdaer/cli

3.2.28 (2020-04-09)

Reverts

  • Revert "chore: publish v3.2.27 [ci skip]" (79e2f9d)

Note: Version bump only for package @emdaer/cli

3.2.26 (2019-07-09)

Note: Version bump only for package @emdaer/cli

3.2.25 (2019-07-09)

Note: Version bump only for package @emdaer/cli

3.2.24 (2019-07-08)

Note: Version bump only for package @emdaer/cli

3.2.23 (2019-07-08)

Note: Version bump only for package @emdaer/cli

3.2.22 (2019-07-08)

Note: Version bump only for package @emdaer/cli

3.2.21 (2019-07-08)

Note: Version bump only for package @emdaer/cli

3.2.20 (2019-07-08)

Note: Version bump only for package @emdaer/cli

3.2.19 (2019-07-08)

Note: Version bump only for package @emdaer/cli

3.2.18 (2019-07-06)

Note: Version bump only for package @emdaer/cli

3.2.17 (2019-07-06)

Note: Version bump only for package @emdaer/cli

3.2.16 (2019-07-05)

Note: Version bump only for package @emdaer/cli

3.2.15 (2019-07-05)

Note: Version bump only for package @emdaer/cli

3.2.14 (2019-07-04)

Note: Version bump only for package @emdaer/cli

3.2.13 (2019-07-04)

Note: Version bump only for package @emdaer/cli

3.2.12 (2019-07-03)

Note: Version bump only for package @emdaer/cli

3.2.11 (2019-07-03)

Note: Version bump only for package @emdaer/cli

3.2.10 (2019-07-03)

Note: Version bump only for package @emdaer/cli

3.2.9 (2019-07-03)

Note: Version bump only for package @emdaer/cli

3.2.8 (2019-07-03)

Note: Version bump only for package @emdaer/cli

3.2.7 (2019-07-03)

Note: Version bump only for package @emdaer/cli

3.2.6 (2019-06-19)

Note: Version bump only for package @emdaer/cli

3.2.5 (2019-06-18)

Note: Version bump only for package @emdaer/cli

3.2.4 (2019-01-16)

Note: Version bump only for package @emdaer/cli

3.2.3 (2018-05-25)

Bug Fixes

  • cli: only stamp with relative paths (35ac286)

3.2.2 (2018-05-25)

Bug Fixes

  • cli: remove uneeded yarn.lock file and upgrade chalk (a5e1c11), closes #105

3.2.1 (2018-05-23)

Note: Version bump only for package @emdaer/cli

3.2.0 (2018-05-18)

Features

  • cli: add prompt and --yes flag for overwriting readmes (3b867cf)
  • allow emdaer to take path parameters and document lint-staged usage (d780e3f)
  • simplify cli (1ff54b9), closes #89 #96
  • warn when the destination readme has been edited (4168588)

BREAKING CHANGES

  • @emdaer/cli now prompts the user if a manual change to the compiled README is detected. Use --yes to skip the prompt and automatically overwrite the README
  • cli: defaults to prompt Y/n if a readme has existing changes

3.0.0 (2018-05-11)

Features

  • cli: add prompt and --yes flag for overwriting readmes (3b867cf)
  • allow emdaer to take path parameters and document lint-staged usage (d780e3f)
  • simplify cli (1ff54b9), closes #89 #96
  • warn when the destination readme has been edited (4168588)

BREAKING CHANGES

  • @emdaer/cli now prompts the user if a manual change to the compiled README is detected. Use --yes to skip the prompt and automatically overwrite the README
  • cli: defaults to prompt Y/n if a readme has existing changes

2.4.0 (2018-04-29)

Features

  • plugin-jsdoc-tag-value: add plugin and self document (13130cd)

2.1.1 (2018-04-29)

Note: Version bump only for package @emdaer/cli

2.1.0 (2018-04-29)

Note: Version bump only for package @emdaer/cli

2.0.3 (2018-04-21)

Note: Version bump only for package @emdaer/cli

2.0.2 (2018-04-14)

Note: Version bump only for package @emdaer/cli

2.0.1 (2018-04-14)

Bug Fixes

  • core: override marked to output md. remove minifier (9fb0c27)

2.0.0 (2018-02-21)

Features

  • build: update some lerna things (19e88fd)

BREAKING CHANGES

  • build: woo finally shipping v2!

1.8.15 (2018-02-21)

Note: Version bump only for package @emdaer/cli

1.8.14 (2018-02-21)

Note: Version bump only for package @emdaer/cli

1.8.13 (2018-02-21)

Bug Fixes

  • cli: ensure files write to proper destinations (#73) (f3f2dd3), closes #72

1.8.12 (2018-02-20)

Note: Version bump only for package @emdaer/cli

1.8.11 (2018-02-19)

Note: Version bump only for package @emdaer/cli

1.8.10 (2018-02-19)

Note: Version bump only for package @emdaer/cli

1.8.9 (2018-02-19)

Note: Version bump only for package @emdaer/cli

1.8.8 (2018-02-02)

Note: Version bump only for package @emdaer/cli

1.8.7 (2018-01-15)

Note: Version bump only for package @emdaer/cli

1.8.6 (2018-01-15)

Note: Version bump only for package @emdaer/cli

1.8.5 (2018-01-15)

Note: Version bump only for package @emdaer/cli

1.8.4 (2018-01-01)

Note: Version bump only for package @emdaer/cli

1.8.3 (2018-01-01)

Note: Version bump only for package @emdaer/cli

1.8.2 (2017-12-25)

Bug Fixes

  • cli: ensure files write to proper destinations (#73) (f3f2dd3), closes #72

1.8.1 (2017-12-10)

Note: Version bump only for package @emdaer/cli

1.8.0 (2017-12-10)

Features

  • cli: process multiple files in parallel (#65) (44fc0a9), closes #61

1.7.0 (2017-12-09)

Note: Version bump only for package @emdaer/cli

1.6.20 (2017-12-09)

Note: Version bump only for package @emdaer/cli

1.6.19 (2017-11-27)

Note: Version bump only for package @emdaer/cli

1.6.18 (2017-11-27)

Note: Version bump only for package @emdaer/cli

1.6.17 (2017-11-27)

Note: Version bump only for package @emdaer/cli

1.6.16 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.15 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.14 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.13 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.12 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.11 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.10 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.9 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.8 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.7 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.6 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.5 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.4 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.3 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.2 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.1 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.6.0 (2017-11-17)

Note: Version bump only for package @emdaer/cli

1.5.50 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.49 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.48 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.47 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.46 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.45 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.44 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.43 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.42 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.41 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.40 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.39 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.38 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.37 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.36 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.35 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.34 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.33 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.32 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.31 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.30 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.29 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.28 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.27 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.26 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.25 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.24 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.23 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.22 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.21 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.20 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.19 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.18 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.17 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.16 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.15 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.14 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.13 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.12 (2017-11-12)

Note: Version bump only for package @emdaer/cli

1.5.11 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.10 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.9 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.8 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.7 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.6 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.5 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.4 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.3 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.5.2 (2017-11-11)

Note: Version bump only for package @emdaer/cli

1.4.0 (2017-11-07)

Features

  • cli: add logging of enabled feature flags (48ab2b1)
  • core: add feature flags (e6bb738)

1.2.2 (2017-10-31)

Note: Version bump only for package @emdaer/cli

1.1.0 (2017-10-29)

Features

  • cli: report name of project when writing file (96b1a6b)

1.0.0 (2017-10-29)

Note: Version bump only for package @emdaer/cli