Entry point for everything Meg…

# MegaLinter 配置指南（Python + JavaScript + Markdown）

一、前提条件

• 仓库已有 Python / JavaScript 代码及 Markdown 文档
• 建议使用 GitHub Actions（MegaLinter 官方支持最好）

二、创建工作流文件

在仓库中新建 .github/workflows/megalinter.yml，核心内容：

```yaml

name: MegaLinter

on:

push:

branches: [main]

pull_request:

branches: [main]

jobs:

megalinter:

runs-on: ubuntu-latest

steps:

• uses: actions/checkout@v4
• uses: oxsecurity/megalinter@v8

env:

# 只启用需要的语言和 linter

ENABLE_LINTERS: PYTHON_PYLINT,JAVASCRIPT_ES,MARKDOWN_MARKDOWNLINT

APPLY_FIXES: none

REPORT_OUTPUT_FOLDER: megalinter-reports

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# 上传报告为 Artifacts，方便下载查看

• uses: actions/upload-artifact@v4

if: always()

with:

name: megalinter-reports

path: megalinter-reports

```

三、配置说明

• ENABLE_LINTERS：白名单模式，只跑 ESLint（JAVASCRIPT_ES）、Pylint（PYTHON_PYLINT）、markdownlint（MARKDOWN_MARKDOWNLINT）
• APPLY_FIXES：设为 none 表示只检查不自动修复；可改为 all 让 MegaLinter 自动修复并提交
• 报告输出：MegaLinter 默认生成控制台摘要 + HTML/文本报告，存于 megalinter-reports 目录

四、补充项目级配置（可选）

• 根目录新建 .mega-linter.yml，可精细化控制排除路径：

```yaml

EXCLUDED_DIRECTORIES: ["node_modules", "dist", ".venv"]

SHOW_ELAPSED_TIME: true

```

• ESLint：确保项目有 eslint.config.js 或 .eslintrc.*，否则会使用 MegaLinter 内置默认规则
• Pylint：可添加 .pylintrc 自定义规则
• markdownlint：可添加 .markdownlint.json，例如 {"line-length": 120} 放宽行宽限制

五、验证与查看报告

1. Push 代码到仓库，进入 GitHub 仓库的 Actions 页签

2. 点击对应运行记录，查看 MegaLinter 日志中的检查摘要

3. 运行结束后，在 Artifacts 区域下载 `meg