Як поділитися налаштуваннями стилю коду між розробниками в IntelliJ

Я хотів би, щоб усі розробники моєї команди використовували однакові налаштування стилю коду за замовчуванням. Ми всі використовуємо IntelliJ 11+ як наш IDE, і ми використовуємо git як нашу систему управління джерелами.

Який найпростіший спосіб переконатися, що всі вони використовують однакові налаштування? Я думав, що буде спосіб перевірити налаштування стилю в проект і редактори автоматично їх виявити, але, схоже, це не так.

PS. Я не проти, якщо розробники свідомо замінюють деякі налаштування за замовчуванням своїми власними уподобаннями, але я хочу переконатись, що всі ми принаймні починаємо з загального набору налаштувань за замовчуванням.

Стиль коду можна скопіювати до проекту та зберегти .idea/codeStylesдля спільного використання через контроль версій :

Копіювати до проекту Натисніть цю кнопку, щоб створити копію поточної глобальної схеми до рівня проекту. Після створення копії IntelliJ IDEA пропонує перейти на цю нову схему на рівні проекту.

Функція сховища налаштувань була представлена ​​на IntelliJ IDEA 2016 .

Цей параметр допомагає нам обмінюватися налаштуваннями IDE між різними комп’ютерами, включаючи налаштування спільного доступу між розробниками.

Налаштування зберігаються у сховищі Git, наприклад на GitHub або Bitbucket.

Щоб налаштувати репозиторій Git, нам слід встановити URL-адресу за допомогою пункту меню Репозиторій налаштувань .

Розробник може завантажувати віддалені налаштування, перезаписувати віддалені налаштування або об’єднувати локальні налаштування з віддаленими.

Структура сховища Git з налаштуваннями:

Я використовував особистий маркер доступу для автентифікації GitHub.

Більше інформації:

• Сховище налаштувань
• Створення особистого маркера доступу для командного рядка

Я зіткнувся з цим довго після факту, але думав, що поділюсь, якщо хтось зіткнеться з цим. Додайте до свого .gitignore наступне

# IDE - IntelliJ
/.idea/*
# Keep the code styles.
!/.idea/codeStyles
/.idea/codeStyles/*
!/.idea/codeStyles/Project.xml
!/.idea/codeStyles/codeStyleConfig.xml
# Keep the inspection levels
!/.idea/inspectionProfiles
/.idea/inspectionProfiles/*
!/.idea/inspectionProfiles/Project_Default.xml

І звичайно, переконайтесь, що ваш .gitignore також має! перед нею, щоб ці зміни поглибилися.

В основному, рекурсивний вигляд gitignore трохи хиткий, тому нижче ігнорується вміст каталогу, за винятком підкаталогу, а потім ігнорується вміст цього підкаталогу, за винятком файлів, які ми хочемо.

codeStyleConfig дозволяє використовувати налаштування проекту, сам файл проекту - це ваші фактичні стилі коду, і я включив Project_Default, оскільки він містить рівні попередження, які ви, мабуть, хочете, якщо ви все одно виконуєте роботу зі стилем коду.

Ви можете створити файл .editorconfig у своєму проекті (і ним можна керувати на рівні каталогу). Більше інформації на https://www.jetbrains.com/help/idea/configuring-code-style.html#editorconfig та https://editorconfig.org/

За допомогою цього підходу Ви можете зберігати всі свої налаштування стилю коду в одному файлі, і це не обмежується лише IJ.