eslint-config-gits 5.0.28 → 5.0.30
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/.gitlab-ci.yml +7 -1
- package/.renovaterc.json +7 -0
- package/CHANGELOG.md +14 -0
- package/README.md +1 -1
- package/STYLEGUIDE.md +61 -0
- package/package.json +27 -27
package/.gitlab-ci.yml
CHANGED
package/.renovaterc.json
ADDED
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
## [5.0.30](https://gitlab.com/geenen-it-systeme/eslint-preset/compare/v5.0.29...v5.0.30) (2024-11-20)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* eslint update ([5dccfa9](https://gitlab.com/geenen-it-systeme/eslint-preset/commit/5dccfa98900e842242026724666eedad68e2db02))
|
|
7
|
+
|
|
8
|
+
## [5.0.29](https://gitlab.com/geenen-it-systeme/eslint-preset/compare/v5.0.28...v5.0.29) (2024-11-18)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* Update dependencies ([db5c125](https://gitlab.com/geenen-it-systeme/eslint-preset/commit/db5c125b0297008e3976db69ffd60bc51a922bac))
|
|
14
|
+
|
|
1
15
|
## [5.0.28](https://gitlab.com/geenen-it-systeme/eslint-preset/compare/v5.0.27...v5.0.28) (2024-08-28)
|
|
2
16
|
|
|
3
17
|
|
package/README.md
CHANGED
package/STYLEGUIDE.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Geenen IT-Systeme Styleguide
|
|
2
|
+
|
|
3
|
+
Dieser Styleguide bildet eine Grundlage an Regeln, nach denen wir unseren Code designen und stylen.
|
|
4
|
+
|
|
5
|
+
## Entitäten
|
|
6
|
+
Entitäten sind bestehende Konzepte aus der realen Welt und dem Geschäftsfeld des Kunden, die in unsere Software abgebildet werden.
|
|
7
|
+
Sie sind allen Beteiligten des Projekts geläufig und können auch außerhalb unserer Software verstanden werden.
|
|
8
|
+
|
|
9
|
+
**Sie bilden damit die wichtigste Grundlage aller Design-Entscheidungen.**
|
|
10
|
+
|
|
11
|
+
_Beispiel:_
|
|
12
|
+
_In einem Online-Shop gibt es Kunden (`Customer`), die Produkte (`Product`) kaufen und dafür eine Rechnung (`Invoice`) bekommen._
|
|
13
|
+
|
|
14
|
+
In unserer Software werden Entitäten durch Tech-Stack-abhängige Konzepte dargestellt:
|
|
15
|
+
- In **PHP** und **Laravel** durch eine Klasse
|
|
16
|
+
```php
|
|
17
|
+
class User {}
|
|
18
|
+
```
|
|
19
|
+
- In **Typescript** durch ein Interface
|
|
20
|
+
```ts
|
|
21
|
+
interface User {}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Diese konkretesten Abbildungen von Entitäten in unserer Software, abhängig vom Tech-Stack, bekommen die englische Bezeichnung der Entität im Singular.
|
|
25
|
+
Alle anderen Bausteine der Anwendung werden mit Pre- oder Suffix von diesen Entitäten abgeleitet.
|
|
26
|
+
|
|
27
|
+
_Beispiel: Verschiedene User-Units in PHP_
|
|
28
|
+
```
|
|
29
|
+
- UserController.php
|
|
30
|
+
- UserRepository.php
|
|
31
|
+
```
|
|
32
|
+
_Beispiel: Verschiedene User-Units in TS/React_
|
|
33
|
+
```
|
|
34
|
+
- UserView.tsx
|
|
35
|
+
- Users.tsx
|
|
36
|
+
- user.schema.ts
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Benennungen
|
|
40
|
+
Konkrete Instanzen einer Entität (meistens Objekte) werden in Variablen mit dem selben Namen gespeichert.
|
|
41
|
+
|
|
42
|
+
_Beispiel: Entität in einer Variable speichern_
|
|
43
|
+
```ts
|
|
44
|
+
const user: User = {}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
_Beispiel: Entität als Parameter_
|
|
48
|
+
```ts
|
|
49
|
+
const foo: (user: User) => void = {}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Namenskollisionen
|
|
53
|
+
Sollte der Name eines anderen Bausteines mit dem einer Entität gleich sein, hat die Entität immer Priorität.
|
|
54
|
+
|
|
55
|
+
_Beispiel: Gleiche Entity und React Komponente_
|
|
56
|
+
```tsx
|
|
57
|
+
interface User {} // Name der Entität bleibt bestehen
|
|
58
|
+
|
|
59
|
+
const UserView: FC = () => {} // React Componente wird umbenannt in <ENTITY>View
|
|
60
|
+
```
|
|
61
|
+
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-config-gits",
|
|
3
|
-
"version": "5.0.
|
|
4
|
-
"description": "EsLint
|
|
3
|
+
"version": "5.0.30",
|
|
4
|
+
"description": "EsLint Preset for Geenen IT-Systeme",
|
|
5
5
|
"repository": "https://gitlab.com/geenen-it-systeme/eslint-preset",
|
|
6
6
|
"main": "index.mjs",
|
|
7
7
|
"scripts": {
|
|
@@ -14,32 +14,32 @@
|
|
|
14
14
|
"author": "",
|
|
15
15
|
"license": "ISC",
|
|
16
16
|
"peerDependencies": {
|
|
17
|
-
"@eslint/compat": "
|
|
18
|
-
"@typescript-eslint/parser": "
|
|
19
|
-
"eslint": "
|
|
20
|
-
"eslint-plugin-prettier": "
|
|
21
|
-
"eslint-plugin-react": "
|
|
22
|
-
"eslint-plugin-react-hooks": "
|
|
23
|
-
"globals": "
|
|
24
|
-
"prettier": "
|
|
25
|
-
"typescript-eslint": "
|
|
17
|
+
"@eslint/compat": "1.2.3",
|
|
18
|
+
"@typescript-eslint/parser": "8.15.0",
|
|
19
|
+
"eslint": "9.15.0",
|
|
20
|
+
"eslint-plugin-prettier": "5.2.1",
|
|
21
|
+
"eslint-plugin-react": "7.37.2",
|
|
22
|
+
"eslint-plugin-react-hooks": "5.1.0-rc-fb9a90fa48-20240614",
|
|
23
|
+
"globals": "15.12.0",
|
|
24
|
+
"prettier": "3.3.3",
|
|
25
|
+
"typescript-eslint": "8.15.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
|
-
"@eslint/compat": "
|
|
29
|
-
"@eslint/eslintrc": "
|
|
30
|
-
"@eslint/js": "
|
|
31
|
-
"@semantic-release/changelog": "
|
|
32
|
-
"@semantic-release/git": "
|
|
33
|
-
"@semantic-release/gitlab": "
|
|
34
|
-
"@typescript-eslint/eslint-plugin": "
|
|
35
|
-
"@typescript-eslint/parser": "
|
|
36
|
-
"eslint": "
|
|
37
|
-
"eslint-plugin-prettier": "
|
|
38
|
-
"eslint-plugin-react": "
|
|
39
|
-
"eslint-plugin-react-hooks": "
|
|
40
|
-
"globals": "
|
|
41
|
-
"prettier": "
|
|
42
|
-
"semantic-release": "
|
|
43
|
-
"typescript-eslint": "
|
|
28
|
+
"@eslint/compat": "1.2.3",
|
|
29
|
+
"@eslint/eslintrc": "3.2.0",
|
|
30
|
+
"@eslint/js": "9.15.0",
|
|
31
|
+
"@semantic-release/changelog": "6.0.3",
|
|
32
|
+
"@semantic-release/git": "10.0.1",
|
|
33
|
+
"@semantic-release/gitlab": "13.2.1",
|
|
34
|
+
"@typescript-eslint/eslint-plugin": "8.15.0",
|
|
35
|
+
"@typescript-eslint/parser": "8.15.0",
|
|
36
|
+
"eslint": "9.15.0",
|
|
37
|
+
"eslint-plugin-prettier": "5.2.1",
|
|
38
|
+
"eslint-plugin-react": "7.37.2",
|
|
39
|
+
"eslint-plugin-react-hooks": "5.1.0-rc-fb9a90fa48-20240614",
|
|
40
|
+
"globals": "15.12.0",
|
|
41
|
+
"prettier": "3.3.3",
|
|
42
|
+
"semantic-release": "24.2.0",
|
|
43
|
+
"typescript-eslint": "8.15.0"
|
|
44
44
|
}
|
|
45
45
|
}
|