mirror of
https://github.com/ivuorinen/base-configs.git
synced 2026-01-26 03:03:59 +00:00
chore: finalize meta-package state after monorepo split
This commit is contained in:
51
README.md
51
README.md
@@ -1,12 +1,17 @@
|
||||
# @ivuorinen/base-configs <!-- omit in toc -->
|
||||
|
||||
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
|
||||
|
||||
This is a meta package for all my base configs.
|
||||
|
||||
The main reason for this package is to make it easier to use these configs in other projects, and to update them all at once. No more pull requests to update all the configs one at a time!
|
||||
|
||||
[![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
|
||||
|
||||
> A collection of base configs for code quality and linting tools. Heavily based on `@demartini/base-configs`
|
||||
|
||||
## Table of Contents <!-- omit in toc -->
|
||||
|
||||
- [About](#about)
|
||||
- [Usage](#usage)
|
||||
- [Available Configurations](#available-configurations)
|
||||
- [Badge](#badge)
|
||||
@@ -14,28 +19,16 @@
|
||||
- [Changelog](#changelog)
|
||||
- [License](#license)
|
||||
|
||||
## 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`][packages-link] directory for specific usage instructions.
|
||||
|
||||
## Meta package
|
||||
|
||||
All of the linting rules can be installed by running the following command:
|
||||
|
||||
```bash
|
||||
npm i -D @ivuorinen/base-configs
|
||||
# npm
|
||||
npm install @ivuorinen/base-configs --save-dev
|
||||
|
||||
# yarn
|
||||
yarn add @ivuorinen/base-configs --dev
|
||||
```
|
||||
|
||||
| Package | Version |
|
||||
| ----------------------------------- | ------- |
|
||||
| [@ivuorinen/base-configs][meta-npm] | [![@ivuorinen/base-configs][meta-badge]][meta-npm] |
|
||||
|
||||
You can find the meta package in [packages/base-configs](./packages/base-configs).
|
||||
|
||||
## Available Configurations
|
||||
|
||||
| Tool | Package | Version |
|
||||
@@ -48,13 +41,13 @@ You can find the meta package in [packages/base-configs](./packages/base-configs
|
||||
| [semantic-release][semantic-release-link] | [@ivuorinen/semantic-release-config][pkg-src] | [![@ivuorinen/semantic-release-config][semantic-release-badge]][semantic-release-npm] |
|
||||
| [stylelint][stylelint-link] | [@ivuorinen/stylelint-config][pkg-stylelint] | [![@ivuorinen/stylelint-config][stylelint-badge]][stylelint-npm] |
|
||||
|
||||
[pkg-browserlist]: ./packages/browserslist-config
|
||||
[pkg-commitlint]: ./packages/commitlint-config
|
||||
[pkg-eslint]: ./packages/eslint-config
|
||||
[pkg-markdownlint]: ./packages/markdownlint-config
|
||||
[pkg-prettier]: ./packages/prettier-config
|
||||
[pkg-src]: ./packages/semantic-release-config
|
||||
[pkg-stylelint]: ./packages/stylelint-config
|
||||
[pkg-browserlist]: https://www.npmjs.com/package/@ivuorinen/browserlist-config
|
||||
[pkg-commitlint]: https://www.npmjs.com/package/@ivuorinen/commitlint-config
|
||||
[pkg-eslint]: https://www.npmjs.com/package/@ivuorinen/eslint-config
|
||||
[pkg-markdownlint]: https://www.npmjs.com/package/@ivuorinen/markdownlint-config
|
||||
[pkg-prettier]: https://www.npmjs.com/package/@ivuorinen/prettier-config
|
||||
[pkg-src]: https://www.npmjs.com/package/@ivuorinen/semantic-release-config
|
||||
[pkg-stylelint]: https://www.npmjs.com/package/@ivuorinen/stylelint-config
|
||||
|
||||
## Badge
|
||||
|
||||
@@ -72,20 +65,18 @@ If you are interested in helping contribute, please take a look at our [contribu
|
||||
|
||||
## Changelog
|
||||
|
||||
See CHANGELOG for a human-readable history of changes in each package own folder.
|
||||
See [CHANGELOG][changelog-link] for a human-readable history of changes.
|
||||
|
||||
## License
|
||||
|
||||
Distributed under the MIT License. See [LICENSE][license-link] for more information.
|
||||
|
||||
[changelog-link]: ./CHANGELOG.md
|
||||
[contributing-link]: https://github.com/ivuorinen/.github/blob/main/CONTRIBUTING.md
|
||||
[issue-link]: https://github.com/ivuorinen/base-configs/issues
|
||||
[license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
|
||||
[license-link]: ./LICENSE
|
||||
[packages-link]: ./packages
|
||||
[pull-request-link]: https://github.com/ivuorinen/base-configs/pulls
|
||||
[meta-badge]: https://img.shields.io/npm/v/@ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
|
||||
[meta-npm]: https://www.npmjs.com/package/@ivuorinen/base-configs
|
||||
[style-badge]: https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square
|
||||
[style-link]: https://github.com/ivuorinen/base-configs
|
||||
[browserslist-badge]: https://img.shields.io/npm/v/@ivuorinen/browserslist-config?style=flat-square&labelColor=292a44&color=663399
|
||||
@@ -109,3 +100,5 @@ Distributed under the MIT License. See [LICENSE][license-link] for more informat
|
||||
[stylelint-badge]: https://img.shields.io/npm/v/@ivuorinen/stylelint-config?style=flat-square&labelColor=292a44&color=663399
|
||||
[stylelint-link]: https://github.com/stylelint/stylelint
|
||||
[stylelint-npm]: https://www.npmjs.com/package/@ivuorinen/stylelint-config
|
||||
[npm-badge]: https://img.shields.io/npm/v/@ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
|
||||
[npm-link]: https://www.npmjs.com/package/@ivuorinen/base-configs
|
||||
|
||||
Reference in New Issue
Block a user