Mastering config/default.yml for RuboCop

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

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

&4. *OD

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

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

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

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

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

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

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

EPDTSVCPDPQPSH

0GpDJBMNBOVBM

% rubocop Mastering config/default.yml

"OFYBNQMFDPEF def badName if something test end end

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

%FQBSU/BNF$PQ/BNF%FTDSJQUJPO

-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 ʜ

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

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

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

จԽ΍޷Έʹ͋ΘͤΔ

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

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

% rubocop --init Mastering config/default.yml

QSPKFDUSPPU ɹSVCPDPQZNM )FSF

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

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

3VCZ4UZMF(VJEF Mastering config/default.yml

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

IUUQTHJUIVCDPNSVCPDPQIRSVCZTUZMFHVJEFCMPCNBTUFS3&"%.&NE

&OBCMFE %JTBCMFE

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

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

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

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

5BSHFU3VCZ7FSTJPO 3VCP$PQTVQQPSUT3VCZPSIJHIFS

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

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

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

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

"OFYBNQMFDPEF def badName if something test end end

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

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

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

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

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

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

'PSMBSHFQSPKFDU

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

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

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

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

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

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

3VCP$PQࣗମͷSVCPDPQ@UPEPZNM

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

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

% rubocop --parallel Mastering config/default.yml

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

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

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

SVCPDPQIRSVCPDPQ -BZPVU"MJHO)BTIBMMPXUXPPQUJPOT

&OGPSDFE4UZMFLFZ

&OGPSDFE4UZMFLFZ &OGPSDFE4UZMFUBCMF

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

SVCPDPQIRSVCPDPQ &YUSBDU3BJMT$PQTJOBTFQBSBUF

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

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

SVCPDPQIRSVCPDPQ *OUSPEVDFOFXDPQTXJUIBTQFDJBMTUBUVT JOTUFBEPGFOBCMFEEJTBCMFE

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

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

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

Finally…

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

"EWBODFE5BML IUUQTSVCZLBJHJPSHQSFTFOUBUJPOTLPJDIUNM

Happy your culture!

Mastering config/default.yml for RuboCop

Mastering config/default.yml for RuboCop

More Decks by Koichi ITO

Other Decks in Programming

Featured

Transcript