Skip to content

🛠️ Common configuration files for my projects.

License

Notifications You must be signed in to change notification settings

BetaHuhn/config

Repository files navigation

🛠️ BetaHuhn config files

This repository contains common configuration files for my projects. It is based on Koj's config repo, I only changed the linter to eslint and modified some other things to my preference.

💻 Usage

Install the package as a dev dependency from npm:

npm install --save-dev @betahuhn/config

Eslint

This config includes the ESLint configuration I use in my personal projects. To use this configuration, create an ESLint config file .eslintrc.js in the project root:

module.exports = require("@betahuhn/config").eslint;

Semantic Release

I use Semantic Release for automated deployments of my packages. The configuration adds support for Gitmoji commits, creating release notes with a CHANGELOG.md, and publishing to GitHub and npm.

Create a Semantic Release config file release.config.js in the project root. If you want to release the master or production branches, you can use the import directly:

module.exports = require("@betahuhn/config").master;

Alternately, you can specify the branch you want to release:

module.exports = require("@betahuhn/config").release("branch-name");

Here are all the emojis which trigger a new release:

Major:

  • 💥 = Introduce breaking changes

Minor:

  • ✨ = Introduce new features

Patch:

  • 🐛 = Bug fix
  • 🚑 = Critical hotfix
  • 🔒 = Fix security issues
  • ♻️ = Refactor code
  • 💄 = Add/update the UI and style files
  • 👽 = Update code due to external API changes
  • 📦 = Add/Update compiled files or package

📄 License

MIT © Maximilian Schiller and Koj