Одржавајте свој код чистим са лепшим

Форматирање кода делује као тривијалан предмет, али то је нешто што може утицати на квалитет и исправност вашег кода, како се контролише верзија и како сарађујете са другима. Међутим, ако не желите да се запетљате у детаље о томе где иде свака последња заграда, покушајте да проблем препустите алату отвореног кода, Преттиер.

Стварање форматирања

Тимови за развој софтвера изгубили су безброј сати током историје расправљајући се о максималној дужини линије или на коју линију треба да иде заграда. Шта год да кажу личне преференције, већина људи се слаже барем у једном: форматирање кода мора бити доследно у читавом пројекту.

Преттиер је алат дизајниран да то постигне. Дајте му неки код и он ће вам вратити исти код, форматиран на доследан начин. Преттиер има интеграцију уређивача текста, алат за командну линију и демо на мрежи.

Говорећи прави језик

Пре свега, желећете да знате да ли је Преттиер компатибилан са језиком или језицима са којима обично радите. Преттиер је тренутно усредсређен на основни скуп језика углавном посвећен фронт-енд веб развоју, укључујући:

• ЈаваСцрипт
• ХТМЛ
• ЦСС
• Сасс
• Маркдовн
• ИАМЛ

Такође постоји отворена подршка за додатне језике путем додатака.

Испробајте Лепше користећи Интернет игралиште

Пре него што и покушате да инсталирате Преттиер, можда бисте желели да се пријавите паркић. Помоћу веб интерфејса можете налепити неки пример кода и посматрати како ће га Преттиер трансформисати. Ово је сјајан начин да стекнете утисак о томе шта алат заправо ради, али такође може да делује као ваш примарни метод за коришћење Преттиер-а, ако су ваши захтеви лакши.

По дефаулту, игралиште би требало да изгледа као две основне табле за уређивање текста, једна на левој страни за ваш унос, а друга на десној страни која приказује Преттиеров излаз. У почетку ћете видети неки узорак кода, али све то можете једноставно уклонити и налепити у свој.

На пример, покушајте да унесете следећи ЈаваСцрипт:

(функција ()
{
виндов.алерт ('ок')
}())

Лепша би требало да је претвори у:

(функција () {
виндов.алерт ("ок");
})();

Приметите, подразумевано промене које Преттиер уводи укључују:

• Претварање низа са једним наводником у двонаведене
• Додавање тачака и тачака
• Претварање увлака у два размака

У доњем левом углу налази се дугме које вам омогућава да видите опције. У претходном примеру, покушајте да прилагодите ширину језичка, пребацујући --један наводник застава под Заједнички, или пребацивање - не-полу застава под ЈаваСцрипт.

Конфигурисање опција

Лепша је сама себе описала као „самопоуздану“, намерни избор дизајна који значи да се контрола специфичности жртвује због једноставности и доследности. Дизајниран је за вас да поставите, а затим заборавите, а не да будете заокупљени свим последњим детаљима форматирања кода. (Пробајте алтернативу са много прецизнијом контролом над сваким последњим детаљем обликовања еслинт.)

Међутим, аутори такође препознају да неке одлуке имају функционални утицај, осим како изгледа код. Неке опције - укључујући неке и за старе верзије - остају, па бисте барем требали разумети шта раде, чак и ако користите Преттиер у подразумеваном стању.

Најбољи начин управљања Лепше опције је да их сачувате у конфигурационој датотеци. Постоји много начина да се ово организује, али започните стварањем датотеке са именом .преттиеррц.јсон у вашем локалном директоријуму пројеката. Може да садржи било коју од подржаних опција у стандардном ЈСОН објекту, нпр.

{
"табВидтх": 8
}

Преттиер ће прочитати исту конфигурациону датотеку без обзира да ли је покрећете путем командне линије или подржаног уређивача текста.

Употреба предива или нпм, инсталација треба да буде једноставна. За предиво:

$ предиво глобално додајте лепше

А за нпм:

$ нпм инсталл --глобал лепша

Када глобално инсталирате Преттиер, требало би да можете да куцате:

$ лепша

Подразумевано ћете добити екран са текстом помоћи који ће потврдити да је алат инсталиран и да ради исправно.

Чишћење датотеке

Да бисте поново форматирали датотеку, користите наредбу сличну:

$ преттиер --врите филенаме.јс

Ово ће преписати оригиналну датотеку, што је често најприкладнији приступ. Алтернативно, можда бисте само желели да лепше делује на сваку датотеку у пројекту:

$ лепша --пиши.

Преттиер ће се покретати кроз све датотеке у тренутном директоријуму, форматирајући све оне које препознаје.

Резултат такође можете исписати на стандардни излаз, уместо да мењате оригиналну датотеку, што вам омогућава да излаз сачувате у другу датотеку или да га преусмерите негде другде:

$ лепши тест.јс> тест2.јс

Провера датотеке

Да бисте Преттиер извештавали о чистоћи вашег кода без стварних промена, користите --проверавати застава са једним именом датотеке или са више њих:

$ лепша - чек.

Добићете линију резултата за сваку датотеку која се не подудара са очекиваним форматом, према Преттиеровој конфигурацији:

Провера форматирања ...
[упозорити] .преттиеррц
[упозорити] .преттиеррц.јсон
[упозорити] Проблеми са стилом кода пронађени у горњим датотекама. Заборавили сте да водите Преттиер?

Опције командне линије

Преттиер-ове стандардне опције су доступне као опције командне линије, ако су вам потребне. Ево примера како --један наводник заставица утиче на излаз:

$ лепша тмп.јс
пример функције () {
цонсоле.лог ("здраво, свете");
}
$ лепше --једноструке цитате тмп.јс
пример функције () {
цонсоле.лог ('здраво, свет');
}

Добијање помоћи

Алат за командну линију пружа информативну помоћ за било коју опцију путем --помоћ застава:

$ лепша - помоћна заостала зарез
--траилинг-цомма 
Штампајте зарезе у заостатку кад год је то могуће у више редова.
Важеће опције:
ес5 Зарез у завоју ако је важећи у ЕС5 (објекти, низови итд.)
нема Нема зареза.
све пратеће зарезе где год је то могуће (укључујући аргументе функције).
Подразумевано: ес5

Коришћење уређивача текста

Када инсталирате Преттиер, можете га користити у разним сценаријима, у зависности од тога који скуп алата већ користите. Шансе су да користите уређивач текста. Лепша има везове за већину популарних, па ево како да поставите три од њих:

Узвишени текст

ЈсПреттиер је додатак за Сублиме Тект који чини Преттиер доступним у едитору. Иако постоји неколико различитих начина инсталирања ЈсПреттиер-а, препоручујемо употребу методе контроле пакета. Већ ћете морати да инсталирате Преттиер, а затим отворите командну палету Сублиме Тект и одаберите „Цонтрол Пацкаге: Инсталл Пацкаге“:

Затим потражите „јспреттиер“ и кликните да бисте га инсталирали:

Једном када је ЈсПреттиер инсталиран, можете десним тастером миша кликнути на било коју отворену датотеку да бисте је форматирали. Такође можете подесити вредност ауто_формат_он_саве до истинито у подешавањима ЈсПреттиера, што ће резултирати тиме да ЈсПреттиер аутоматски очисти све компатибилне датотеке када их сачувате у Сублиме Тект.

Атом

Инсталација за Атом је врло слична узвишеном тексту: за инсталацију једноставно користите уграђени менаџер пакета лепши-атом:

Једном инсталирана употреба је позната: пречица или ставка менија вам омогућава да форматирате датотеку на захтев, док поставка Атом омогућава аутоматско покретање програма Преттиер кад год је датотека сачувана.

Вим

Вим је врло моћан уређивач заснован на командној линији који није погодан за почетнике. Привлачење лепшег рада са вимом је прикладно компликовано, али то је још увек само неколико корака:

мкдир -п ~ / .вим / пацк / плугинс / старт
гит клон https://github.com/prettier/vim-prettier \
~ / .вим / пацк / плугинс / старт / вим-преттиер

Гит је вероватно најлакши начин за преузимање потребних датотека, али било који начин да вим-лепши уђе у тај почетни директоријум треба да ради посао.

Једном инсталиран, Преттиер ће се аутоматски покренути када се датотека сачува у ви. Такође се може покренути ручно у било које време путем Лепше наредба:

Што би требало резултирати очишћеном датотеком:

Интегришите „Лепше“ у свој пројекат

Коришћење програма за обликовање кода као што је Преттиер може вам помоћи да одржавате базу кодова која је лакша за читање. Такође може помоћи да се заобиђу расправе о томе који одређени стил користити приликом кодирања - само препустите те одлуке Преттиеру!

Коначно, гит кука се може поставити како би се осигурало да се код увек очисти када је додељен спремишту вашег пројекта. Појединачни програмери могу слободно форматирати свој код како год желе, али централна копија ће увек бити чиста и доследна.

нано вс. Вим: Упоредни најбољи уређивачи текста на терминалу

Тражите терминални уређивач текста за Линук? Главни избор је између Вима и нано-а! Ево како се упоређују.

О аутору