ultracite 4.2.0 → 4.2.2
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 +2 -112
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Ultracite
|
|
2
2
|
|
|
3
|
-
Ultracite is a
|
|
3
|
+
Ultracite is a fast, intuitive and simple development tool that brings automated code formatting and linting to your JavaScript / TypeScript projects. Built on top of [Biome](https://biomejs.dev/) (a Rust-based code formatter and linter), Ultracite provides a robust, preconfigured setup optimized for modern web development.
|
|
4
4
|
|
|
5
5
|
<div>
|
|
6
6
|
<img src="https://img.shields.io/github/actions/workflow/status/haydenbleasel/ultracite/push.yaml" alt="" />
|
|
@@ -9,120 +9,10 @@ Ultracite is a robust linting configuration for modern TypeScript apps, built on
|
|
|
9
9
|
<img src="https://img.shields.io/github/license/haydenbleasel/ultracite" alt="" />
|
|
10
10
|
</div>
|
|
11
11
|
|
|
12
|
-
## Installation
|
|
13
|
-
|
|
14
|
-
### Automatic Installation
|
|
15
|
-
|
|
16
12
|
Run the command below to install and initialize Ultracite in the current directory:
|
|
17
13
|
|
|
18
14
|
```sh
|
|
19
15
|
npx ultracite init
|
|
20
16
|
```
|
|
21
17
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
Run the command below to install Ultracite:
|
|
25
|
-
|
|
26
|
-
```sh
|
|
27
|
-
pnpm add -D --save-exact ultracite @biomejs/biome
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
If you're running [VS Code](https://code.visualstudio.com/), ensure you have the following extensions installed:
|
|
31
|
-
|
|
32
|
-
```sh
|
|
33
|
-
code --install-extension biomejs.biome
|
|
34
|
-
code --install-extension bradlc.vscode-tailwindcss
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## Setup
|
|
38
|
-
|
|
39
|
-
Create a `biome.json` with the following contents:
|
|
40
|
-
|
|
41
|
-
```json
|
|
42
|
-
{
|
|
43
|
-
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
|
|
44
|
-
"extends": ["ultracite"]
|
|
45
|
-
}
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Ultracite is designed to be used with [VS Code](https://code.visualstudio.com/). Create a `.vscode/settings.json` file with the following contents to enable full formatting and fixing on save:
|
|
49
|
-
|
|
50
|
-
```json
|
|
51
|
-
{
|
|
52
|
-
"typescript.tsdk": "node_modules/typescript/lib",
|
|
53
|
-
"editor.defaultFormatter": "biomejs.biome",
|
|
54
|
-
"editor.formatOnSave": true,
|
|
55
|
-
"editor.formatOnPaste": true,
|
|
56
|
-
"emmet.showExpandedAbbreviation": "never",
|
|
57
|
-
"editor.codeActionsOnSave": {
|
|
58
|
-
"source.fixAll.biome": "explicit",
|
|
59
|
-
"source.organizeImports.biome": "explicit"
|
|
60
|
-
},
|
|
61
|
-
"[typescript]": {
|
|
62
|
-
"editor.defaultFormatter": "biomejs.biome"
|
|
63
|
-
},
|
|
64
|
-
"[json]": {
|
|
65
|
-
"editor.defaultFormatter": "biomejs.biome"
|
|
66
|
-
},
|
|
67
|
-
"[javascript]": {
|
|
68
|
-
"editor.defaultFormatter": "biomejs.biome"
|
|
69
|
-
},
|
|
70
|
-
"[jsonc]": {
|
|
71
|
-
"editor.defaultFormatter": "biomejs.biome"
|
|
72
|
-
},
|
|
73
|
-
"[typescriptreact]": {
|
|
74
|
-
"editor.defaultFormatter": "biomejs.biome"
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
Lastly, ensure your `tsconfig.json` (if it exists) has `strictNullChecks` enabled.
|
|
80
|
-
|
|
81
|
-
```json
|
|
82
|
-
{
|
|
83
|
-
"compilerOptions": {
|
|
84
|
-
"strictNullChecks": true
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
## Usage
|
|
90
|
-
|
|
91
|
-
Ultracite will automatically lint, fix and format your code on save. If you'd like to run Ultracite manually, you can do so with the following command:
|
|
92
|
-
|
|
93
|
-
```sh
|
|
94
|
-
npx ultracite
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
## Configuration
|
|
98
|
-
|
|
99
|
-
While Ultracite is designed to be zero-config, you can modify anything you'd like in your `biome.json` file. For example, to enable the `noAutofocus` rule, you can do the following:
|
|
100
|
-
|
|
101
|
-
```json
|
|
102
|
-
{
|
|
103
|
-
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
|
|
104
|
-
"extends": ["ultracite"],
|
|
105
|
-
"linter": {
|
|
106
|
-
"rules": {
|
|
107
|
-
"a11y": {
|
|
108
|
-
"noAutofocus": "off"
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
}
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
You can also disable rules on a per-line basis by adding a comment to the end of the line:
|
|
116
|
-
|
|
117
|
-
```tsx
|
|
118
|
-
// biome-ignore lint/security/noDangerouslySetInnerHtml: I do what I want mate.
|
|
119
|
-
<div dangerouslySetInnerHTML={{ ... }} />
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
## Notes
|
|
123
|
-
|
|
124
|
-
Ultracite was previously built on [ESLint](https://eslint.org/), [Prettier](https://prettier.io/) and [Stylelint](https://stylelint.io/). If you'd like to use that stack, you can install a compatible version of Ultracite with the following command:
|
|
125
|
-
|
|
126
|
-
```sh
|
|
127
|
-
pnpm add -D ultracite@3 eslint@8 prettier stylelint typescript jest
|
|
128
|
-
```
|
|
18
|
+
Read the [docs](https://www.ultracite.dev/) for more information.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "Hayden Bleasel <hello@haydenbleasel.com>",
|
|
3
3
|
"bin": {
|
|
4
|
-
"ultracite": "
|
|
4
|
+
"ultracite": "scripts/run.mjs"
|
|
5
5
|
},
|
|
6
6
|
"auto": {
|
|
7
7
|
"plugins": [
|
|
@@ -39,9 +39,9 @@
|
|
|
39
39
|
"type": "git",
|
|
40
40
|
"url": "git+https://github.com/haydenbleasel/ultracite.git"
|
|
41
41
|
},
|
|
42
|
-
"version": "4.2.
|
|
42
|
+
"version": "4.2.2",
|
|
43
43
|
"devDependencies": {
|
|
44
|
-
"@biomejs/biome": "
|
|
44
|
+
"@biomejs/biome": "1.9.4"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
47
|
"commander": "^12.1.0"
|