fe-core/README.md

Frontend Libs Monorepo

• NPM >7 (Workspaces)

• Lerna

• CommitLint

• Prettier

• ESLint

Installation

1. Add .npmrc file into your project root directory

   @rbkmoney:registry=https://npm.pkg.github.com/
   

2. Authenticate to GitHub Packages

3. Install

   npm i '@rbkmoney/<PACKAGE_NAME>'
   

Contributing

Installation

npx lerna bootstrap

Deps management

• Add

  lerna add <package>[@version] [--dev] [--exact] [--peer]
  

Versioning & GIT Commits

ConventionalCommits

• fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
• feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
• BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
• types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
• footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.

Development

Linking to the project that needs

npm link '<PATH>/fe-core/packages/<PACKAGE_DIR>'

# Example:
# npm link '../fe-core/packages/utils'

Publish

is now performed automatically on CI

1. Bump prerelease every time you push

   npm run versionup
   

2. Bump release & publish before merge into master

   npm run release-versionup
   npm run release-publish