@biomejs/biome 1.3.3 → 1.4.1-nightly.22dd4e1
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/LICENSE-APACHE +201 -0
- package/LICENSE-MIT +21 -0
- package/README.ja.md +119 -0
- package/README.md +82 -16
- package/README.pt-br.md +123 -0
- package/README.zh-CN.md +115 -0
- package/ROME-LICENSE-MIT +21 -0
- package/bin/biome +26 -1
- package/configuration_schema.json +336 -35
- package/package.json +1 -1
- package/scripts/postinstall.js +25 -1
package/LICENSE-APACHE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright (c) 2023 Biome Developers and Contributors.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/LICENSE-MIT
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Biome Developers and Contributors.
|
|
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.ja.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img alt="Biome - Toolchain of the web"
|
|
3
|
+
src="https://raw.githubusercontent.com/biomejs/resources/main/biome-logo-slogan.svg"
|
|
4
|
+
width="400">
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<div align="center">
|
|
8
|
+
|
|
9
|
+
[![Discord chat][discord-badge]][discord-url]
|
|
10
|
+
[![CI on main][ci-badge]][ci-url]
|
|
11
|
+
[![npm version][npm-badge]][npm-url]
|
|
12
|
+
[![VSCode version][vscode-badge]][vscode-url]
|
|
13
|
+
[![Open VSX version][open-vsx-badge]][open-vsx-url]
|
|
14
|
+
|
|
15
|
+
[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
|
|
16
|
+
[discord-url]: https://discord.gg/BypW39g6Yc
|
|
17
|
+
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
|
|
18
|
+
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
|
|
19
|
+
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
|
|
20
|
+
[npm-url]: https://www.npmjs.com/package/@biomejs/biome/v/latest
|
|
21
|
+
[vscode-badge]: https://badgen.net/vs-marketplace/v/biomejs.biome?label=vscode&icon=visualstudio&color=green
|
|
22
|
+
[vscode-url]: https://marketplace.visualstudio.com/items?itemName=biomejs.biome
|
|
23
|
+
[open-vsx-badge]: https://badgen.net/open-vsx/version/biomejs/biome?label=open-vsx&color=green
|
|
24
|
+
[open-vsx-url]: https://open-vsx.org/extension/biomejs/biome
|
|
25
|
+
|
|
26
|
+
</div>
|
|
27
|
+
|
|
28
|
+
<div align="center">
|
|
29
|
+
|
|
30
|
+
[English](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.md) | [简体中文](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.zh-CN.md) | 日本語 | [Português do Brasil](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.pt-br.md)
|
|
31
|
+
|
|
32
|
+
</div>
|
|
33
|
+
|
|
34
|
+
**Biome** はWebプロジェクトのための高性能なツールチェーンであり、プロジェクトの健全性を維持するための開発者ツールの提供を目的としています。
|
|
35
|
+
|
|
36
|
+
**Biome は _JavaScript_, _TypeScript_, _JSX_ そして _JSON_ 向けの[高速なFormatter](./benchmark#formatting)**であり、**[_Prettier_ との互換性は97%](https://console.algora.io/challenges/prettier)** を達成しています。
|
|
37
|
+
|
|
38
|
+
**Biome は _JavaScript_, _TypeScript_, _JSX_ のための[高性能なLinter](https://github.com/biomejs/biome/tree/main/benchmark#linting)** であり、ESLint, TypeScript ESLint, [その他のソース](https://github.com/biomejs/biome/discussions/3)から **[170以上のルール](https://biomejs.dev/linter/rules/)**を提供しています。Biome は**詳細で文脈に沿った結果を出力**するため、コードを改善し、より良いプログラマになるための手助けをします!
|
|
39
|
+
|
|
40
|
+
**Biome** は最初から[**エディタ内で対話的に**](https://biomejs.dev/ja/guides/integrate-in-editor/)使用できるように設計されています。
|
|
41
|
+
あなたがコードを書いているときに、形の崩れたコードを format と lint することができます。
|
|
42
|
+
|
|
43
|
+
### インストール
|
|
44
|
+
|
|
45
|
+
```shell
|
|
46
|
+
npm install --save-dev --save-exact @biomejs/biome
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### 使い方
|
|
50
|
+
|
|
51
|
+
```shell
|
|
52
|
+
# ファイルをformatする
|
|
53
|
+
npx @biomejs/biome format --write ./src
|
|
54
|
+
|
|
55
|
+
# ファイルをlintする
|
|
56
|
+
npx @biomejs/biome lint ./src
|
|
57
|
+
|
|
58
|
+
# format、lintなどを実行し、安全な提案を適用する
|
|
59
|
+
npx @biomejs/biome check --apply ./src
|
|
60
|
+
|
|
61
|
+
# CI環境では、すべてのファイルを対象にformatやlintをチェックする
|
|
62
|
+
npx @biomejs/biome ci ./src
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Biome をインストールせずに試したい場合は、WebAssembly にコンパイルされた[オンラインのプレイグラウンド](https://biomejs.dev/playground/)を利用してください。
|
|
66
|
+
|
|
67
|
+
## ドキュメント
|
|
68
|
+
|
|
69
|
+
Biome についてもっと知るために[ホームページ][biomejs]をチェックするか、Biome を使い始めるために[はじめる][getting-started]に進んでください。
|
|
70
|
+
|
|
71
|
+
## Biome をもっと詳しく
|
|
72
|
+
|
|
73
|
+
**Biome** は理にかなったデフォルト設定を持ち、設定を必要としません。
|
|
74
|
+
|
|
75
|
+
**Biome** はモダンなウェブ開発における[全ての主要な言語][language-support]をサポートすることを目指しています。
|
|
76
|
+
|
|
77
|
+
**Biome** は動作するために Node.js を必要としません。
|
|
78
|
+
|
|
79
|
+
**Biome** はソーステキストの完全な表現力とエラー回復能力を持つ洗練されたParserによって、優れたLSPサポートを提供します。
|
|
80
|
+
|
|
81
|
+
**Biome** は以前は別々のツールで提供されていた機能を統合します。共通基盤を構築することで、コードの処理、エラーの表示、並列処理、キャッシュ、設定について統一的な体験を提供します。
|
|
82
|
+
|
|
83
|
+
興味のある方は、[プロジェクトの理念][biome-philosophy]もご覧ください。
|
|
84
|
+
|
|
85
|
+
**Biome** は [MIT ライセンス](https://github.com/biomejs/biome/tree/main/LICENSE-MIT)または [Apache 2.0 ライセンス](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE)であり、[コントリビューター行動規範](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md)の下で管理されています。
|
|
86
|
+
|
|
87
|
+
## スポンサー
|
|
88
|
+
|
|
89
|
+
### ゴールドスポンサー
|
|
90
|
+
|
|
91
|
+
<table>
|
|
92
|
+
<tbody>
|
|
93
|
+
<tr>
|
|
94
|
+
<td align="center" valign="middle">
|
|
95
|
+
<a href="https://shiguredo.jp/" target="_blank"><img src="https://shiguredo.jp/official_shiguredo_logo.svg" height="120"></a>
|
|
96
|
+
</td>
|
|
97
|
+
</tr>
|
|
98
|
+
</tbody>
|
|
99
|
+
</table>
|
|
100
|
+
|
|
101
|
+
### ブロンズスポンサー
|
|
102
|
+
|
|
103
|
+
<table>
|
|
104
|
+
<tbody>
|
|
105
|
+
<tr>
|
|
106
|
+
<td align="center" valign="middle">
|
|
107
|
+
<a href="https://www.kanamekey.com" target="_blank"><img src="https://images.opencollective.com/kaname/d15fd98/logo/256.png?height=80" width="80"></a>
|
|
108
|
+
</td>
|
|
109
|
+
<td align="center" valign="middle">
|
|
110
|
+
<a href="https://nanabit.dev/" target="_blank"><img src="https://images.opencollective.com/nanabit/d15fd98/logo/256.png?height=80" width="80"></a>
|
|
111
|
+
</td>
|
|
112
|
+
</tr>
|
|
113
|
+
</tbody>
|
|
114
|
+
</table>
|
|
115
|
+
|
|
116
|
+
[biomejs]: https://biomejs.dev/ja/
|
|
117
|
+
[biome-philosophy]: https://biomejs.dev/ja/internals/philosophy/
|
|
118
|
+
[language-support]: https://biomejs.dev/ja/internals/language-support/
|
|
119
|
+
[getting-started]: https://biomejs.dev/ja/guides/getting-started/
|
package/README.md
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-dark-transparent.svg">
|
|
4
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-light-transparent.svg">
|
|
5
|
+
<img alt="Shows the banner of Biome, with its logo and the phrase 'Biome - Toolchain of the web'." src="https://raw.githubusercontent.com/biomejs/resources/main/svg/slogan-light-transparent.svg" width="700">
|
|
6
|
+
</picture>
|
|
5
7
|
</p>
|
|
6
8
|
|
|
7
9
|
<div align="center">
|
|
@@ -23,34 +25,98 @@
|
|
|
23
25
|
[open-vsx-badge]: https://badgen.net/open-vsx/version/biomejs/biome?label=open-vsx&color=green
|
|
24
26
|
[open-vsx-url]: https://open-vsx.org/extension/biomejs/biome
|
|
25
27
|
|
|
28
|
+
</div>
|
|
29
|
+
|
|
30
|
+
<div align="center">
|
|
31
|
+
|
|
32
|
+
English | [简体中文](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.zh-CN.md) | [日本語](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.ja.md) | [Português do Brasil](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.pt-br.md)
|
|
26
33
|
|
|
27
34
|
</div>
|
|
28
35
|
|
|
29
|
-
**Biome**
|
|
36
|
+
**Biome** is a performant toolchain for web projects, it aims to provide developer tools to maintain the health of said projects.
|
|
30
37
|
|
|
31
|
-
**Biome**
|
|
32
|
-
It aims to support [all main languages][language-support] of modern web development.
|
|
38
|
+
**Biome is a [fast formatter](./benchmark#formatting)** for _JavaScript_, _TypeScript_, _JSX_, and _JSON_ that scores **[97% compatibility with _Prettier_](https://console.algora.io/challenges/prettier)**.
|
|
33
39
|
|
|
34
|
-
**Biome**
|
|
35
|
-
**
|
|
36
|
-
|
|
40
|
+
**Biome is a [performant linter](https://github.com/biomejs/biome/tree/main/benchmark#linting)** for _JavaScript_, _TypeScript_, and _JSX_ that features **[more than 170 rules](https://biomejs.dev/linter/rules/)** from ESLint, TypeScript ESLint, and [other sources](https://github.com/biomejs/biome/discussions/3).
|
|
41
|
+
It **outputs detailed and contextualized diagnostics** that help you to improve your code and become a better programmer!
|
|
42
|
+
|
|
43
|
+
**Biome** is designed from the start to be used [interactively within an editor](https://biomejs.dev/guides/integrate-in-editor/).
|
|
44
|
+
It can format and lint malformed code as you are writing it.
|
|
37
45
|
|
|
38
|
-
|
|
39
|
-
Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelizing work, caching, and configuration.
|
|
46
|
+
### Installation
|
|
40
47
|
|
|
41
|
-
|
|
48
|
+
```shell
|
|
49
|
+
npm install --save-dev --save-exact @biomejs/biome
|
|
50
|
+
```
|
|
42
51
|
|
|
43
|
-
|
|
44
|
-
with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery.
|
|
52
|
+
### Usage
|
|
45
53
|
|
|
46
|
-
|
|
54
|
+
```shell
|
|
55
|
+
# format files
|
|
56
|
+
npx @biomejs/biome format --write ./src
|
|
57
|
+
|
|
58
|
+
# lint files
|
|
59
|
+
npx @biomejs/biome lint ./src
|
|
60
|
+
|
|
61
|
+
# run format, lint, etc. and apply the safe suggestions
|
|
62
|
+
npx @biomejs/biome check --apply ./src
|
|
63
|
+
|
|
64
|
+
# check all files against format, lint, etc. in CI environments
|
|
65
|
+
npx @biomejs/biome ci ./src
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
If you want to give Biome a run without installing it, use the [online playground](https://biomejs.dev/playground/), compiled to WebAssembly.
|
|
47
69
|
|
|
48
70
|
## Documentation
|
|
49
71
|
|
|
50
72
|
Check out our [homepage][biomejs] to learn more about Biome,
|
|
51
73
|
or directly head to the [Getting Started guide][getting-started] to start using Biome.
|
|
52
74
|
|
|
53
|
-
|
|
75
|
+
## More about Biome
|
|
76
|
+
|
|
77
|
+
**Biome** has sane defaults and it doesn't require configuration.
|
|
78
|
+
|
|
79
|
+
**Biome** aims to support [all main languages][language-support] of modern web development.
|
|
80
|
+
|
|
81
|
+
**Biome** [doesn't require Node.js](https://biomejs.dev/guides/manual-installation/) to function.
|
|
82
|
+
|
|
83
|
+
**Biome** has first-class LSP support, with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery.
|
|
84
|
+
|
|
85
|
+
**Biome** unifies functionality that has previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelize work, caching, and configuration.
|
|
86
|
+
|
|
87
|
+
Read more about our [project philosophy][biome-philosophy].
|
|
88
|
+
|
|
89
|
+
**Biome** is [MIT licensed](https://github.com/biomejs/biome/tree/main/LICENSE-MIT) or [Apache 2.0 licensed](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md).
|
|
90
|
+
|
|
91
|
+
## Sponsors
|
|
92
|
+
|
|
93
|
+
### Gold Sponsors
|
|
94
|
+
|
|
95
|
+
<table>
|
|
96
|
+
<tbody>
|
|
97
|
+
<tr>
|
|
98
|
+
<td align="center" valign="middle">
|
|
99
|
+
<a href="https://shiguredo.jp/" target="_blank"><img src="https://shiguredo.jp/official_shiguredo_logo.svg" height="120"></a>
|
|
100
|
+
</td>
|
|
101
|
+
</tr>
|
|
102
|
+
</tbody>
|
|
103
|
+
</table>
|
|
104
|
+
|
|
105
|
+
### Bronze Sponsors
|
|
106
|
+
|
|
107
|
+
<table>
|
|
108
|
+
<tbody>
|
|
109
|
+
<tr>
|
|
110
|
+
<td align="center" valign="middle">
|
|
111
|
+
<a href="https://www.kanamekey.com" target="_blank"><img src="https://images.opencollective.com/kaname/d15fd98/logo/256.png?height=80" width="80"></a>
|
|
112
|
+
</td>
|
|
113
|
+
<td align="center" valign="middle">
|
|
114
|
+
<a href="https://nanabit.dev/" target="_blank"><img src="https://images.opencollective.com/nanabit/d15fd98/logo/256.png?height=80" width="80"></a>
|
|
115
|
+
</td>
|
|
116
|
+
</tr>
|
|
117
|
+
</tbody>
|
|
118
|
+
</table>
|
|
119
|
+
|
|
54
120
|
[biomejs]: https://biomejs.dev/
|
|
55
121
|
[biome-philosophy]: https://biomejs.dev/internals/philosophy/
|
|
56
122
|
[language-support]: https://biomejs.dev/internals/language-support/
|
package/README.pt-br.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img alt="Biome - Conjunto de ferramentas da web"
|
|
3
|
+
src="https://raw.githubusercontent.com/biomejs/resources/main/biome-logo-slogan.svg"
|
|
4
|
+
width="400">
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<div align="center">
|
|
8
|
+
|
|
9
|
+
[![Chat no Discord][discord-badge]][discord-url]
|
|
10
|
+
[![CI na `main`][ci-badge]][ci-url]
|
|
11
|
+
[![versão npm][npm-badge]][npm-url]
|
|
12
|
+
[![versão VSCode][vscode-badge]][vscode-url]
|
|
13
|
+
[![versão Open VSX][open-vsx-badge]][open-vsx-url]
|
|
14
|
+
|
|
15
|
+
[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
|
|
16
|
+
[discord-url]: https://discord.gg/BypW39g6Yc
|
|
17
|
+
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
|
|
18
|
+
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
|
|
19
|
+
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
|
|
20
|
+
[npm-url]: https://www.npmjs.com/package/@biomejs/biome/v/latest
|
|
21
|
+
[vscode-badge]: https://badgen.net/vs-marketplace/v/biomejs.biome?label=vscode&icon=visualstudio&color=green
|
|
22
|
+
[vscode-url]: https://marketplace.visualstudio.com/items?itemName=biomejs.biome
|
|
23
|
+
[open-vsx-badge]: https://badgen.net/open-vsx/version/biomejs/biome?label=open-vsx&color=green
|
|
24
|
+
[open-vsx-url]: https://open-vsx.org/extension/biomejs/biome
|
|
25
|
+
|
|
26
|
+
</div>
|
|
27
|
+
|
|
28
|
+
<div align="center">
|
|
29
|
+
|
|
30
|
+
[English](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.md) | [简体中文](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.zh-CN.md) | [日本語](https://github.com/biomejs/biome/blob/main/packages/%40biomejs/biome/README.ja.md) | Português do Brasil
|
|
31
|
+
|
|
32
|
+
</div>
|
|
33
|
+
|
|
34
|
+
**Biome** é um conjunto de ferramentas de alto desempenho para projetos web, visando fornecer recursos de desenvolvimento para manter a saúde desses projetos.
|
|
35
|
+
|
|
36
|
+
**Biome é um [formatador rápido](./benchmark#formatting)** para _JavaScript_, _TypeScript_, _JSX_, e _JSON_ que atinge **[97% de compatibilidade com o _Prettier_](https://console.algora.io/challenges/prettier)**.
|
|
37
|
+
|
|
38
|
+
**Biome é um [linter eficiente](https://github.com/biomejs/biome/tree/main/benchmark#linting)** para _JavaScript_, _TypeScript_, e _JSX_ que possui **[mais de 170 regras](https://biomejs.dev/linter/rules/)** do ESLint, TypeScript ESLint, e de [outras fontes](https://github.com/biomejs/biome/discussions/3).
|
|
39
|
+
Ele **fornece diagnósticos detalhados e contextualizados** que ajudam você a melhorar seu código e se tornar um programador melhor!
|
|
40
|
+
|
|
41
|
+
**Biome** é projetado desde o início para ser usado [interativamente dentro de um editor](https://biomejs.dev/guides/integrate-in-editor/).
|
|
42
|
+
Isso permite formatar e lintar códigos malformados enquanto você programa.
|
|
43
|
+
|
|
44
|
+
### Instalação
|
|
45
|
+
|
|
46
|
+
```shell
|
|
47
|
+
npm install --save-dev --save-exact @biomejs/biome
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Uso
|
|
51
|
+
|
|
52
|
+
```shell
|
|
53
|
+
# formatar arquivos
|
|
54
|
+
npx @biomejs/biome format --write ./src
|
|
55
|
+
|
|
56
|
+
# lintar arquivos
|
|
57
|
+
npx @biomejs/biome lint ./src
|
|
58
|
+
|
|
59
|
+
# executar formatação, lint, etc. e aplicar as sugestões seguras
|
|
60
|
+
npx @biomejs/biome check --apply ./src
|
|
61
|
+
|
|
62
|
+
# verificar todos os arquivos contra formatação, lint, etc. em ambientes CI
|
|
63
|
+
npx @biomejs/biome ci ./src
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Se você quiser experimentar o Biome sem instalá-lo, use o [playground online](https://biomejs.dev/playground/), compilado para WebAssembly.
|
|
67
|
+
|
|
68
|
+
## Documentação
|
|
69
|
+
|
|
70
|
+
Confira nossa [página inicial][biomejs] para saber mais sobre o Biome,
|
|
71
|
+
ou vá ao [Guia de Introdução][getting-started] para começar a usar o Biome.
|
|
72
|
+
|
|
73
|
+
## Mais sobre o Biome
|
|
74
|
+
|
|
75
|
+
**Biome** tem padrões robustos e não requer configuração.
|
|
76
|
+
|
|
77
|
+
**Biome** visa suportar [todas as principais linguagens][language-support] do desenvolvimento web moderno.
|
|
78
|
+
|
|
79
|
+
**Biome** [não requer Node.js](https://biomejs.dev/guides/manual-installation/) para funcionar.
|
|
80
|
+
|
|
81
|
+
**Biome** tem suporte de primeira linha para LSP, com um
|
|
82
|
+
|
|
83
|
+
parser sofisticado que representa o texto-fonte em sua total fidelidade e recuperação de erro de ponta.
|
|
84
|
+
|
|
85
|
+
**Biome** unifica funcionalidades que anteriormente eram ferramentas separadas. Construindo sobre uma base compartilhada, podemos fornecer uma experiência coesa para processar código, exibir erros, paralelizar trabalho, cache e configuração.
|
|
86
|
+
|
|
87
|
+
Leia mais sobre nossa [filosofia de projeto][biome-philosophy].
|
|
88
|
+
|
|
89
|
+
**Biome** é licenciado sob [MIT](https://github.com/biomejs/biome/tree/main/LICENSE-MIT) ou [Apache 2.0](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE) e moderado sob o [Código de Conduta do Contribuidor](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md).
|
|
90
|
+
|
|
91
|
+
## Patrocinadores
|
|
92
|
+
|
|
93
|
+
### Patrocinadores Ouro
|
|
94
|
+
|
|
95
|
+
<table>
|
|
96
|
+
<tbody>
|
|
97
|
+
<tr>
|
|
98
|
+
<td align="center" valign="middle">
|
|
99
|
+
<a href="https://shiguredo.jp/" target="_blank"><img src="https://shiguredo.jp/official_shiguredo_logo.svg" height="120"></a>
|
|
100
|
+
</td>
|
|
101
|
+
</tr>
|
|
102
|
+
</tbody>
|
|
103
|
+
</table>
|
|
104
|
+
|
|
105
|
+
### Patrocinadores Bronze
|
|
106
|
+
|
|
107
|
+
<table>
|
|
108
|
+
<tbody>
|
|
109
|
+
<tr>
|
|
110
|
+
<td align="center" valign="middle">
|
|
111
|
+
<a href="https://www.kanamekey.com" target="_blank"><img src="https://images.opencollective.com/kaname/d15fd98/logo/256.png?height=80" width="80"></a>
|
|
112
|
+
</td>
|
|
113
|
+
<td align="center" valign="middle">
|
|
114
|
+
<a href="https://nanabit.dev/" target="_blank"><img src="https://images.opencollective.com/nanabit/d15fd98/logo/256.png?height=80" width="80"></a>
|
|
115
|
+
</td>
|
|
116
|
+
</tr>
|
|
117
|
+
</tbody>
|
|
118
|
+
</table>
|
|
119
|
+
|
|
120
|
+
[biomejs]: https://biomejs.dev/pt-br/
|
|
121
|
+
[biome-philosophy]: https://biomejs.dev/pt-br/internals/philosophy/
|
|
122
|
+
[language-support]: https://biomejs.dev/pt-br/internals/language-support/
|
|
123
|
+
[getting-started]: https://biomejs.dev/pt-br/guides/getting-started/
|