@tigerconnect/web-component-library
Advanced tools
Comparing version 2.1.1-beta.3 to 2.1.1
{ | ||
"name": "@tigerconnect/web-component-library", | ||
"version": "2.1.1-beta.3", | ||
"version": "2.1.1", | ||
"description": "a shared component library for tc projects", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.esm.js", |
@@ -12,21 +12,24 @@ # Web Component Library | ||
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 and Storybook application to GitHub | ||
3. `npm run deploy` to build and publish the library to NPM and Storybook application to GitHub | ||
Pages. See [Publishing](#publishing) for more details. | ||
5. `npm run gen` to create a new component. | ||
4. `npm run gen` to create a new component. | ||
## Using the library in a project locally | ||
There are other methods for developing the project completely locally, however they suffered from caching issues. Instead the recommended approach is to publish a beta version of the project and then `npm install` that into the other repo you are working in (e.g. in `web-react-ui-toolkit`). This means that each time you make changes and want them to be available in the downstream repo, you will need to publish another beta version. | ||
We follow the following convention for publishing a beta version: | ||
1. From inside the `web-component-library` repository | ||
- run `npm run build` to build the latest changes | ||
- then run `npm link`. | ||
- Increment the version field in `package.json` and append `-<initials>.beta.<beta version number>`. E.g. if the current package version is `2.1.0` then the result would be `2.1.1-ms.beta.1` for Mahesh Sundaram's first beta version. | ||
- Run `npm run build` | ||
- Then `npm publish --tag beta` | ||
2. Then inside the repository using the library. e.g. inside `web-react-ui-toolkit` | ||
- run `npm link @tigerconnect/web-component-library`. | ||
- Run `npm install @tigerconnect/web-component-library@<beta version> --save-exact` E.g. `@tigerconnect/web-component-library@2.1.1-ms.beta.1 --save-exact` | ||
- You will then need to restart the watcher process for `web-react-ui-toolkit` | ||
For further changes, only `npm run build` is needed (and sometimes restarting the | ||
`web-react-ui-toolkit` build/watcher, for example) | ||
Once you are satisfied with your changes in `web-component-library` you should checkout the changes you made to `package.json` and first merge your PR as unrelease package changes (see `CHANGELOG.md`). Once your PR is merged, you then can create a subsequent PR that increments the package version and moves the unreleased changes to released in the changelog. Finally in the downstream repo you can update the installed `web-component-library` package version to the latest published version. | ||
@@ -33,0 +36,0 @@ ## Editor Setup |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
201564
1
79