Skip to content

Latest commit

 

History

History
111 lines (84 loc) · 6.67 KB

README.md

File metadata and controls

111 lines (84 loc) · 6.67 KB

@ivuorinen/base-configs

license MIT ivuorinen's Code Style

A collection of base configs for code quality and linting tools. Heavily based on @demartini/base-configs

Table of Contents

About

This Monorepo provides a collection of shareable configurations for building, linting, testing, formatting, and releasing tools to make configurations consistent across projects and provide an easy configuration mechanism.

Usage

Check the README of each package in the packages directory for specific usage instructions.

Meta package

All of the linting rules can be installed by running the following command:

npm i -D @ivuorinen/base-configs
Package Version
@ivuorinen/base-configs @ivuorinen/base-configs

You can find the meta package in packages/base-configs.

Available Configurations

Tool Package Version
Browserslist @ivuorinen/browserslist-config @ivuorinen/browserslist-config
CommitLint @ivuorinen/commitlint-config @ivuorinen/commitlint-config
ESLint @ivuorinen/eslint-config @ivuorinen/eslint-config
MarkdownLint @ivuorinen/markdownlint-config @ivuorinen/markdownlint-config
Prettier @ivuorinen/prettier-config @ivuorinen/prettier-config
semantic-release @ivuorinen/semantic-release-config @ivuorinen/semantic-release-config
stylelint @ivuorinen/stylelint-config @ivuorinen/stylelint-config

Badge

Show the world that you are using ivuorinen's code style in your project by including the badge in your readme.

ivuorinen's Code Style

[![ivuorinen's Code Style](https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square)](https://github.com/ivuorinen/base-configs)

Contributing

If you are interested in helping contribute, please take a look at our contribution guidelines and open an issue or pull request.

Changelog

See CHANGELOG for a human-readable history of changes in each package own folder.

License

Distributed under the MIT License. See LICENSE for more information.