docs(prettier): add prettier docs
add README.md add config and ignore files
This commit is contained in:
4
prettier/.prettierignore
Normal file
4
prettier/.prettierignore
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
**/.git
|
||||||
|
**/.svn
|
||||||
|
**/.hg
|
||||||
|
**/node_modules
|
||||||
10
prettier/.prettierrc
Normal file
10
prettier/.prettierrc
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"semi": true,
|
||||||
|
"singleQuote": true,
|
||||||
|
"bracketSpacing": true,
|
||||||
|
"trailingComma": "es5",
|
||||||
|
"printWidth": 120,
|
||||||
|
"arrowParens": "avoid",
|
||||||
|
"endOfLine": "auto",
|
||||||
|
"tabWidth": 4
|
||||||
|
}
|
||||||
31
prettier/README.md
Normal file
31
prettier/README.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# 🛠️ Prettier
|
||||||
|
|
||||||
|
**Prettier** — это автоматический форматтер кода. Он помогает поддерживать единый стиль написания кода во всем проекте, избавляя от субъективных решений.
|
||||||
|
|
||||||
|
---
|
||||||
|
## ⚙️ Конфигурация
|
||||||
|
|
||||||
|
`.prettierignore` - игнорирование форматирования
|
||||||
|
`.prettierrc` - файл конфигурации
|
||||||
|
|
||||||
|
| Параметр | Значение | Описание |
|
||||||
|
| ---------------- | --------- | --------------------------------------------------------------- |
|
||||||
|
| `semi` | `true` | Ставить точку с запятой в конце строки |
|
||||||
|
| `singleQuote` | `true` | Использовать одинарные кавычки вместо двойных |
|
||||||
|
| `bracketSpacing` | `true` | Добавлять пробелы внутри фигурных скобок (`{ foo: bar }`) |
|
||||||
|
| `trailingComma` | `es5` | Ставить запятые в конце объектов/массивов (но не в функциях) |
|
||||||
|
| `printWidth` | `120` | Максимальная длина строки |
|
||||||
|
| `arrowParens` | `"avoid"` | Удалять скобки у однострочных стрелочных функций (`x => x + 1`) |
|
||||||
|
| `endOfLine` | `"auto"` | Использовать системный стиль переноса строк (Windows/Unix) |
|
||||||
|
| `tabWidth` | `4` | Ширина таба в пробелах (4 пробела) |
|
||||||
|
|
||||||
|
---
|
||||||
|
## 🚀 Использование
|
||||||
|
Форматировать все файлы проекта:
|
||||||
|
```bash
|
||||||
|
npx prettier --write .
|
||||||
|
```
|
||||||
|
Только определённые файлы:
|
||||||
|
```bash
|
||||||
|
npx prettier --write "src/**/*.ts"
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user