gen-linter-config 1.0.9

GenerateLinterConfig - 代码检查规则生成工具

gen-linter-config

A LLM-based linter configuration generate tool .

How to use

1. install:

pip install gen-linter-config

2. Configuring LLM: This project uses litellm to call large model in a unified format, so please make sure that you have configured your key as an environment variable and have sufficient token resources before using it.

3. Usage Example：

   gen-linter-config -t checkstyle --input "No more than 5 function parameters"
   gen-linter-config -t checkstyle --input rule.txt --out output.json
   gen-linter-config -t checkstyle --input "Wrap the code block in braces" --format json
   gen-linter-config --tool Cppcheck --model dashscope/qwen3-max --input "It is forbidden to use malloc functions that may return null pointers without checking."
   # Cppcheck does not apply to the attribute name system, so it will not actually return the content containing the attribute name.
   

Configure key as a system-level environment variable

Windows：Through the system property settings. Find system-properties, find advanced system settings-environment variable, and then create a new user variable with the variable named OPENAI_API_KEY and the value of the key in the user environment variable above.

Linux/macos：Set environment variables in the shell configuration file. Open the terminal and execute the instructions according to different shell:

# Bash
nano ~/.bashrc
# Zsh
nano ~/.zshrc
# Other shell may need to consult relevant documents.

Add in the configuration file:

export OPENAI_API_KEY=[Your OpenAI API key]

Then save and exit. Make the changes take effect:

# Bash
source ~/.bashrc
# Zsh
source ~/.zshrc
# 其它的shell可能需要查阅相关文档确定具体指令。          

Parameter Introduction

Parameter	introduce	must	default
-h, --help	show help message and exit	n	-
--tool, -t	Specify the code checking tool	y	-
--input, -i	File path or rule text	y	-
--model, -m	Specify the model to use	n	deepseek-reasoner
--out, -o	Output file path	n	-
--examples, -e	Sample text	n	-
--version, -v	show program's version number and exit	n	-

If you don't specify an output file, the output will directly printed in the console.

List of supported tools

Tool	Y/N
Checkstyle	Y
ESLint	Y
Biome	Y
ClangTidy	Y
CppCheck	Y
Flake8	Y
PMD	Y
Pylint	Y
Reek	Y
RuboCop	Y
Ruff	Y

Among them, Checkstyle and ESLint support a relatively perfect generation mechanism, while other tools do not. The configuration generation of more tools is still under development.