frontend-components

Monorepo of Red Hat Cloud services Components for applications in a React.js environment.

Packages

utils - library that has utilities functions
charts - small group of general charts
components - series of common components
notifications - common component to display toast notifications
remediations - hot loaded component that shows remediations buton and wizard
inventory - hot loaded inventory component (table and detail)
- inventory-general-info - directly imported component with redux store to show system information
- inventory-vulnerabilities - directly imported component with redux store to show vulnerability data
- inventory-compliance - directly imported component with graphql to show compliance data
- inventory-insights - directly imported component to show insights data
sources - Sources Wizard component was moved to Sources UI repository (it's also stored here in sources_backup branch)

Generating docs and dev run

First you have to generate MD files from /packages/components folder (it takes every JS file and generated MD files from JSDOCs) by running npm run generate:components:docs.

To run docs server locally simply run npm run docs in root directory.

Adding an example

Add new JS file to /packages/docs/examples/<component name>/<example-name>.js. The component name must be the same as the component MD file.

Treeshaking PF with babel plugin

Patternfly packages require some ehancements to be done in order to properly treeshake your bundles. You can either use direct imports or plugin that does that for you, there are actually 2 plugins to do this

babel-plugin-import - easy setup, however not that extensible
babel-plugin-transform-imports - harder to setup, but allows custom rules

Since Patternfly requires a bit of custom settings you should use babel-plugin-transform-imports. Change your babel to be JS file babel.config.js and add these changes to it

// This is required because of how PF is using their css modules.
// This `extensions` will be removed in future, we'll have to come up with some other clever way of doing this
require.extensions['.css'] = () => undefined;
const path = require('path');
const glob = require('glob');

// list of custom named exports, this is just a few, and you should probably update it to fit your project
const mapper = {
  TextVariants: 'Text',
  DropdownPosition: 'dropdownConstants',
  EmptyStateVariant: 'EmptyState',
  TextListItemVariants: 'TextListItem',
  TextListVariants: 'TextList'
};

module.exports = {
    presets: [
        // list of your presets goes here
    ],
    plugins: [
        // your other plugins
        [
            'transform-imports',
            {
              '@patternfly/react-core': {
                transform: (importName) => {
                  const files = glob.sync(
                    path.resolve(
                      __dirname,
                      // you can use `js` or `esm`
                      `./node_modules/@patternfly/react-core/dist/js/**/${mapper[
                      importName
                      ] || importName}.js`
                    )
                  );
                  if (files.length > 0) {
                    return files[0].replace(/.*(?=@patternfly)/, '');
                  } else {
                    throw `File with importName ${importName} does not exist`;
                  }
                },
                preventFullImport: false,
                skipDefaultConversion: true
              }
            },
            'react-core'
          ],
          [
            'transform-imports',
            {
              '@patternfly/react-icons': {
                transform: (importName) =>
                  // you can use `js` or `esm`
                  `@patternfly/react-icons/dist/js/icons/${importName
                  .split(/(?=[A-Z])/)
                  .join('-')
                  .toLowerCase()}`,
                preventFullImport: true
              }
            },
            'react-icons'
          
    ]
}

Jest error

If you see Jest errors after applying transform-imports plugin you should add to your Jest config

"transformIgnorePatterns": [ "/node_modules/(?!@redhat-cloud-services)" ],

Local tasks

Since this is monorepo repository it has some special requirements how to run tasks. This repository is using lerna, so if you have newer version of npm you can run npx lerna $TASK where $TASK is one of lerna commands.

These tasks are preconfigured

npm start - will perform start in all packages, you can change the scope by calling npm start -- --scope=pckg_name to run start in pckg_name
npm run build - will perform build in all packages, you can change the scope by calling npm start -- --scope=pckg_name to run start in pckg_name
npm run clean - to remove all node modules in root and in packages folder
npm run bootstrap - to install packages correctly (will link local dependencies as well)
npm run test - to run tests locally
npm run watch - similiar to start, but will emit files to disk (good for local links)
npm run playground - to launch local demo on port 8080

Running locally

There are two ways to test changes from packages in this repository in other applications: Using npm link or yalc.

Using `npm link`

Run npm install in the root of the frontend-components working copy
Remove react and react-dom from node_modules

rm -rf node_modules/react; rm -rf node_modules/react-dom

This is because we want to use hooks and different reacts are not playing nicely with hooks facebook/react/issues/15315

Link react and react-dom from your application. Running from folder that contains your application and frontend components. Running ls in this folder would yield <application-folder> insights-proxy frontend-components

ln -s $PWD/<application-folder>/node_modules/react frontend-components/node_modules/react
ln -s $PWD/<application-folder>/node_modules/react-dom frontend-components/node_modules/react-dom

Change into the directory of the package you are working on, for example cd packages/components and run npm link*
Change into the directory of the application you'd like to include the package and run npm link @redhat-cloud-services/frontend-components*

After these steps the package you want to test should be linked and the last npm link command should have returned the paths it linked the package from.

When linked successfully you can build the package(s) by running either npm start -- --scope=@redhat-cloud-services/frontend-components or npm run build -- --scope=@redhat-cloud-services/frontend-components in the frontend-components working copy.

Both will build the @redhat-cloud-services/frontend-components package, to build all packages run these commands without -- --scope=@redhat-cloud-services/frontend-components.*

Once the packages are built the application the package is linked in should also be able to build and include any changes made locally in the frontend-components packages.

* Depending on what package you are working on this arguments need to change accordingly.

Using `yalc`

yalc acts as very simple local repository for your locally developed packages that you want to share across your local environment.

Install yalc globally. e.g. npm install -g yalc.
Run npm install in the root of the frontend-components working copy.
Change into the directory of the package you are working on, for example cd packages/components and run yalc publish*
Change into the directory of the application you'd like to include the package and run yalc add @redhat-cloud-services/frontend-components*

After these steps the package you want to test should be linked and the yalc add command should have returned the paths it linked the package from.

When added successfully you can build the package(s) by running npm run build -- --scope=@redhat-cloud-services/frontend-components in the frontend-components working copy and pushing by going into the directory of the package and running yalc push.

yalc does not watch the files, but if you would like to do this automatically you can build the package(s) by running: npm start -- --scope=@redhat-cloud-services/frontend-components and having a separate terminal that does the local publishing of the packages by running: watch -n 0.5 yalc publish --push --changed. This will publish the package only when there are changes.

To build all packages run these commands without -- --scope=@redhat-cloud-services/frontend-components.*

Once the packages are built the application the package is linked in should also be able to build and include any changes made locally in the frontend-components packages.

To remove the package info from package.json and yalc.lock, run yalc remove @redhat-cloud-services/frontend-components to remove a single package; or yalc remove --all to remove all packages from a project.

* Depending on what package you are working on this arguments need to change accordingly.

Creating new package

If none package suits scope of new changes, we need to create new package by creating folder inside packages and running npm init in it.

Run release

Webhooks are enabled to trigger releases on travis from comment on merged PR. If you are member of group responsible for releases you can add new commnent to merged PR Release minor, Release bugfix or Release in order to trigger new release.

You can also draft a release by adding label release or release minor and once this PR is merged new release will be triggered.

quarckster / frontend-components Goto Github PK