@ushurengg/uicomponents v2.3.30

Using the Makefile to run the Bundle / Build commands

Bundle

Bundle command is used for bundling the React components together as javascript, which can be used with BackboneJS project

Usage:

make bundle <buildversion>

Build

Build command is used for the purpose of building the components as an npm package.

Usage:

make build

After this command is run, we need to run the following commands:

1. Update version number: npm version [\<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease --preid=\<prerelease-id> | from-git]

Usage:

npm version patch

The above command will save the package version in package.json as 1.0.2 if the current version in package.json is 1.0.1

Note: While making a release please tag this repo as well with that release number

2. Publish to npm registry: npm publish

Usage:

npm publish

Note: For publish, we need to have our npm token configured in $HOME/.npmrc file. Please get in touch with Devops team for the token

3. Referencing the components in React Projects

   • Update $HOME/.npmrc with correct npm token
   • run the following command to install the package

   npm install @ushurengg/uicomponents

Publishing storybook

1. Build Storybook npm run storybook:build
2. Login to AWS with ushur developer account as Devops
3. Go to S3 bucket storybook2
4. Create a backup of the existing content
5. Upload the content of storybook-static to storybook2 S3 bucket

Snyk Issues

Snyk is a tool that automates finding vulnerabilities in code.

Snyk automatically runs in CI/CD.

If you want to run Snyk locally you can run:

SNYK_TOKEN=<token> npm run snyk

where SNYK_TOKEN is an env variable you can get from here.

If Snyk finds an issue in open source code, evaluate the issue and see if it is worth fixing.

For example, if a particular item involves a difficult upgrade path, consider ignoring it for now and create a JIRA ticket to address it in the future. Note at the time of writing, it is not clear how to provide an unlimited expiry date via the CLI.

snyk ignore --id=SNYK-JS-LOADERUTILS-3042992 --reason="React Scripts upgrade required" --expiry=2025-06-07

Ignored issues are stored in the file .snyk at the root of ushur-ui directory.

Similarly, if Snyk finds an issue in our own repo code, in some cases you can disable the issue if required. For example,

// file deepcode ignore InsufficientPostmessageValidation: This issue is ignored because it will never be triggered. 

Use the right click context button in the VsCode IDE if you have the Snyk extension installed and choose Quick Fix to 'ignore this particular suggestion'.

However, in some cases Snyk will not allow you to ignore the issue if is severe like a XSS issue. We should fix those issues in our code.

Worst case we can ignore a whole file as follows:

snyk ignore --file-path=src/App.tsx

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.\ Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.\ You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.\ It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

npm run bundle

Note:This will make a bundle.js and index.css file in the uicomponents/dist folder

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify