Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

daisy-cli

0.0.16 • Public • Published

Daisy-CLI - CLI to Generate recommended documentation/files to improve contribution

npmversion npmlicense downloads

Do you want people to contribute to your project? Make it easy for your contributors. Generate all the recommended documentation/files (pre-filled) for the Github community standards. This project has 100% type coverage checked by tscov.

Files that can be generated

More files & providers in future versions.

Github

  • License
    • MIT
    • ISC
    • Apache 2.0
    • BSD 2-Clause
    • GPLv3
  • Changelog
  • Contributing
  • Readme
  • Todo
  • Code of Conduct

Github specific

  • Bug report (issue)
  • Feature request (issue)
  • Pull request template
  • All files at once

Useful for every project

  • Existing or new
  • Large or small
  • Every language
  • Github

Quickstart

Install the Daisy CLI as a global CLI.

npm install -g daisy-cli
 
cd <your-repo-location>
 
# Then you run 
daisy-cli

Or just use via npx:

cd <your-repo-location>
 
# Then you run 
npx daisy-cli

This should start the CLI and ask for questions about which files you want to add!

Example

Generate all Github files example:

      _           _                                _   _
   __| |   __ _  (_)  ___   _   _            ___  | | (_)
  / _` |  / _` | | | / __| | | | |  _____   / __| | | | |
 | (_| | | (_| | | | \_| |_| | |_____| | (__  | | | |
  \__,_|  \__,_| |_| |___/  \__, |          \___| |_| |_|
                            |___/
 
Generate all recommended markdown documentation/templates for the Github community standards
? Select a Git hosting provider: Github
? Which files do you want to generate? All main files (without license, todo and readme)
INFO: Start generating all recommended files...
 
GENERATE: CODE_OF_CONDUCT.md...
GENERATE: CONTRIBUTING.md...
GENERATE: bug_report.md...
GENERATE: feature_request.md...
GENERATE: pull_request_template.md...
CREATE: bug_report.md in <path-to-folder>/.github/ISSUE_TEMPLATE/bug_report.md
CREATE: CODE_OF_CONDUCT.md in <path-to-folder>/CODE_OF_CONDUCT.md.md
CREATE: CONTRIBUTING.md in <path-to-folder>/CONTRIBUTING.md
CREATE: feature_request.md in <path-to-folder>/.github/ISSUE_TEMPLATE/feature_request.md
CREATE: pull_request_template.md in <path-to-folder>/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Git provider question:

? Select a Git hosting provider: (Use arrow keys)
❯ Github

Generate file question:

? Which files do you want to generate? (Use arrow keys)
❯ All main files (without license, todo and readme)
  License
  Changelog
  Code of conduct
  Contributing
  Bug report (issue)
  Feature request (issue)
  Pull request template

Generate license example:

? Select a Git hosting provider: Github
? Which files do you want to generate? License
GENERATE: LICENSE...
? Which type of license do you want to generate? MIT License
? Please fill in your Git username: jsonruhls
CREATE: LICENSE in <path-to-folder>/LICENSE

File already exists example:

? Select a Git hosting provider: Github
? Which Github files do you want to generate? Contributing
GENERATE: CONTRIBUTING.md...
? This file already exists. Do you want to overwrite it? Yes
UPDATE: CONTRIBUTING.md in <path-to-folder>/CONTRIBUTING.md

Install

npm i daisy-cli

DownloadsWeekly Downloads

18

Version

0.0.16

License

MIT

Unpacked Size

115 kB

Total Files

37

Last publish

Collaborators

  • avatar