https://github.com/betahuhn/config
🛠️ Common configuration files for my projects.
https://github.com/betahuhn/config
eslint eslint-config semantic-release semantic-release-config
Last synced: 6 months ago
JSON representation
🛠️ Common configuration files for my projects.
- Host: GitHub
- URL: https://github.com/betahuhn/config
- Owner: BetaHuhn
- License: mit
- Created: 2020-12-31T21:24:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-06T16:26:50.000Z (over 3 years ago)
- Last Synced: 2024-11-14T10:15:53.758Z (7 months ago)
- Topics: eslint, eslint-config, semantic-release, semantic-release-config
- Language: TypeScript
- Homepage: https://mxis.ch
- Size: 296 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🛠️ BetaHuhn config files
This repository contains common configuration files for my projects. It is based on [Koj's](https://github.com/koj-co) [config repo](https://github.com/koj-co/config), 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](https://www.npmjs.com/package/@betahuhn/config):
```bash
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:
```js
module.exports = require("@betahuhn/config").eslint;
```
### Semantic Release
I use [Semantic Release](https://github.com/semantic-release/semantic-release) for automated deployments of my packages. The configuration adds support for [Gitmoji](https://gitmoji.carloscuesta.me) 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:
```js
module.exports = require("@betahuhn/config").master;
```
Alternately, you can specify the branch you want to release:
```js
module.exports = require("@betahuhn/config").release("branch-name");
```
Here are all the emojis which trigger a new release:
**Major:**
- :boom: = Introduce breaking changes
**Minor:**
- :sparkles: = Introduce new features
**Patch:**
- :bug: = Bug fix
- :ambulance: = Critical hotfix
- :lock: = Fix security issues
- :recycle: = Refactor code
- :lipstick: = Add/update the UI and style files
- :alien: = Update code due to external API changes
- :package: = Add/Update compiled files or package
## 📄 License
[MIT](./LICENSE) © [Maximilian Schiller](https://github.com/betahuhn) and [Koj](https://koj.co)