https://github.com/lobehub/lobe-lint
📐 ESlint, Stylelint, Commitlint, Prettier, Remark, Semantic Release config for LobeHub
https://github.com/lobehub/lobe-lint
commitlint eslint lint lobehub prettier remark semantic-release stylelint
Last synced: 6 months ago
JSON representation
📐 ESlint, Stylelint, Commitlint, Prettier, Remark, Semantic Release config for LobeHub
- Host: GitHub
- URL: https://github.com/lobehub/lobe-lint
- Owner: lobehub
- License: mit
- Created: 2023-06-06T07:18:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T15:17:23.000Z (6 months ago)
- Last Synced: 2025-04-06T14:12:18.432Z (6 months ago)
- Topics: commitlint, eslint, lint, lobehub, prettier, remark, semantic-release, stylelint
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@lobehub/lint
- Size: 230 KB
- Stars: 34
- Watchers: 5
- Forks: 19
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Lobe Lint
ESlint config, Prettier config, Remark config for LobeHub
[Changelog](./CHANGELOG.md) · [Report Bug][issues-link] · [Request Feature][issues-link]
[![][npm-release-shield]][npm-release-link]
[![][discord-shield]][discord-link]
[![][npm-downloads-shield]][npm-downloads-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
Table of contents
#### TOC
- [📦 Installation](#-installation)
- [🤯 Usage](#-usage)
- [.npmrc](#npmrc)
- [ESlint](#eslint)
- [Stylelint](#stylelint)
- [Commitlint](#commitlint)
- [Changelog](#changelog)
- [Remark](#remark)
- [Prettier](#prettier)
- [Semantic Release](#semantic-release)
- [⌨️ Local Development](#️-local-development)
- [🤝 Contributing](#-contributing)
####
## 📦 Installation
To install Lobe Lint, run the following command:
[![][bun-shield]][bun-link]
```bash
$ bun add @lobehub/lint -D
```
To use template ignore files, run the following command:
```bash
$ curl -O https://raw.githubusercontent.com/lobehub/lobe-lint/master/.eslintignore
$ curl -O https://raw.githubusercontent.com/lobehub/lobe-lint/master/.gitignore
$ curl -O https://raw.githubusercontent.com/lobehub/lobe-lint/master/.prettierignore
```
[![][back-to-top]](#readme-top)
## 🤯 Usage
### .npmrc
```text
public-hoist-pattern[]=*@umijs/lint*
public-hoist-pattern[]=*changelog*
public-hoist-pattern[]=*commitlint*
public-hoist-pattern[]=*eslint*
public-hoist-pattern[]=*postcss*
public-hoist-pattern[]=*prettier*
public-hoist-pattern[]=*remark*
public-hoist-pattern[]=*semantic-release*
public-hoist-pattern[]=*stylelint*
```
### ESlint
config can be found at [`.eslintrc.js`](/src/eslint/index.ts)
```js
module.exports = require('@lobehub/lint').eslint;
```
### Stylelint
config can be found at [`.stylelintrc.js`](/src/stylelint/index.ts)
```js
module.exports = require('@lobehub/lint').stylelint;
```
### Commitlint
config can be found at [`.commitlintrc.js`](/src/commitlint/index.ts)
```js
module.exports = require('@lobehub/lint').commitlint;
```
### Changelog
config can be found at [`.changelogrc.js`](/src/changelog/index.ts)
```js
module.exports = require('@lobehub/lint').changelog;
```
### Remark
config can be found at [`.remarkrc.js`](/src/remarklint/index.ts)
```js
module.exports = require('@lobehub/lint').remarklint;
```
### Prettier
config can be found at [`.prettierrc.js`](/src/prettier/index.ts)
```js
module.exports = require('@lobehub/lint').prettier;
```
### Semantic Release
config can be found at [`.releaserc.js`](/src/semantic-release/index.ts)
```js
module.exports = require('@lobehub/lint').semanticRelease;
```
[![][back-to-top]](#readme-top)
## ⌨️ Local Development
You can use Github Codespaces for online development:
[![][codespaces-shield]][codespaces-link]
Or clone it for local development:
```bash
$ git clone https://github.com/lobehub/lobe-lint.git
$ cd lobehub/lint
$ bun install
$ bun start
```
[![][back-to-top]](#readme-top)
## 🤝 Contributing
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.
[![][pr-welcome-shield]][pr-welcome-link]
[![][contributors-contrib]][contributors-url]
[![][back-to-top]](#readme-top)
---
#### 📝 License
Copyright © 2023 [LobeHub][profile-link].
This project is [MIT](./LICENSE) licensed.
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[bun-link]: https://bun.sh
[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge
[codespaces-link]: https://codespaces.new/lobehub/lobe-lint
[codespaces-shield]: https://github.com/codespaces/badge.svg
[contributors-contrib]: https://contrib.rocks/image?repo=lobehub/lobe-lint
[contributors-url]: https://github.com/lobehub/lobe-lint/graphs/contributors
[discord-link]: https://discord.gg/AYFPHvv2jT
[discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
[github-action-release-link]: https://github.com/lobehub/lobe-lint/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-lint/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/lobehub/lobe-lint/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-lint/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contributors-link]: https://github.com/lobehub/lobe-lint/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-lint?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lobehub/lobe-lint/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-lint?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-lint/issues
[github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-lint?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lobehub/lobe-lint/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-lint?color=white&labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/lobehub/lobe-lint/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-lint?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lobehub/lobe-lint/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-lint?color=ffcb47&labelColor=black&style=flat-square
[issues-link]: https://github.com/lobehub/lobe-lint/issues/new/choose
[npm-downloads-link]: https://www.npmjs.com/package/@lobehub/lint
[npm-downloads-shield]: https://img.shields.io/npm/dt/@lobehub/lint?labelColor=black&style=flat-square
[npm-release-link]: https://www.npmjs.com/package/@lobehub/lint
[npm-release-shield]: https://img.shields.io/npm/v/@lobehub/lint?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
[pr-welcome-link]: https://github.com/lobehub/lobe-lint/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/lobehub