topcoder-react-utils

Topcoder React Utils

The Topcoder collection of generic ReactJS configurations, components and utilities to be shared between all internal and external ReactJS projects developed by the Topcoder community.

Content

• Installation
• Reference
  • Configurations
  • Components
  • NodeJS Scripts
  • Redux Templates
  • Utilities
• Development
  • Local Testing of Library Updates within a Host Project
  • Library Releases to NPM
• License

Installation

Install the package as

$ npm install --save topcoder-react-utils
$ ./node_modules/.bin/topcoder-lib-setup

Then import the global stylesheet into the root ReactJS component of your app:

/* eslint-disable global-require */
if (process.env.NODE_ENV === 'production') {
  require('topcoder-react-utils/dist/prod/style.css');
} else {
  require('topcoder-react-utils/dist/dev/style.css');
}
/* eslint-enable global-require */

To upgrade this library to the latest version just execute again

$ ./node_modules/.bin/topcoder-lib-setup

Reference

Configurations

• Babel Configurations – Standard configurations for Babel;
• ESLint Configurations – Standard configurations for ESLint;
• Jest Configurations – Standard configurations for Jest;
• Stylelint Configurations – Standard configurations for Stylelint
• Webpack Configurations – Standard configurations for Webpack.

Components

• Avatar – The standard component for user avatars;
• Button – Handles buttons and button-like links (components that look like regular buttons, but behave as links) in the same uniform manner;
• Link and NavLink – Auxiliary wrappers around React Router's <Link> and <NavLink> components; they help to handle external and internal links in the same uniform manner;
• Modal – Themeable modal component;
• ScalableRect – Container that keeps the specified aspect ratio regardless the width you set.

NodeJS Scripts

• topcoder-lib-setup – Helps to install and upgrade topcoder-react-utils and other similar libraries.

Redux Templates

• Item – An async piece of data in Redux store.

Utilities

• Client – Client-side initialization code.
• Config – Isomorphic app config;
• Global Styles – Global styles necessary for a generic application;
• Isomorphy – Collection of helpers to deal with isomorphic aspects of the code;
• Jest utils – Collection of helpers to be used in Jest tests code;
• Redux utils – TO BE DOCUMENTED
• SCSS Mixins – Collection of useful style mixins;
• Server – Easy creation and launch of web-server with standard configuration, that serves a ReactJS application with or without server-side rendering, supports development tools (Hop Module Reloading), and can be further configured for the needs of specific projects.
• Webpack – Various utils related to the Webpack bundling process.

Development

Whenever you are to do any changes in the library, keep in mind the following:

• Different projects rely on this library, the tooling it provides should be as generic and flexible as possible. When you change existing components, do your best to keep backward compatibility of the updated components, any changes that demand updates in the projects relying on the library, must be documented in the changelog.

• Rely on unit tests to verify your changes, and prevent regression. Update existing unit tests to keep up with your changes, and add new unit tests when necessary.

• For the final testing of your updates within a host project relying on this lib, see the next section.

• The library use semantic versioning. In case your changes demand any changes in the project relying on the library, you should release it as a minor library update (more severe comparing to patch update). Consider to use a new branch, called after the minor version, and to not merge your changes into the main develop / master branches until everybody is prepared for that.

Local Testing of Library Updates within a Host Project

To locally test how your library updates work within a host project relying on the lib (without releasing them to NPM), use npm link to link local copy of the lib into the host project, then run npm run build:dev:watch in the library root to automatically re-build the lib when you change it, and use the host project to see the final effect of changes you make.

Library Releases to NPM

Continious Integration and Delivery (CI/CD) is set up for this repository with CircleCI 2.0. Commits to all branches trigger testing of the code with $ npm test (it runs linters and unit tests), and also build the library. CI/CD flow is interrupted in case of any problems.

To release updated library version to NPM do the following:

• Bump library version in package.json and package-lock.json by $ npm version UPDATE_TYPE --no-git-tag command, where UPDATE_TYPE should be one of patch / minor / major to update current version x.y.z to x.y.(z+1) / x.(y+1).0 / (x+1).0.0. The --no-git-tag flag prevents automatic creation of the Git tag with the same name as the version.

• Tag the commit to be released with the git tag like v0.1.2, where 0.1.2 is the new version set in the previous step.

• Commit the tag to GitHub repository.

License

Topcoder React Utils is MIT Licensed