@slowpoketail/oxc 1.1.0 → 1.1.1
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 +4 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,35 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
This package contains shareable configurations of Oxlint and Oxfmt.
|
|
4
4
|
|
|
5
|
-
**NOTE:** At this time, it is known that certain package dependencies may not be used by the user. They are all
|
|
6
|
-
|
|
7
|
-
## Plugin runtimes
|
|
8
|
-
|
|
9
|
-
The base preset uses bundled plugin entrypoints:
|
|
10
|
-
|
|
11
|
-
| Export | Plugin |
|
|
12
|
-
| ----------------------------------------- | ----------------------------- |
|
|
13
|
-
| `@slowpoketail/oxc/plugins/e18e` | `@e18e/eslint-plugin` |
|
|
14
|
-
| `@slowpoketail/oxc/plugins/perfectionist` | `eslint-plugin-perfectionist` |
|
|
15
|
-
|
|
16
|
-
Both the recommended rules and Oxlint's `jsPlugins` registrations use these
|
|
17
|
-
entrypoints. The build bundles their runtime dependencies instead of resolving
|
|
18
|
-
them from the consumer's project. Consumers do not need to install these plugins
|
|
19
|
-
directly. SonarJS is not included.
|
|
20
|
-
|
|
21
|
-
Tailwind and UnoCSS remain external runtime dependencies because they load worker
|
|
22
|
-
files relative to their installed packages. Their presets resolve them from this
|
|
23
|
-
package's installation.
|
|
24
|
-
|
|
25
|
-
Plugin dependencies remain declared in `dependencies` for now. Bundling isolates
|
|
26
|
-
the base plugin runtimes; it does not reduce installed dependency size.
|
|
27
|
-
The build includes third-party license notices in `dist/THIRD_PARTY_LICENSES.txt`.
|
|
5
|
+
**NOTE:** At this time, it is known that certain package dependencies may not be used by the user. They are all bundled for convenience.
|
|
28
6
|
|
|
29
7
|
## Usage
|
|
30
8
|
|
|
31
9
|
Install the shared configuration and the tools you use:
|
|
32
10
|
|
|
33
11
|
```sh
|
|
12
|
+
# Install one or the other, or both oxlint / oxfmt
|
|
34
13
|
{PACKAGE_MANAGER} install -D @slowpoketail/oxc
|
|
35
14
|
{PACKAGE_MANAGER} install -D oxlint
|
|
36
15
|
{PACKAGE_MANAGER} install -D oxfmt
|
|
@@ -44,12 +23,10 @@ import { defineConfig } from "oxlint";
|
|
|
44
23
|
|
|
45
24
|
export default defineConfig({
|
|
46
25
|
extends: [lint],
|
|
26
|
+
// Other overrides
|
|
47
27
|
});
|
|
48
28
|
```
|
|
49
29
|
|
|
50
|
-
For Next.js, import `@slowpoketail/oxc/lint/next` instead. It already extends the
|
|
51
|
-
React and base presets.
|
|
52
|
-
|
|
53
30
|
In `oxfmt.config.ts`:
|
|
54
31
|
|
|
55
32
|
```ts
|
|
@@ -58,5 +35,6 @@ import { defineConfig } from "oxfmt";
|
|
|
58
35
|
|
|
59
36
|
export default defineConfig({
|
|
60
37
|
...fmt,
|
|
38
|
+
// Other overrides
|
|
61
39
|
});
|
|
62
40
|
```
|