lifen-ruby-style 1.0.3 → 1.0.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.overcommit.yml +1 -0
- data/README.md +25 -11
- data/default_rubocop.yml +26 -8
- data/lib/lifen/ruby_style/version.rb +1 -1
- data/lifen-ruby-style.gemspec +1 -1
- data/style_guide.md +6 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e1f292884cf4a18086997f978e16a567ff9b4c092dd29b010296e5dfb0e72b5e
|
4
|
+
data.tar.gz: 682b8f45833ca1c66d651cd615cb4a554f47b62f68dd2092686fb9cb1da7a081
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2cbd1799ccf7e2a4d7e45bc60761c4287dcef0ecd25e7933cbc2d8165e6f9c8c630faa38c06a831e73bb39d2c412fcccae324cc38667428fdd5f6a86aa5ec0e0
|
7
|
+
data.tar.gz: 43879605b3abc391a3599bed6ac120e22b3c0401890ff10d48e150fa7a8eef7dd249d1f4d1a1f321a8d4fc9e1da1d08b91e6ef12c5449f15bc814e65d1b55e38
|
data/.overcommit.yml
CHANGED
data/README.md
CHANGED
@@ -20,6 +20,7 @@
|
|
20
20
|
- [Overcommit](#commandes-overcommit)
|
21
21
|
- [Utilisation d'une version locale](#utilisation-dune-version-locale)
|
22
22
|
- [Contributions](#contributions)
|
23
|
+
- [Publier une nouvelle version](#publier-une-nouvelle-version)
|
23
24
|
- [TODO](#todo)
|
24
25
|
- [Archives](#archives)
|
25
26
|
|
@@ -61,7 +62,7 @@ $ echo '--force-exclusion' > .rubocop
|
|
61
62
|
### 3. Config Overcommit
|
62
63
|
|
63
64
|
```bash
|
64
|
-
$ curl https://raw.githubusercontent.com/honestica/lifen-ruby-style/master/default_overcommit.yml > .
|
65
|
+
$ curl https://raw.githubusercontent.com/honestica/lifen-ruby-style/master/default_overcommit.yml > .overcommit.yml
|
65
66
|
```
|
66
67
|
|
67
68
|
### 4. Installer les dépendances
|
@@ -123,17 +124,20 @@ $ bundle exec overcommit --install
|
|
123
124
|
- Paramétrage recommandé pour l'auto-formatting :
|
124
125
|
|
125
126
|
```json
|
127
|
+
"editor.formatOnPaste": true, // global auto-format code when pasting
|
128
|
+
"editor.formatOnSave": true, // global auto-format code when saving
|
126
129
|
"[ruby]": {
|
127
|
-
"editor.
|
128
|
-
"editor.formatOnSave": true // auto-format ruby code when saving
|
130
|
+
"editor.formatOnSave": false // disable auto-format on save only for ruby files
|
129
131
|
},
|
130
132
|
```
|
131
133
|
|
132
134
|
ou
|
133
135
|
|
134
136
|
```json
|
135
|
-
"
|
136
|
-
|
137
|
+
"[ruby]": {
|
138
|
+
"editor.formatOnPaste": true, // auto-format ruby code when pasting
|
139
|
+
"editor.formatOnSave": false // auto-format ruby code when saving
|
140
|
+
},
|
137
141
|
```
|
138
142
|
|
139
143
|
### 3. Bonus - Autres extensions utiles :
|
@@ -267,6 +271,11 @@ https://github.com/dense-analysis/ale
|
|
267
271
|
- Si je veux bypasser les hooks (déconseillé) : `OVERCOMMIT_DISABLE=1 git commit ...`
|
268
272
|
- Je push (pas de hooks de pre-push paramétrés pour l'instant)
|
269
273
|
|
274
|
+
Attention :
|
275
|
+
|
276
|
+
- si vous faites "Ctrl+C" pendant qu'un hook overcommit tourne, overcommit fait un `git stash save` et vous pouvez retrouver ce qui a disparu avec `git stast list / show / pop`
|
277
|
+
- dans le même registre, ne faites pas de `watch .git/hooks/pre-commit`, si vous éditez vos fichiers dans une autre fenêtre, overcommit va régulièrement stasher vos modifs, et vous allez tourner en rond à éditer des fichiers qui changent sous vos pieds.
|
278
|
+
|
270
279
|
### Commandes Rubocop
|
271
280
|
|
272
281
|
Pour de la vérification :
|
@@ -360,14 +369,19 @@ Vous allez vouloir tester localement les modifications de règle de style que vo
|
|
360
369
|
|
361
370
|
**ATTENTION : La configuration d'overcommit n'est pas liée automatiquement au projet, il faut la copier/coller dans le projet cible après avoir effectué des changements.**
|
362
371
|
|
372
|
+
## Publier une nouvelle version
|
373
|
+
|
374
|
+
Suivre les instructions du [guide de release](RELEASING.md).
|
375
|
+
|
363
376
|
## TODO
|
364
377
|
|
365
|
-
[ ] Ajouter
|
366
|
-
[ ] Ajouter
|
367
|
-
[ ] Ajouter
|
368
|
-
[ ] Ajouter `
|
369
|
-
[ ] Ajouter `
|
370
|
-
[ ] Ajouter `
|
378
|
+
- [ ] Ajouter rubocop-daemon (arriver à faire une bonne intégration aux IDE)
|
379
|
+
- [ ] Ajouter le hook de pre-commit au CI
|
380
|
+
- [ ] Ajouter un hook de pre-push ?
|
381
|
+
- [ ] Ajouter `fasterer` si pertinent
|
382
|
+
- [ ] Ajouter `reek` si pertinent
|
383
|
+
- [ ] Ajouter `slim_lint` si pertinent
|
384
|
+
- [ ] Ajouter `scss` si pertinent
|
371
385
|
|
372
386
|
## Archives
|
373
387
|
|
data/default_rubocop.yml
CHANGED
@@ -5,6 +5,7 @@ require:
|
|
5
5
|
|
6
6
|
AllCops:
|
7
7
|
DisplayStyleGuide: true
|
8
|
+
NewCops: enable
|
8
9
|
TargetRubyVersion: 2.5
|
9
10
|
Exclude:
|
10
11
|
- "test/**/*.rb"
|
@@ -16,14 +17,6 @@ AllCops:
|
|
16
17
|
- "spec/rails_helper.rb"
|
17
18
|
- "node_modules/**/*"
|
18
19
|
|
19
|
-
# Waiting for default config
|
20
|
-
Style/HashEachMethods:
|
21
|
-
Enabled: true
|
22
|
-
Style/HashTransformKeys:
|
23
|
-
Enabled: true
|
24
|
-
Style/HashTransformValues:
|
25
|
-
Enabled: true
|
26
|
-
|
27
20
|
Layout/ArgumentAlignment:
|
28
21
|
EnforcedStyle: with_fixed_indentation
|
29
22
|
|
@@ -87,6 +80,10 @@ Metrics/PerceivedComplexity:
|
|
87
80
|
Naming/MemoizedInstanceVariableName:
|
88
81
|
EnforcedStyleForLeadingUnderscores: required
|
89
82
|
|
83
|
+
RSpec/DescribeClass:
|
84
|
+
Exclude:
|
85
|
+
- spec/lib/tasks/deployment/**/*
|
86
|
+
|
90
87
|
Style/BlockDelimiters:
|
91
88
|
EnforcedStyle: braces_for_chaining
|
92
89
|
|
@@ -96,6 +93,18 @@ Style/ClassAndModuleChildren:
|
|
96
93
|
Style/Documentation:
|
97
94
|
Enabled: false
|
98
95
|
|
96
|
+
Style/TrailingCommaInArguments:
|
97
|
+
Enabled: true
|
98
|
+
EnforcedStyleForMultiline: comma
|
99
|
+
|
100
|
+
Style/TrailingCommaInArrayLiteral:
|
101
|
+
Enabled: true
|
102
|
+
EnforcedStyleForMultiline: comma
|
103
|
+
|
104
|
+
Style/TrailingCommaInHashLiteral:
|
105
|
+
Enabled: true
|
106
|
+
EnforcedStyleForMultiline: comma
|
107
|
+
|
99
108
|
Style/IfUnlessModifier:
|
100
109
|
Enabled: true
|
101
110
|
AutoCorrect: false
|
@@ -132,15 +141,24 @@ RSpec/AnyInstance:
|
|
132
141
|
RSpec/DescribedClass:
|
133
142
|
EnforcedStyle: explicit
|
134
143
|
|
144
|
+
RSpec/EmptyExampleGroup:
|
145
|
+
Enabled: false
|
146
|
+
|
135
147
|
RSpec/ExampleLength:
|
136
148
|
Enabled: false
|
137
149
|
|
138
150
|
RSpec/HookArgument:
|
139
151
|
EnforcedStyle: each
|
140
152
|
|
153
|
+
RSpec/LetSetup:
|
154
|
+
Enabled: false
|
155
|
+
|
141
156
|
RSpec/MultipleExpectations:
|
142
157
|
Enabled: false
|
143
158
|
|
159
|
+
RSpec/MultipleMemoizedHelpers:
|
160
|
+
Enabled: false
|
161
|
+
|
144
162
|
RSpec/NestedGroups:
|
145
163
|
Max: 5
|
146
164
|
|
data/lifen-ruby-style.gemspec
CHANGED
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
|
|
30
30
|
spec.require_paths = ['lib']
|
31
31
|
|
32
32
|
spec.add_dependency 'overcommit'
|
33
|
-
spec.add_dependency 'rubocop', '~> 0.
|
33
|
+
spec.add_dependency 'rubocop', '~> 0.88'
|
34
34
|
spec.add_dependency 'rubocop-performance', '~> 1.5'
|
35
35
|
spec.add_dependency 'rubocop-rails', '~> 2.4'
|
36
36
|
spec.add_dependency 'rubocop-rspec', '~> 1.38'
|
data/style_guide.md
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: lifen-ruby-style
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.8
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Team Lifen
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-09-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: overcommit
|
@@ -30,14 +30,14 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: '0.
|
33
|
+
version: '0.88'
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '0.
|
40
|
+
version: '0.88'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: rubocop-performance
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|