Introduction

Shared TypeScript modules, required by both P4 and the P4 Exernal Modules library

Getting Started

Installation: npm i @illustra/p4exlib

2. Software dependencies
3. Latest releases
4. API references

Build and Test

Project based on the following article: https://itnext.io/step-by-step-building-and-publishing-an-npm-typescript-package-44fe7164964c

• npm run lint

• npm run format

• npm run test - runs jest tests

• npm run prepare - prepare will run both BEFORE the package is packed and published, and on local npm install. Perfect for running building the code

• npm run preversion - runs before bumping a new package version. To be extra sure that we’re not bumping a version with bad code, why not run lint here as well?

• npm run version - will run after a new version has been bumped. If your package has a git repository, like in our case, a commit and a new version-tag will be made every time you bump a new version. This command will run BEFORE the commit is made. One idea is to run the formatter here and so no ugly code will pass into the new version:

• npm run postversion will run after the commit has been made. A perfect place for pushing the commit as well as the tag.

• npm run publish --access restricted - publish to npm

Contribute

TODO: Explain how other users and developers can contribute to make your code better.

If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:

• ASP.NET Core
• Visual Studio Code
• Chakra Core