@contentful/integration-frontend-toolkit

integration-frontend-toolkit

Warning This library is under active development and is subject to significant changes. At any time code may be updated, depricated, or entirely removed based on our internal development of the Apps repo.

This repository is a home to frontend tooling, primarily used to support integration (app) development.

The library itself offers the Integrations team a place to develop components outside of the app itself, as well as to house highly repeated code, to support reusability as well as customizability.

Local development

Ensure that your global npmrc has the following, or if you prefer, create a local npmrc in this repository with the same information:

//npm.pkg.github.com/:_authToken=<your token>
@contentful:registry=https://npm.pkg.github.com

This will allow you to successfully install the node_modules.

To install or update the app locally:

npm i

To run storybook locally:

npm run storybook

To run tests:

npm run test

Testing package locally

Option 1: Link the package using the global node module namespace

npm link 

and within the test application run

npm link @contentful/integration-frontend-toolkit

Option 2: Use npm pack to create a tgz file locally that mimics a fully packed library structure

npm build 

npm pack --pack-destination ~

import the packed file, i.e "file:~/contentful-integration-frontend-toolkit-0.0.0-semantic-release.tgz", into another library for testing

and within the testing library run:

npm install 

to actually install the tgz packed file.

You may need to continually update the version in your local package, and repack the tgz file, and reimport it with the new version, when updates are made.

Creating new submodule directories:

The current build of this toolkit creates build directories directly reflecting the directories under the src directory. You will notice upon building the toolkit, that these directories are created, and this supports submodule imports of the toolkit i.e:

import { HyperLink } from "@contentful/integration-frontend-toolkit/components" 
import { sentryMarketplaceAppsSDK } from "@contentful/integration-frontend-toolkit/sdks" 

When creating a new directory, you will need to add the directory name to the package.json "files" section in order for it to be exposed as a submodule.

Expectations of development

1. Each new entity added to this library should be housed in its own directory
2. Each new entity should be accompanied by a spec. file.
3. Each new component created should be accompanied by a stories. file. Keep in mind the various iterations of an entity. Questions to ask: if it might be useful to create a story for each iteration? and if the story is self-explantory to other developers? Sometimes it is useful to add details, actions, decorators to describe the story and component.
4. Each new entity needs to be added to the respective parent directory index.ts file.
5. Directories are lower-cased unless they house a set of files related to a React component
6. File names are lower-cased unless they house a React component

Commiting

Follow standard Semantic Versioning commit messages (when you squash or commit to master) in order to version the package correctly.

Examples commit messages:

• Feat: A new feature, i.e feat(button): Add new button component
• Fix: A bug fix
• Docs: A documentation change
• Style: A change that does not affect meaning of code (styling)
• Refactor: A change that neither fixes a bug nor adds a feature
• Perf: A code change that improves performance
• Test: An adjustment to tests
• Chore: A change to the build process of auxiliary tools and libraries

By default in this library right now, FIX is a patch release, FEATURE is a minor, and the label BREAKING CHANGE is a major release.

In progress improvements and known limitations:

1. Currently it is challenging to create a directory that is just internal to the toolkit itself. For example, if we want to createa a directory that houses a helper function used in other methods across other directories, but do not intend on exposing this directory as part of the library, given how the build works now, we will need to experiment with how to implement this.
2. Currently within the CI, we require Chromatic visual approvals of changes to components.

Other resources

Storybook Chromatic Semantic Release