@sparkpost/report-builder

This repo exports some components for report builder.

Installation

Install @sparkpost/report-builder with npm

  npm install -S @sparkpost/report-builder

Developing locally

To develop this lib locally and test importing as a "normal" dependency, you will need to link it. So, you can run npm run watch and link dist folder in npm:

$ cp ./package.json ./dist/package.json
$ cd dist
$ npm link

After that, you need go to the project that you want to test and run

$ npm link @sparkpost/report-builder

Then, @sparkpost/report-builder will be available as a normal imported dependency, but you can develop locally and see the changes in real time.

If you need to develop locally and use a React component of lib, React has some issues with npm link. To fix this, you will need to create a npm link to React from node_modules folder that uses your lib.

Go to node_modules/react of your project that will use @sparkpost/report-builder.

$ npm link

Go to dist folder that you npm linked in previous step and run

$ npm link react

This process will fix React issues on local development.

If you experiencing some styled-components issues, you'll need to link React too.

Go to node_modules/styled-components of your project that will use @sparkpost/report-builder and run:

$ npm link
$ npm link react

And back then to @sparkpost/report-builder dist folder and run

$ npm link styled-components

This process is to link the project's React with lib's React and styled-components' React, ensuring the use of same React export across node_modules. This is only necessary for local development testing.

Build

npm run build

Committing

In order to generate news tags automatically, you need to commit your changes using the Conventional Commits.

Your commit message has to be in the following format:

type(scope): your message

type: Must be one of the allowed types from conventional commits.
scope(optional): Must consist of a noun describing a section of the codebase surrounded by parenthesis.
your message: A short summary of the code changes.

Breaking Changes

You have 2 ways to commit a breaking change:

1. Adding a BREAKING CHANGE footer in your commit message. E.g,

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

2. Adding ! after type in your commit message. E.g,

feat!: send an email to the customer when a product is shipped

Publishing steps

The version of the release will be based on the types of commit messages. Full docs here.

Publishing a production release

After merge your branch into branch main, a new production release will be published automatically.

You can find the latest version of the release in the Releases Page.

Publishing a beta release

To publish a new beta release, merge you code into branch beta, and new beta release will be published automatically.

You can also find beta releases in Releases Page.