Add SQL, tabular data and LaTeX/Typst ecosystem profiles

未关闭
#92 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
latex, python, sql
领域
testing, tooling

调研方向

Read the language profile implementation and the content detection work in #63, then inspect tests/test_ecosystem_contract.py and its existing fixtures. Add well-configured and bare fixtures for SQL, tabular data, LaTeX, and Typst, with profile rules matching the issue’s recognition patterns. Done when the contract tests cover both fixture types for each ecosystem and pass.

由索引模型根据 Issue 内容生成。

描述

Profiles

Smaller profiles, one module each, grouped here because each supplies only a few rules. Each can be split into its own issue when it is started.

Ecosystem Recognised by Rules
SQL / migrations *.sql under migrations/ / db/migrate/, flyway.conf, liquibase.properties, atlas.hcl, sqlfluff configuration code-formatting and compiler-warnings: sqlfluff (.sqlfluff, sqlfluff lint); new migration-safety: squawk or atlas migrate lint in CI
Tabular data datapackage.json, Table Schema files, dvc.yaml schema-validation: frictionless validate in CI; later large-files: big data files are in DVC or Git LFS, not committed directly
LaTeX *.tex with \documentclass, .latexmkrc tests-run: CI compiles the document (latexmk, xu-cheng/latex-action); compiler-warnings: chktex; code-formatting: latexindent; vcs-ignore: *.aux, *.log, *.synctex.gz, and the built PDF
Typst *.typ tests-run: typst compile in CI; code-formatting: typstyle

Content detection (#63) keeps a stray .sql or .tex file from making a project one of these.

Definition of done

As for language profiles: a well-configured and a bare fixture per ecosystem, held by tests/test_ecosystem_contract.py.

主要语言
Python
星标
4
派生
1
平均合并
10 小时 41 分钟
30 天内合并 PR
79

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

cpp-best-practices/project_validator 的其他 Issue

查看 cpp-best-practices/project_validator 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。