https://github.com/raphaelkieling/doctorenv

Checklist tool that helps developers identify environment issues
https://github.com/raphaelkieling/doctorenv

checklist cli doctor environment hacktoberfest issue javascript tool

Last synced: 2 days ago
JSON representation

Checklist tool that helps developers identify environment issues

• Host: GitHub
• URL: https://github.com/raphaelkieling/doctorenv
• Owner: raphaelkieling
• License: mit
• Created: 2023-10-16T00:32:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-22T22:56:28.000Z (about 1 year ago)
• Last Synced: 2024-01-26T22:37:41.419Z (10 months ago)
• Topics: checklist, cli, doctor, environment, hacktoberfest, issue, javascript, tool
• Language: JavaScript
• Homepage:
• Size: 768 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



# Doctorenv

![Known Vulnerabilities](https://snyk.io/test/github/raphaelkieling/doctorenv/badge.svg)

[![codecov](https://codecov.io/gh/raphaelkieling/doctorenv/graph/badge.svg?token=8FUTQY7PA7)](https://codecov.io/gh/raphaelkieling/doctorenv)

[Wiki documentation here](https://github.com/raphaelkieling/doctorenv/wiki)

✅ `Doctorenv` is a checklist tool that helps developers to check if they have everything to contribute in a project.

In the end the goal is `Save time`, nothing more! 🚀

### How to install?

```sh

# Without install

npx doctorenv-cli

# Installing globally using npn

npm i -g doctorenv-cli

# Installing globally using yarn

yarn global add doctorenv-cli

```

> I do not recommend to install locally yet, since you do not have any big reason to do it right now. In the future the idea is to have plugin system, hooks and type checking using `require`, up to you.

### Why?

Sometimes you aren't sure if you have everything to contribute in a project. The `Doctorenv` should give you some help on:

- Check what is missing in your environment to make it works

- Giving you some `Suggestions` on how to fix in case you do not met some requirements

- Easy to start using and change

- Automatic fixers

Example of config:

```js

// doctorenv.config.js

module.exports = ({ builder }) => {

  return builder

    .task('check package manager')

    .subTask('has npm', ({ bash }) => bash`npm --version`)

    .subTask('has yarn', ({ bash }) => bash`yarn --version`)

    .task('has env', ({ checkEnv }) => checkEnv('NODE_ENV'))

    .setFixableSuggestion(

      'Run source ./env.sh',

      ({ bash }) => bash`source ./env.sh`

    )

    .build()

}

```

Run:

```sh

# To check the default doctorenv.config.js

doctorenv check

# To check with a custom config

doctorenv check 

```

![Alt text](image-1.png)

### Changelog

You can check the changelog [here](CHANGELOG.md).

### How to contribute?

It's simple, just take a look at our [Contributing](CONTRIBUTING.md) guide.

### Contributors

  

    

      
Daksh Singh Rathore
🔬 📖

      
harshvyas-22
🎨

      
Raphael Kieling
💻

    

  

### Development

```sh

# testing

npm run test

npm run test:watch

# run a specific example in dev mode

npm run dev check examples/NAME_HERE.config.js

```

### Publishing

```sh

npm run publish

```



Temporary Icon from: Pharmacist icons created by Freepik - Flaticon