@tigerconnect/web-component-library

Web Component Library

Development Setup

1. npm ci to install dependencies
2. npm run storybook for development
3. npm run build to compile the library to update it in external projects that have it installed locally
4. npm run deploy to build and publish the library to NPM. See Publishing for more details.

Using the library in a project locally

1. In the project folder, run npm install <location of web-component-library>
2. Update your webpack/craco config alias to use

   react: path.resolve('./node_modules/react')
   

   to ensure that the library uses the project's React path, and not its own.

You'll want to leave the updated package's local route in package.json out of your commits, as this will break deployments to other environments.

Publishing

1. Bump the package.json version higher than what is currently published, follow proper semantic versioning, and document the changes in CHANGELOG.md.
2. Run npm run deploy. The command will run npm run build and then npm publish.
3. Update any repo using this package to have the newly published version and reinstall respectively.

VSCode Setup

This project uses PostCSS, which will require a few things so that your CSS files will be understood and formatted auto-correctly:

1. Install https://marketplace.visualstudio.com/items?itemName=csstools.postcss

2. Include in your VSCode editor settings:

   "editor.codeActionsOnSave": {
      "source.fixAll.stylelint": true
   }