This is a package that checks if your Atomic custom components meet all the conditions required in order to be published. It is designed to help you ensure that your component is healthy and easily sharable with other users.

Installation

You can install Health Check using npm:

npm install health-check --save-dev

Usage

Once installed, you can use Health Check by running the bin file (atomic-meta-check) available in the node modules: It is meant to be used as a prepublishOnly script. You can add it to your package.json:

...
"scripts": {
    "prepublishOnly": "npm run build && atomic-meta-check",
},
...
"devDependencies": {
    "@coveo/atomic-component-health-check": "latest",
},
...

Contributing

If you find a bug or have a feature request, please create an issue or submit a pull request.

Keywords

coveo

atomic

FAQs

What is @coveo/atomic-component-health-check?

Is @coveo/atomic-component-health-check popular?

Is @coveo/atomic-component-health-check well maintained?

Package last updated on 13 May 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install