@labeg/code-style 4.0.5 → 4.0.7

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 (2) hide show
  1. package/README.md +20 -11
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -1,16 +1,19 @@
1
- ![GitHub](https://img.shields.io/github/license/LabEG/code-style.svg)
1
+ # CodeStyle
2
2
 
3
+ ![GitHub](https://img.shields.io/github/license/LabEG/code-style.svg)
3
4
 
4
- # CodeStyle
5
5
  В этом репозитории я собираю файлы стилей для облегчения синхронизации между проектами.
6
6
 
7
7
  ## Подключение
8
- Для подключение необходимо установить пакет командой:
8
+
9
+ Для подключения необходимо установить пакет командой:
10
+
9
11
  ```Bash
10
12
  npm i -D @labeg/code-style
11
13
  ```
12
14
 
13
- Далее в вашь файл eslint config необходимо добавить следующую строчку:
15
+ Далее в ваш файл eslint config необходимо добавить следующую строчку:
16
+
14
17
  ```Javascript
15
18
  module.exports = {
16
19
  extends: ["./node_modules/@labeg/code-style/.eslintrc.js"],
@@ -21,6 +24,7 @@ module.exports = {
21
24
  ```
22
25
 
23
26
  Версия для NextJS:
27
+
24
28
  ```Javascript
25
29
  module.exports = {
26
30
  extends: ["next/core-web-vitals", "./node_modules/@labeg/code-style/.eslintrc.js"],
@@ -31,8 +35,10 @@ module.exports = {
31
35
  ```
32
36
 
33
37
  ## Рекомендации
38
+
34
39
  ### Не заканчивать строку ничем
35
- Строка всегда должна заканчиваться знаком конца строки или оператором, например ; или +. Делается это для того что бы глядя всего на одну строку знать есть ли у команды продолжение на следующей строке или нет. Тем самым для понимания надо прочитать всего одну строчку вместо двух, что экономит время. А отсутствие ; в конце команды может привести к ошибкам исполнения.
40
+
41
+ Строка всегда должна заканчиваться знаком конца строки или оператором, например ; или +. Делается это для того чтобы глядя всего на одну строку знать есть ли у команды продолжение на следующей строке или нет. Тем самым для понимания надо прочитать всего одну строчку вместо двух, что экономит время. А отсутствие ; в конце команды может привести к ошибкам исполнения.
36
42
 
37
43
  ```Typescript
38
44
  /**
@@ -66,9 +72,10 @@ i=0
66
72
  ```
67
73
 
68
74
  ### Фигурный скобки в if
75
+
69
76
  Даже если после блока if идет всего 1 команда, фигурные скобки все равно ставить обязательно.
70
- Во первых, вы сэкономите время себе же в будующем когда понадобиться срочно дополнить условие.
71
- Во вторых, очень часто люди не замечают что строка относится к условию if и при рефакторинге или удалении строки забывают про if, из-за чего if начинает влиять на другую строчку кода.
77
+ Во-первых, вы сэкономите время себе же в будущем когда понадобиться срочно дополнить условие.
78
+ Во-вторых, очень часто люди не замечают что строка относится к условию if и при рефакторинге или удалении строки забывают про if, из-за чего if начинает влиять на другую строчку кода.
72
79
 
73
80
  ```Typescript
74
81
  // Плохо
@@ -85,7 +92,8 @@ if (n > 10) {
85
92
  ```
86
93
 
87
94
  ### Используйте двойные кавычки
88
- Изначально в более взрослых языках используются " для написания строк, в JS для более простого ескейпа было принято писать '. Так было проще для JS разработчиков. Но теперь существуют шаблонные строки которые справляются с этой задаче много лучше. К тому же коллегам с бекенда будет проще понимать ваш код в случае необходимости.
95
+
96
+ Изначально в более взрослых языках используются " для написания строк, в JS для более простого ескейпа было принято писать '. Так было проще для JS разработчиков. Но теперь существуют шаблонные строки которые справляются с этой задачей много лучше. К тому же коллегам с бекенда будет проще понимать ваш код в случае необходимости.
89
97
 
90
98
  ```Typescript
91
99
  const message = "булочек";
@@ -99,9 +107,10 @@ const data = `Отправляю "бабушке" ${count * 5} ${message}.`;
99
107
  ```
100
108
 
101
109
  ### Длина строки 120 символов и отступ 4 пробела
102
- У всех разработчиков разные мониторы, у кого то большие, у кого то маленькие, а кто то вообще через консоль работает. Поэтому оптимальным размером строки является 120 символов. А использование 4 проблема для отступа является оптимальным решением для определения уровня вложености. Некоторые предпочитают использовать 2 пробела для того что бы на одну строку больше влазило, но это является плохой практикой, т.к. увеличивает нагрузку на глаза при определении уровня вложености. Вместо того что бы впихивать на одну строчку больше кода, лучше использовать более удачное форматирование, например писать более простые функции и использовать "функциональный" стиль для цепочек методов объекта.
103
110
 
104
- Для вдохновления предлагаю взглянуть на [ядро Linux](https://github.com/torvalds/linux/blob/master/kernel/acct.c). Посмотрите как просто написано такой огромный и сложный продукт, а длина строки всего 80 символов.
111
+ У всех разработчиков разные мониторы, у кого то большие, у кого то маленькие, а кто-то вообще через консоль работает. Поэтому оптимальным размером строки является 120 символов. А использование 4 проблема для отступа является оптимальным решением для определения уровня вложенности. Некоторые предпочитают использовать 2 пробела для того чтобы на одну строку больше влазило, но это является плохой практикой, т.к. увеличивает нагрузку на глаза при определении уровня вложенности. Вместо того чтобы впихивать на одну строчку больше кода, лучше использовать более удачное форматирование, например писать более простые функции и использовать "функциональный" стиль для цепочек методов объекта.
112
+
113
+ Для вдохновения предлагаю взглянуть на [ядро Linux](https://github.com/torvalds/linux/blob/master/kernel/acct.c). Посмотрите как просто написано такой огромный и сложный продукт, а длина строки всего 80 символов.
105
114
 
106
115
  ```Typescript
107
116
  export class Tabs extends Base {
@@ -123,4 +132,4 @@ export class Tabs extends Base {
123
132
  }
124
133
  }
125
134
  }
126
- ```
135
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@labeg/code-style",
3
- "version": "4.0.5",
3
+ "version": "4.0.7",
4
4
  "scripts": {
5
5
  "prepublishOnly": "npm version patch"
6
6
  },
@@ -15,13 +15,13 @@
15
15
  },
16
16
  "homepage": "https://github.com/LabEG/code-style#readme",
17
17
  "dependencies": {
18
- "@typescript-eslint/eslint-plugin": "^6.14.0",
19
- "@typescript-eslint/parser": "^6.14.0",
20
- "eslint": "^8.56.0",
18
+ "@typescript-eslint/eslint-plugin": "^7.7.0",
19
+ "@typescript-eslint/parser": "^7.7.0",
20
+ "eslint": "^9.1.0",
21
21
  "eslint-plugin-jsx-a11y": "^6.8.0",
22
- "eslint-plugin-react": "^7.33.2",
22
+ "eslint-plugin-react": "^7.34.1",
23
23
  "eslint-plugin-react-hooks": "^4.6.0",
24
- "@stylistic/eslint-plugin": "^1.5.1",
25
- "@stylistic/eslint-plugin-migrate": "^1.5.1"
24
+ "@stylistic/eslint-plugin": "^1.7.2",
25
+ "@stylistic/eslint-plugin-migrate": "^1.7.2"
26
26
  }
27
27
  }