跳转到主要内容

像魔法一样检查dotenv文件!

项目描述

dotenv-linter

wemake.services Build Status codecov Github Action Python Version Documentation Status


简单的.env文件检查器。

dotenv-logo

虽然.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

还有更多!您可以在我们的文档中找到违规行为的完整列表

Pre-commit钩子

dotenv-linter也可以用作pre-commit钩子。为此,将以下内容添加到项目根目录下的.pre-commit-config.yaml文件中

repos:
  - repo: https://github.com/wemake-services/dotenv-linter
    rev: 0.2.0  # Use the ref you want to point at
    hooks:
      - id: dotenv-linter

有关pre-commit工具本身的更详细说明,请参阅其网站

免费

特别感谢 Ignacio Toledo 为本项目设计了一个出色的标志。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

dotenv_linter-0.5.0.tar.gz (15.3 kB 查看哈希值)

上传时间 源代码

构建分发

dotenv_linter-0.5.0-py3-none-any.whl (21.8 kB 查看哈希值)

上传时间 Python 3

支持