Mastering config/default.yml for RuboCop

Slide 1

Slide 1 text

5IV RuboCopೖ໳ ۜ࠲3BJMT ˏϦϯΫΞϯυϞνϕʔγϣϯ Mastering config/default.yml ,PJDIJ*50&4. *OD

Slide 2

Slide 2 text

!LPJD w 3VCP$PQ$PNNJUUFS w "30SBDMFFOIBODFE BEBQUFS$PNNJUUFS w $PNNVOJUZ.BOBHFS BU&4. *OD

Slide 3

Slide 3 text

&4. *OD

Slide 4

Slide 4 text

ւ֎3VCZΧϯϑΝϨϯε΁ͷ౿Έग़͠ํ LPJD

Slide 5

Slide 5 text

3VCZॲཧܥʹΠγϡʔϨϙʔτͯ͠ΈΑ͏ LPJD

Slide 6

Slide 6 text

044ίϛϡχςΟͱͷڞੜΛࢧԉ Support coexistence with OSS community

Slide 7

Slide 7 text

ୡਓϓϩάϥϚʔ΁ͷجૅٕज़ ςεςΟϯά %FWFMPQFS5FTUJOH ࣗಈԽ 1SPKFDU"VUPNBUJPO όʔδϣϯ؅ཧ 7FSTJPO$POUSPM

Slide 8

Slide 8 text

ୡਓϓϩάϥϚʔ΁ͷجૅٕज़ ςεςΟϯά %FWFMPQFS5FTUJOH ࣗಈԽ 1SPKFDU"VUPNBUJPO όʔδϣϯ؅ཧ 7FSTJPO$POUSPM

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

#VOEMFS 1SZ 34QFD 3VCP$PQ CZFCVH 3VCZ,BJHJ %3&$0.͞Μϒʔεʹͯ

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

͸͡Ίʹ w ൃද࣌఺ͷ3VCP$PQΛ ϕʔεʹ͍ͯ͠·͢ w 3VCP$PQͷ࢖͍ํͱΧελϚΠ ζͷجૅ͕਎ʹͭ͘͜ͱΛ໨ඪʹ͠ ͍ͯ·͢ w ίΞϢʔβʔ޲͚ʹۙະདྷͷ 3VCP$PQͷల๬Λ͍ࠞͥͯ·͢

Slide 13

Slide 13 text

.BTUFSJOHDPOpHEFGBVMUZNM w 3VCP$PQͷجૅઃఆ͸3VCP$PQ ϦϙδτϦͰ؅ཧ͞Ε͍ͯΔ DPOpHEFGBVMUZNMͰ͢ w DPOpHEFGBVMUZNMͱαϯϓϧ ίʔυ͕ಡΊΕ͹ΧελϚΠζͷί π͕෼͔ͬͯ͘Δͱࢥ͍·͢ͷͰਵ ॴʹҾ༻ͯ͠·͢

Slide 14

Slide 14 text

EPDTSVCPDPQPSH

Slide 15

Slide 15 text

0GpDJBMNBOVBM

Slide 16

Slide 16 text

)FSF

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

% rubocop Mastering config/default.yml

Slide 20

Slide 20 text

"OFYBNQMFDPEF def badName if something test end end

Slide 21

Slide 21 text

࣮ߦํ๏ DEQBUIUPSFQP SVCPDPQ w SVCPDPQίϚϯυͰ࣮ߦͰ͖Δ

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

%FQBSU/BNF$PQ/BNF%FTDSJQUJPO

Slide 24

Slide 24 text

-BZPVU%FQBSUNFOU "MJHO"SSBZ ܯ࡯ॺͷϝλϑΝʔ "MJHO)BTI &MTF"MJHONFOU &NQUZ-JOFT &OE"MJHONFOU &YUSB4QBDJOH *OEFOU"SSBZ -JOU%FQBSUNFOU %VQMJDBUF.FUIPET %VQMJDBUFE,FZ &MTF"MJHONFOU 4DSJQU1FSNJTTJPO 6OJpFE*OUFHFS 6OSFBDIBCMF$PEF 6OMFTT"TTJHONFOU .FUSJDT%FQBSUNFOU "CD4J[F #MPDL-FOHUI #MPDL/FTUJOH $MBTT-FOHUI -JOF-FOHUI .FUIPE-FOHUI 1BSBNFUFS-JTUT ʜ

Slide 25

Slide 25 text

ର৅ϑΝΠϧ w σϑΥϧτͰ֓Ͷͷ3VCZϑΝΠϧΛΧόʔ IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM-- ڞ௨ઃఆ

Slide 26

Slide 26 text

w 4UZMF4USJOH-JUFSBMTจࣈྻ͕γϯάϧΫΥʔ τ͔μϒϧΫΥʔτ͔ͱ͍͏ɺϓϩδΣΫτ΍ݸ ਓʹΑΔ΋ͷ w 4UZMF'SP[FO4USJOH-JUFSBM$PNNFOU GTUSJOHMJUFSBM͕ه͞Ε͍ͯΔ͔ͱ͍͏কདྷͷ 3VCZ΁ͷඋ͑ʹΑΔ΋ͷ w -JOU6SJ&TDBQF6OFTDBQF3VCZຊମ͕ඇ ਪ঑ͷܯࠂΛ͢ΔΑ͏ͳ΋ͷ ෦ॺͱ$PQͷྫ

Slide 27

Slide 27 text

Slide 28

Slide 28 text

จԽ΍޷Έʹ͋ΘͤΔ

Slide 29

Slide 29 text

wॻ͖ํͷબ୒ࢶ͕ෆ۞ଷఱ ʹͳΓ͏ΔελΠϧ w3VCP$PQͷσϑΥϧτͱ  จԽ͕͍͋ͬͯΕ͹ྑ͠ɺͦ͏ Ͱͳ͚Ε͹ΧελϚΠζͰ͖Δ wυΩϡϝϯτϑΝʔετͰΧε λϚΠζʹ͍ͭͯݟͯΈΑ͏ γϯάϧΫΥʔτ೿ʁμϒϧΫΥʔτ೿ʁ

Slide 30

Slide 30 text

)FSF

Slide 31

Slide 31 text

w σϑΥϧτͷৼΔ෣͍͸3VCP$PQϦϙδτϦ ͷDPOpHEFGBVMUZNMʹ४ڌ͢Δ &OGPSDFE4UZMF IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM- )FSF

Slide 32

Slide 32 text

% rubocop --init Mastering config/default.yml

Slide 33

Slide 33 text

QSPKFDUSPPU ɹSVCPDPQZNM )FSF

Slide 34

Slide 34 text

w SVCPDPQZNMͰσϑΥϧτͷߏ੒Λมߋ͢Δ ͜ͱ͕Ͱ͖Δ w SVCPDPQ͔Β͸SVCPDPQJOJU ͰSVCPDPQZNMΛੜ੒Ͱ͖Δ ϧʔϧͷΧελϚΠζ SVCPDPQJOJU

Slide 35

Slide 35 text

w ΋͠จࣈྻΛμϒϧΫΥʔτͰ౷Ұ͍ͨ͠৔߹ ͸SVCPDPQZNMͷ্ॻ͖Ͱ࣮ݱͰ͖Δ ΧελϚΠζ͢Δ SVCPDPQZNM 4UZMF4USJOH-JUFSBMT &OGPSDFE4UZMFEPVCMF@RVPUFT w $PQ໊ΛΩʔʹΧελϚΠζ͍ͨ͠ &OGPSDFE4UZMFΛࢦఆ͢Δ

Slide 36

Slide 36 text

3VCZ4UZMF(VJEF Mastering config/default.yml

Slide 37

Slide 37 text

w 3VCP$PQ͸5IF3VCZ4UZMFHVJEFͷ࣮૷ ͱͳΔͨΊɺ Ұ෦ େݩͷσϑΥϧτϧʔϧ͸ͦ ͪΒ 3VCZ4UZMF(VJEF IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM-- )FSF

Slide 38

Slide 38 text

IUUQTHJUIVCDPNSVCPDPQIRSVCZTUZMFHVJEFCMPCNBTUFS3&"%.&NE

Slide 39

Slide 39 text

IUUQTHJUIVCDPNSVCPDPQIRSVCZTUZMFHVJEFCMPCNBTUFS3&"%.&NE

Slide 40

Slide 40 text

&OBCMFE %JTBCMFE

Slide 41

Slide 41 text

w $PQ͝ͱʹ༗ޮԽແޮԽ͕Ͱ͖Δ w ໌ࣔతʹ&OBCMFEUSVFͱ͢Δ͜ͱͰσϑΥ ϧτແޮͷ΋ͷΛ༗ޮʹɺ&OBCMFEGBMTF͢ Δ͜ͱͰσϑΥϧτ༗ޮͷ΋ͷΛແޮʹͰ͖Δ w σϑΥϧτ͸$PQຖʹUSVFGBMTFࢦఆ͞ΕͯΔ &OBCMFE $PQ୯Ґ IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM- )FSF

Slide 42

Slide 42 text

w ෦ॺ୯ҐͰ༗ޮԽແޮԽ͢Δ͜ͱ΋Մೳ w 3BJMT෦ॺ͸σϑΥϧτͰແޮʹͳ͍ͬͯΔ w 3VCP$PQ࣌఺͸A&OBCMFEUSVFA΍ ASVCPDPQSBJMTAίϚϯυͳͲࢦఆ͕ඞཁ w 3VCP$PQͰࢦఆํ๏มߋͷ༧ఆ ޙड़ &OBCMFE ෦ॺ୯Ґ IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM- )FSF

Slide 43

Slide 43 text

w ҰׅͰ͢΂ͯͷ$PQΛແޮʹͰ͖Δ w ରরతʹ&OBCMFE#Z%FGBVMU΋͋Δ %JTBCMFE#Z%FGBVMU IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM- )FSF

Slide 44

Slide 44 text

w ͍ͪͲશͯΛແޮʹͨ͠͏͑Ͱ࢖͍͍ͨ$PQ͚ͩ Λ&OBMCFEUSVFʹ͢Δઓུ͕ͱΒΕ͍ͯΔ ࣄྫͱͯ͠SBJMTSBJMTϦϙδτϦ͕͋Δ %JTBCMFE#Z%FGBVMU IUUQTHJUIVCDPNSBJMTSBJMTCMPCWSDSVCPDPQZNM )FSF

Slide 45

Slide 45 text

5BSHFU3VCZ7FSTJPO 3VCP$PQTVQQPSUT3VCZPSIJHIFS

Slide 46

Slide 46 text

w ࢦఆͷͳ͍σϑΥϧτ͸3VCP$PQ͸ w Ͳͷ3VCZόʔδϣϯͰ੩తղੳΛߦ͏͔ࢦఆՄ 5BSHFU3VCZ7FSTJPO IUUQTHJUIVCDPNSBJMTSBJMTCMPCWSDSVCPDPQZNM )FSF

Slide 47

Slide 47 text

SVCPDPQZNMͷ5BSHFU3VCZ7FSTJPO ͷ஋ SVCZWFSTJPOͷ஋ (FNpMFMPDLʹه͞Εͨ3VCZόʔδϣϯ ͦΕΒʹઃఆ͕ͳ͍৔߹͸3VCP$PQͰσ ϑΥϧτͷ3VCZόʔδϣϯͱͳ͍ͬͯΔ 5BSHFU3VCZ7FSTJPO IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWDPOpHEFGBVMUZNM- 5BSHFU3VCZ7FSTJPO͸ҎԼͷॱʹࢀরͯ͠ ݟ͔ͭͬͨ΋ͷͰܾఆ͞ΕΔ

Slide 48

Slide 48 text

% rubocop --auto-correct Mastering config/default.yml

Slide 49

Slide 49 text

w SVCPDPQBVUPDPSSFDUͰϧʔϧʹԊͬͨ ࣗಈमਖ਼͕Ͱ͖Δ ίʔυͷࣗಈमਖ਼ SVCPDPQBVUPDPSSFDU

Slide 50

Slide 50 text

"OFYBNQMFDPEF def badName if something test end end

Slide 51

Slide 51 text

SVCPDPQBVUPDPSSFDU % rubocop -a # -a is a alias for --auto-correct Inspecting 1 file C Offenses: example.rb:1:1: C: [Corrected] Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true. def badName ^ example.rb:2:3: C: [Corrected] Style/IfUnlessModifier: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||. if something ^^ example.rb:3:5: C: Naming/MethodName: Use snake_case for method names. def badName ^^^^^^^ 1 file inspected, 3 offenses detected, 2 offenses corrected

Slide 52

Slide 52 text

HJUEJ⒎ % git diff diff --git a/example.rb b/example.rb index 82446de..f57e73e 100644 --- a/example.rb +++ b/example.rb @@ -1,5 +1,5 @@ +# frozen_string_literal: true + def badName - if something - test - end + test if something end

Slide 53

Slide 53 text

w BVUPDPSSFDUJPOΛαϙʔτ͍ͯ͠ΔDPQ ͱαϙʔτ͍ͯ͠ͳ͍DPQ͕͋Δ ίʔυͷࣗಈमਖ਼ )FSF

Slide 54

Slide 54 text

w 3VCZͰϥϯλΠϜ৘ใΛಘΔ͜ͱ ͳ͘੩తղੳ͚ͩͰl҆શʹzݩͷ ίʔυͱ౳Ձͷ࣮ߦ͕Ͱ͖Δ͔ʁ w ݩͷৼΔ෣͍Λҡ࣋ͯࣗ͠ಈमਖ਼͕ Ͱ͖͍ͯΔ͔෼͔Βͳ͍ w 8IBUXPVMEZPVEP ίʔυͷࣗಈमਖ਼

Slide 55

Slide 55 text

w <ॏཁ>όʔδϣϯ؅ཧͰࣗಈमਖ਼લ ͷίʔυʹ໭ͤΔ͜ͱ w <ॏཁ>·ͣ͸ςετίʔυͰৼΔ෣ ͍ΛकΒΕ͍ͯΔ͜ͱ ࣗಈमਖ਼ͷమଇ

Slide 56

Slide 56 text

ܧଓతσϦόϦʔͷͨΊͷجૅٕज़ ςεςΟϯά %FWFMPQFS5FTUJOH ࣗಈԽ 1SPKFDU"VUPNBUJPO όʔδϣϯ؅ཧ 7FSTJPO$POUSPM

Slide 57

Slide 57 text

ܧଓతσϦόϦʔͷͨΊͷجૅٕज़ ςεςΟϯά %FWFMPQFS5FTUJOH ࣗಈԽ 1SPKFDU"VUPNBUJPO όʔδϣϯ؅ཧ 7FSTJPO$POUSPM

Slide 58

Slide 58 text

'PSMBSHFQSPKFDU

Slide 59

Slide 59 text

6/*9ͱ͍͏ߟ͑ํ IUUQTXXXBNB[PODPKQEQ

Slide 60

Slide 60 text

% rubocop —safe % rubocop --safe-auto-correct Mastering config/default.yml

Slide 61

Slide 61 text

w 3VCP$PQ ͔ΒTBGF ΦϓγϣϯͱTBGFBVUP DPSSFDUΦϓγϣϯ͕ಋೖ͞Εͨ w ϧʔϧʹԊͬͨίʔυΛϧʔϧʹԊͬ ͍ͯͳ͍ͱใࠂ͞ΕΔِཅੑ΍ɺط ଘͷৼΔ෣͍Λഁյ͢Δࣗಈमਖ਼Λ ݮΒ͢͜ͱΛओମͱ͍ͯ͠Δ ҆શͳݕ஌ͱࣗಈमਖ਼

Slide 62

Slide 62 text

w BVUPDPSSFDUJPOʹΑΔࣗಈमਖ਼͕҆શͰ ͳ͍΋ͷ͸TBGFBVUPDPSSFDUJPOͰআ֎ ͢Δ 6OTBGFͳमਖ਼Λআ֎͢Δ )FSF

Slide 63

Slide 63 text

% rubocop --auto-gen-config Mastering config/default.yml

Slide 64

Slide 64 text

w SVCPDPQίϚϯυͰݟ͔ͭͬͨPGGFOTF Λআ֎͢ΔSVCPDPQ@UPEPZNMͷੜ੒ ͱߋ৽Λߦ͏ w SVCPDPQ@UPEPZNM ͸SVCPDPQZNMͷܧঝݩʹͳΔ ൜ࡑͷݕ஌ PGGFOTF ͷอཹ SVCPDPQZNM JOIFSJU@GSPNSVCPDPQ@UPEPZNM

Slide 65

Slide 65 text

3VCP$PQࣗମͷSVCPDPQ@UPEPZNM

Slide 66

Slide 66 text

3VCP$PQࣗମͷSVCPDPQ@UPEPZNM &OBCMFEGBMTF &OBCMFEGBMTF

Slide 67

Slide 67 text

3VCP$PQࣗମͷSVCPDPQ@UPEPZNM 3FMBYUISFTIPME 3FMBYUISFTIPME 3FMBYUISFTIPME 3FMBYUISFTIPME

Slide 68

Slide 68 text

% rubocop --parallel Mastering config/default.yml

Slide 69

Slide 69 text

w QPDLF͞Μ͕࣮૷ͯ͘͠Εͨ3VCP$PQ ͷฒྻ࣮ߦΦϓγϣϯ w ಺෦తʹ͸QBSBMMFMHFNΛ࢖͍ͬͯ Δ w BVUPDPSSFDUͳͲෳ਺ϓϩηε͔Βಉ ҰϑΝΠϧΛߋ৽͢ΔΑ͏ͳΦϓγϣϯ ͱ͸ڞଘͰ͖ͳ͍ w <*.0>কདྷతʹσϑΥϧτʹͰ͖Δ΋ͷ ͸͓͚ͯ͠Δͱྑͦ͞͏ͱ͸ࢥ͍ͬͯΔ 3VCP$PQͷฒྻ࣮ߦ

Slide 70

Slide 70 text

5PXBSET 3VCP$PQ Mastering config/default.yml

Slide 71

Slide 71 text

w "EEJOHTVQQPSUGPSNVMUJQMF FOGPSDFETUZMFT w &YUSBDU3BJMT$PQTJOB TFQBSBUF w *OUSPEVDFOFXDPQTXJUIB TQFDJBMTUBUVT JOTUFBEPG FOBCMFEEJTBCMFE 3VCP$PQҎ߱

Slide 72

Slide 72 text

SVCPDPQIRSVCPDPQ -BZPVU"MJHO)BTIBMMPXUXPPQUJPOT

Slide 73

Slide 73 text

No content

Slide 74

Slide 74 text

&OGPSDFE4UZMFLFZ

Slide 75

Slide 75 text

&OGPSDFE4UZMFLFZ &OGPSDFE4UZMFUBCMF

Slide 76

Slide 76 text

w αϙʔτ͞Ε͍ͯΔෳ਺ͷελΠϧ͕ڐՄ͞ΕΔ ΦϓγϣϯͰ3VCP$PQ͔Β༗ޮ "MMPX.VMUJQMF4UZMFT IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQQVMMpMFTEJ⒎FC )FSF

Slide 77

Slide 77 text

SVCPDPQIRSVCPDPQ &YUSBDU3BJMT$PQTJOBTFQBSBUF

Slide 78

Slide 78 text

No content

Slide 79

Slide 79 text

w 3BJMT෦ॺ͸3VCP$PQͰ࡟আ༧ఆ w AHFNSVCPDPQSBJMTAʹ੾Γग़͍ͯ͠Δ w ݱࡏ3BJMTDPQTΛ࢖͏࣌͸ASVCPDPQ3 SBJMTAΦϓγϣϯ͕ඞཁ͕ͩɺͦΕΒΛഇࢭ ͯ͠SFRVJSFSVCPDPQSBJMTΛ͍ͯ͠Δ͔ Ͳ͏͔ʹมߋ͢Δ༧ఆ w 3VCP$PQࣗମ͸ϑϨʔϜϫʔΫϥΠϒϥϦ ϥϯλΠϜʹґଘͤͣ3VCZʹϑΥʔΧε͍ͨ͠ 3BJMTDPQTΛநग़͢Δ

Slide 80

Slide 80 text

w SFRVJSFSVCPDPQQFSGPSNBODFͱಉ༷ ʹɺ3BJMTDPQTΛ࢖͏৔߹͸Πϯετʔϧޙʹ SFRVJSFSVCPDPQSBJMTͱهड़͢Δɺ࢖Θͳ ͚Ε͹هड़͠ͳ͍ SFRVJSF IUUQTHJUIVCDPNSVCPDPQIRSVCPDPQCMPCWSVCPDPQZNM SEQBSUZDPQTΛ௥ՃͰ͖Δ

Slide 81

Slide 81 text

SVCPDPQIRSVCPDPQ *OUSPEVDFOFXDPQTXJUIBTQFDJBMTUBUVT JOTUFBEPGFOBCMFEEJTBCMFE

Slide 82

Slide 82 text

No content

Slide 83

Slide 83 text

w طଘͷFOBCMFEEJTBCMFE΁ ͷ֦ுͱղऍͰ͖Δ w ৽ͨʹ/FX ͋Δ͍͸OJM Λ༻ҙ ͯ͠ɺͦͷ஋ͷ৔߹͸৽ͨͳ$PQ Λ࢖͏͔Ϣʔβʔʹ༗ޮແޮΛΏ ͩͶΔܯࠂΛදࣔ͢Δ 5-%3

Slide 84

Slide 84 text

w ΞοϓάϨʔυ࣌ʹ໰୊ʹͳΔͷ͸ރ Ε͍ͯͳ͍৽͍͠$PQͷέʔε͕ଟ ͍ ϦάϨογϣϯΑΓͪ͜Β͕ଟ͍ w ϝλσʔλͷ7FSTJPO"EEFEɺ͋ Δ͍͸&OBCMFEͷ/FXΛݩʹͯ͠ ࠷৽ͷόʔδϣϯͰ௥Ճ͞Εͨ$PQ Λআ֎͢Ε͹ޡݕ஌ΛݮΒͤͦ͏ *.0ΞοϓάϨʔυ΁ͷ҆৺ͷ޲্

Slide 85

Slide 85 text

w ݱঢ়ͷ3VCP$PQͰແޮʹ͍ͨ͠ $PQ͸Enabled: falseͱͯ͠ ରॲͰ͖Δ͕ɺԿ͔ͷҙਤ͕͋ͬͯ EJTBCMFEʹͨ͠ͷ͔ɺόʔδϣ ϯΞοϓ࣌ͷރΕ͍ͯͳ͍$PQͩ ͔Βແޮʹ͍ͯ͠Δͷ͔ͷঢ়ଶ۠ผ ͕͔ͭͳ͍ ৽ͨͳϥϕϦϯά

Slide 86

Slide 86 text

Finally…

Slide 87

Slide 87 text

ࠔͬͨ࣌ͷಓ͠Δ΂ w SVCPDPQPSHͷϚχϡΞϧΛಡΉ w ίϯϑΟάϨʔγϣϯͷৄࡉʹ͍ͭͯ͸ɺ ϦϙδτϦͷDPOpHEFGBVMUZNM͕ ۙಓͳͷ͕ݱঢ় w IUUQTHJUIVCDPNSVCPDPQ IRSVCPDPQCMPCNBTUFS DPOpHEFGBVMUZNM w ஍Ҭ3VCZίϛΟχςΟͳͲʹإΛग़͠ ͯΈΔ