dependencies.md

Dependencies

This guide describes the dependencies of this repository and their purpose.

Table of Contents

• Table of Contents
• Peer Dependencies
• Development Dependencies
  • babel
  • commitlint
  • ESLint
  • Husky
  • Jest
  • Rollup
  • semantic-release

Peer Dependencies

Peer dependencies are package dependencies that the library depends on but are not included as part of the library's final production bundle.

Usually peer dependencies are packages that would-be users would already have or need as part of their own applications, and hence, no need to include them as part of the library code.

RxJS

RxJS Packages

• rxjs: RxJS core package

Development Dependencies

Development dependencies are package dependencies used while developing library code but are not part of the library's final production bundle.

Babel

Babel is a compiler that allows developers to use new JavaScript features that are not yet available in all browsers.

Babel Packages

• @babel/core: Compiler core package
• @babel/preset-env: Pre-set of JavaScript features babel should compile

Commitlint

commitlint checks commit messages to make sure they follow commit message guidelines.

Commitlint Packages

• @commitlint/cli: commitlint core package
• @commitlint/config-conventional: commitlint enforcer of conventional commit guidelines

ESLint

ESLint is a static analysis tool that enforces code styles and patterns.

ESLint Packages

• eslint: ESLint core package
• eslint-config-airbnb-base: Airbnb's JavaScript style guide configurations
• eslint-plugin-import: Plugin that enforces import/export styles
• eslint-plugin-jest: Plugin that enforces standard Jest styles
• eslint-plugin-jsdoc: Plugin that enforces standard JSDoc styles

Husky

Husky simplifies running scripts in Git hooks.

Husky Packages

• husky - Husky core package

Jest

Jest is a testing framework and runner. Used for unit tests.

Jest Packages

• jest: Jest core package
• jest-junit: Plugin that allows for JUnit-style reporting

Rollup

Rollup is a JavaScript module bundler.

Rollup Packages

• rollup: Rollup core package
• rollup-plugin-terser: Plugin to create minified bundles

Semantic Release

semantic-release automates the versioning and release process. semantic-release using semantic versioning to find the next version. It also takes care of updating all packages, pushing back to Git and publishing to NPM.

Semantic Release Packages

• semantic-release: semantic-release core package
• @semantic-release/changelog: Plugin to generate the changelog
• @semantic-release/git: Plugin to commit release assets into a Git repository