Mural design system status display and messaging package

This package, when installed as a dependency, displays a status alert message in the terminal whenever the parent package is installed. For example, this can be used to alert a developer that your package is in a prototype state and is not production-ready.

Table of Contents

1. Installation
2. Usage
3. Testing

Installation

To install the package as a dev dependency within your component package please refer to our global guide on adding a new dependency.

Usage

To configure and call the script that will generate and display the status message, you will need to make the following changes to the package.json of the consuming package:

1. Add a packageConfig object:

   "packageConfig": {
       "status": {
           "warningLevel": "prototype",
           "features": [
               "feature 1",
               "feature 2",
               "feature 3"
           ]
       }
   },

2. Add a postinstall script to call the actual Node script which will output your status message:

   "postinstall": "node ./node_modules/@muraldevkit/ds-package-status/lib"

Testing

Jest unit tests can be run within the package directory using:

npm run test

Test files are located in the tests directory and new files should follow the naming convention <scriptToTest>.spec.ts.