the linter for your enviroment™

Table of Contents

• Introduction
• Install
• Contributing
• Documentation
• License

Introduction

⚠️ This is still very early stage of the project! Use on your onw risk

This is a framework for easy creation of a set of checks to ensure that environment is correctly set up.

It's kind of like ESLint for your environment.

Install

To install the core functionality (envdoctor binary)

yarn add @envdoctor/core -D

or

npm install @envdoctor/core --dev

Packages

Package	Stable
@envdoctor/core
@envdoctor/utils
@envdoctor/envdoctor-config-essentials

Documentation

Documentation could be found at https://productboardlabs.github.io/envdoctor/.

Have you build something awesome? Let's share it with us.

Contributing

There is actually solid test coverage, so you should be safe. You can use example/ folder as playground.

Run:

• yarn run bootstrap for bootstrap
• yarn build:watch for continuous building
• yarn test:watch for tests

Contributors

Also, I'd love to thank these wonderful people for their contribution (emoji key). You rock! 💪

Jakub Beneš 🐛 💻 🎨 📖 🤔	Tomas Ruzicka 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

License

The MIT License (MIT) 2019 productboard