@rrlab/biome-config 0.0.4 → 0.0.5

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/LICENSE +21 -0
  2. package/README.md +17 -11
  3. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 rcrd <ricardo@variable.land>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,36 +1,42 @@
1
- # @rrlab/biome-config
1
+ # biome-config
2
2
 
3
- Shared [Biome](https://biomejs.dev) preset for projects using [`@rrlab/biome-plugin`](https://npmjs.com/package/@rrlab/biome-plugin).
3
+ `@rrlab/biome-config` is the [Biome](https://biomejs.dev) preset of [run-run](https://github.com/withvariablelab/dx/tree/main/run-run/cli). The `biome.json` that [`@rrlab/biome-plugin`](https://www.npmjs.com/package/@rrlab/biome-plugin) writes extends it.
4
4
 
5
5
  ## Install
6
6
 
7
- If you use [`@rrlab/cli`](https://npmjs.com/package/@rrlab/cli):
7
+ If you use run-run:
8
8
 
9
9
  ```sh
10
10
  rr plugins add biome
11
11
  ```
12
12
 
13
- Scaffolds a `biome.json` extending this config (with your confirmation).
13
+ Once you confirm, it installs this preset and writes a `biome.json` that extends it.
14
14
 
15
- If you don't, install manually:
15
+ Without run-run, install it by hand:
16
16
 
17
17
  ```sh
18
18
  pnpm add -D @rrlab/biome-config @biomejs/biome
19
19
  ```
20
20
 
21
- …and create a `biome.json`:
21
+ Then create a `biome.json`:
22
22
 
23
23
  ```json
24
24
  {
25
- "$schema": "https://biomejs.dev/schemas/2.4.4/schema.json",
25
+ "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
26
26
  "extends": ["@rrlab/biome-config"]
27
27
  }
28
28
  ```
29
29
 
30
- ## Override
30
+ It needs Biome 2 or later: the preset's `$schema` URL is tied to a Biome major, and the rule set changes between majors.
31
31
 
32
- Local keys in your `biome.json` win over the preset. Add `linter.rules`, `formatter`, `files.includes`, etc. to taste. If you want to chain another shared config on top, append it to the `extends` array — entries later in the array override earlier ones, so the user's preferences and local overrides win over our base.
32
+ ## Configuration
33
33
 
34
- ## Peer dependencies
34
+ Keys in your `biome.json` win over the preset. Add `linter.rules`, `formatter`, `files.includes` or any other setting as you need. To chain another shared config on top, append it to the `extends` array: later entries override earlier ones, so your preferences and local keys win over this base.
35
35
 
36
- - `@biomejs/biome >= 2.0.0` — the `$schema` URL is tied to a biome major and the rule set evolves between majors.
36
+ ## License
37
+
38
+ [MIT](https://github.com/withvariablelab/dx/blob/main/LICENSE).
39
+
40
+ <p align="center">
41
+ <a href="https://lab.variable.land"><img src="https://cdn.jsdelivr.net/gh/withvariablelab/brand@v0.3.1/.github/readme/logo.svg" width="24" alt="" align="absmiddle">&nbsp;Variable Land</a>
42
+ </p>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rrlab/biome-config",
3
- "version": "0.0.4",
3
+ "version": "0.0.5",
4
4
  "description": "Shared Biome preset used by @rrlab/biome-plugin.",
5
5
  "homepage": "https://github.com/withvariablelab/dx/tree/main/run-run/biome-config#readme",
6
6
  "bugs": {