PI Components

Component library to share custom components between frontend projects.

Install as dependency in your project

npm install @rentouch/pi-components

Updating this package in registry

Before publishing the new version you can install your updated package locally first to try it out. Let’s imagine following folder structure:

├── pi-web
├── pi-components

You can install the pi-components npm package from a folder like this:

# while being inside pi-web folder
npm install ../pi-components --install-links

When you made significant changes and you want to update your package in registry do the following:

1. Checkout your feature branch from master.

2. Commit your changes to your feature branch:

   git commit -m "Your changes"

3. Specify new version (semver) with:

   npm version <newversion> -m "Bump version to X.Y.Z"

4. Push automatically created tag while being on your feature branch:

   git push --follow-tags

5. Create a PR from your feature branch against the master branch.

6. Assign PR for review, after a successful merge to master, the CI will build and push the package to the npm repository.

Semantic Versioning

When deciding which version to use consider following:

| Code status | Stage | Rule | Example version | |:------------------------------------------|:--------------|:-------------------------------------------------------------------|:---------------:| | First release | New product | Start with 1.0.0 | 1.0.0 | | Backward compatible bug fixes | Patch release | Increment the third digit | 1.0.1 | | Backward compatible new features | Minor release | Increment the middle digit and reset last digit to zero | 1.1.0 | | Changes that break backward compatibility | Major release | Increment the first digit and reset middle and last digits to zero | 2.0.0 |

You can specify which update types your package can accept from dependencies in your projects's package.json file.

For example, to specify acceptable version ranges up to 1.0.4, use the following syntax:

Patch releases: 1.0 or 1.0.x or ~1.0.4
Minor releases: 1 or 1.x or ^1.0.4
Major releases: * or x

Testing

Run tests with:

npm run test

Styleguide

Start with:

npm run styleguide

which will host components on http://localhost:6060.