Giter VIP home page Giter VIP logo

devtools's Introduction

Інструменти розробника

Цей репозиторій - збірка скриптів та конфігураційних файлів, які допоможуть дотримуватись єдиного стилю написання коду для проектів на Node.js, прийнятого в команді.

1. Підключення до проекту #name=example

Підключення реалізовано за допомогою Git-підмодулів.

  • підключаємо підмодуль
[ $(git submodule | grep -c editor-config) -eq "0" ] && git submodule add https://master_www:[email protected]:4455/node/editor-config.git editor-config;
  • ініціюємо підмодуль
git submodule init && git submodule update
  • додаємо файли в .gitignore
[ $(grep -c editor-config .gitignore) -eq "0" ] && sed -i -e '$a\' .gitignore  && echo 'editor-config/*' >> .gitignore;

Однією командою

[ ! $(git submodule | grep -c editor-config) ] && git submodule add https://master_www:[email protected]:4455/node/editor-config.git editor-config;\
git submodule init && git submodule update;\
[ $(grep -c editor-config .gitignore) -eq "0" ] && sed -i -e '$a\' .gitignore  && echo 'editor-config/*' >> .gitignore;

2. Загальні інструменти

Для автомитизації процесу, в проекті використовуються git hooks, для роботи з ними використовується npm модуль husky

  • додаємо модуль
npm i -D husky
  • створюємо символічне посилання на конфіг
ln -s editor-config/.huskyrc

Однією командою

npm i -D husky; [ ! -h .huskyrc ] && ln -s editor-config/.huskyrc && git add .huckyrc

3. Автоматичне форматування коду

Для форматування коду використовується npm модуль prettier

  • додаємо модуль
npm i -D -E prettier && npm i -D pretty-quick
  • створюємо символічне посилання на конфіг
ln -s editor-config/.prettierrc

Однією командою

npm i -D -E prettier && npm i -D pretty-quick; [ ! -h .prettierrc ] && ln -s editor-config/.prettierrc && git add .prettierrc

Налаштовуємо IDE (не обов'язково)

4. Автоматичне створення тегів

Дотримуємось стандарту версіонування semver. При зміні версії в файлі package.json і подальшому коміті, автоматично буде створено гіт-тег з назвою версії, причому, якщо гілка, на якій змінено версію, відрізняється від master, створений тег буде мати наступний вигляд: x.x.x-branchName.

  • Якщо виконано інструкції з пунктів 1, 2, ця штука вже налаштована.

  • При пуші потрібно не забути позначити пункти Push Tags та Run Git Hooks

    Скрин с WebStorm

Аналіз коду

Будемо юзати eslint

Коміти, комітмеседжі

Будемо юзати commitizen

5. Все разом (простий і правильний шлях)

  • копіюємо команду:
[ ! $(git submodule | grep -c editor-config) ] && git submodule add https://master_www:[email protected]:4455/node/editor-config.git editor-config;\
git submodule init && git submodule update && sh editor-config/scripts/init.sh
  • заходимо в проект
  • запускаємо скопійовану команду
  • ?????
  • PROFIT

Корисні посилання

devtools's People

Contributors

samhaing avatar

Watchers

James Cloos avatar Elderov Ali avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.