@liwo/eslint-config 0.0.6 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,40 @@
1
1
  # @liwo/eslint-config
2
2
 
3
- Hard-forked from `@antfu/eslint-config`. It adopts a more opinionated and aggressive approach, making it generally unsuitable for the majority of users.
3
+ ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC.svg?logo=typescript&logoColor=white)
4
+ [![npm](https://img.shields.io/npm/v/@liwo/eslint-config?label=npm)](https://npmjs.com/package/@liwo/eslint-config)
5
+ [![downloads](https://img.shields.io/npm/dm/@liwo/eslint-config.svg)](https://npmjs.com/package/@liwo/eslint-config)
6
+ [![ci status](https://github.com/liwonet/eslint-config/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/liwonet/eslint-config/actions/workflows/ci.yml)
7
+ ![unpacked size](https://img.shields.io/npm/unpacked-size/%40liwo%2Feslint-config)
8
+ ![license](https://img.shields.io/github/license/liwonet/eslint-config)
9
+
10
+ It's an opinionated and aggressive eslint config.
11
+
12
+ ## Install
13
+
14
+ ```shell
15
+ pnpm add -D eslint @liwo/eslint-config
16
+ ```
17
+
18
+ Add `package.json` scripts.
19
+
20
+ ```json
21
+ {
22
+ "scripts": {
23
+ "lint": "eslint .",
24
+ "format": "eslint --fix ."
25
+ }
26
+ }
27
+ ```
28
+
29
+ ## Usage
30
+
31
+ ```shell
32
+ pnpm run lint
33
+ ```
34
+
35
+ ```shell
36
+ pnpm run format
37
+ ```
4
38
 
5
39
  ## Acknowledgements
6
40