@pobammer-ts/small-rules 2.10.0 → 2.11.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.
Files changed (3) hide show
  1. package/README.md +21 -4
  2. package/dist/index.js +10 -10
  3. package/package.json +9 -9
package/README.md CHANGED
@@ -1,6 +1,23 @@
1
+ <div align="center">
2
+
1
3
  # `@pobammer-ts/small-rules`
2
4
 
3
- A collection of [Oxlint](https://oxc.rs)-native rules for linting [roblox-ts](https://roblox-ts.com/) projects.
5
+ **Oxlint-native lint rules for [roblox-ts](https://roblox-ts.com/) projects**
6
+
7
+ [![npm version](https://img.shields.io/npm/v/@pobammer-ts/small-rules?logo=npm&color=cb3837)](https://www.npmjs.com/package/@pobammer-ts/small-rules)
8
+ [![npm downloads](https://img.shields.io/npm/dm/@pobammer-ts/small-rules?logo=npm&color=cb3837)](https://www.npmjs.com/package/@pobammer-ts/small-rules)
9
+ [![Rules](https://img.shields.io/badge/rules-87-blueviolet)](https://docs.howmanysmall.com/small-rules/rules/)
10
+ [![CI](https://github.com/pobammer-ts/small-rules/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/pobammer-ts/small-rules/actions/workflows/ci.yaml)
11
+ [![License](https://img.shields.io/npm/l/@pobammer-ts/small-rules?color=blue)](https://github.com/pobammer-ts/small-rules/blob/main/LICENSE)
12
+
13
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.0%E2%80%938.0-3178c6?logo=typescript)](https://www.typescriptlang.org/)
14
+ [![Node.js](https://img.shields.io/badge/Node.js-%5E20.19%20%7C%20%E2%89%A522.12-339933?logo=node.js)](https://nodejs.org)
15
+ [![Oxlint](https://img.shields.io/badge/linter-Oxlint-f9801b?logo=oxlint)](https://oxc.rs)
16
+ [![Biome](https://img.shields.io/badge/code%20style-Biome-609d6c?logo=biome)](https://biomejs.dev)
17
+
18
+ </div>
19
+
20
+ ---
4
21
 
5
22
  ## Installation
6
23
 
@@ -8,7 +25,7 @@ A collection of [Oxlint](https://oxc.rs)-native rules for linting [roblox-ts](ht
8
25
  ni -D @pobammer-ts/small-rules
9
26
  ```
10
27
 
11
- This package is an [Oxlint plugin](https://oxc.rs/docs/guide/usage/plugins) and must be used with [Oxlint](https://oxc.rs) v1.69.0 or later. It supports TypeScript versions from 5 up to, but not including, 8 and requires Node.js `^20.19.0` or `>=22.12.0`.
28
+ > Requires [Oxlint](https://oxc.rs) **v1.69.0+**, TypeScript **5 – <8**, and Node.js **≥20.19** or **≥22.12**.
12
29
 
13
30
  ## Configuration
14
31
 
@@ -24,11 +41,11 @@ Register the plugin in your `.oxlintrc.json` and enable the rules you want:
24
41
  }
25
42
  ```
26
43
 
27
- All rules are namespaced under the `small-rules/` prefix. Pick the subset that fits your project — there is no bulk opt-in.
44
+ All rules are namespaced under `small-rules/`. Pick the subset that fits your project — there is no bulk opt-in.
28
45
 
29
46
  ## Rules
30
47
 
31
- Browse the [complete rule catalog](https://howmanysmall.github.io/small-rules/rules/) for source-backed descriptions, configuration, diagnostics, and examples.
48
+ Browse the [**full rule catalog →**](https://docs.howmanysmall.com/small-rules/rules/) for descriptions, options, diagnostics, and examples.
32
49
 
33
50
  ## License
34
51