ОБЪЯВЛЕНИЕ ДОТЕНВ-ЛИНТЕР: инструмент для линта ваших файлов .env

Я рад объявить простой, но очень полезный инструмент для линта вашего .env файлы.

Wemake-Services/Dotenv-Linter

☺️. Отвлечение файлов dotenv, как очарование!

Простой Линтер для .env файлы.

В то время как .env.env. Файлы очень просты, требуется сохранить их последовательным, этот инструмент предлагает широкий спектр правил согласованности и лучших практик.

И он отлично интегрируется для любого существующего рабочего процесса.

Читать Объявление пост Отказ

Установка и использование

pip install dotenv-linter

А затем запустить его:

dotenv-linter .env .env.template

Посмотреть Использование Раздел для получения дополнительной информации.

Примеры

Есть много вещей, которые могут пойти не так в вашем .env Файлы:

# Next line has leading space which will be removed:
 SPACED=
# Equal signs should not be spaced:
KEY = VALUE
# Quotes won't be preserved after parsing, do not use them:
SECRET="my value"

# Beware of duplicate keys!
SECRET=Already defined ;(

# Respect the convention, use `UPPER_CASE`:
kebab-case-name=1
snake_case_name=2

И многое другое! Вы можете найти Полный список нарушений в наших документах Отказ

Задний план

Как часть нашего «не виноват, но исправляя» корпоративную культуру, мы строим множество инструментов, которые мешают нам сделать одни и те же ошибки снова и снова.

Дотенв-Линтер является одним из этих инструментов.

Некоторое время назад у нас было несколько проблем с .env Файлы:

Некоторые разработчики использовали Constant_case Для имени переменных и некоторые разработчики используются Snake_Case для этого. Пока это не техническая проблема, но не очень практично смешивать эти два случая, а затем подумать: в каком случае я использовал для этой конкретной переменной? Консистенция важна!
У нас также была проблема с цитатами и дополнительными пробелами. Некоторые разработчики использовали Ключ = значение и некоторые использованные КЛЮЧ Хотя на самом деле эти два примера будут решаться в точно так же – мы предпочитаем иметь один– и желательно только один –obvious способ сделать это. Итак, мы сейчас придерживаемся Ключ = значение нотация
У нас также когда-то был дубликат ключ, который разрушил мой день. Я провел несколько часов Отладка моего приложения из-за этой простой проблемы. Это был поворотный момент для меня И я решил: давайте автоматизировать это!

Установка

Вы можете установить его через Пип (или любой другой аналогичный инструмент):

$ pip install dotenv-linter

Почему пипс ? Потому что Python присутствует почти на всех настройках Linux. И мы стараемся сделать этот инструмент как можно возможным портативным.

использование

Использование действительно просто:

$ dotenv-linter path/to/your/.env even/multiple/files/are/fine/.env

Реальные примеры

Если вы заинтересованы в том, как мы используем его реальные жизненные приложения, вы можете взглянуть на (и даже попробовать!) наше Джанго Шаблон Отказ Вот …| линия это вызывает это.

У нас также есть полный список Правила льмина в наших документах Проверьте это.

Вывод

Я надеюсь, что этот простой инструмент сэкономит вам некоторое время, сделать ваш проект более последовательным, и ваша жизнь немного лучше. Добавь меня на github Чтобы оставаться в курсе инструментов, которые я строю!

Оригинал: “https://dev.to/wemake-services/announcing-dotenv-linter-a-tool-to-lint-your-env-files-3m1g”