“Rate-Your-Code”

“Rate-Your-Code”

An interesting little project that evaluates your project’s code and file naming conventions, scoring it across various aspects.

📣 前言

[!IMPORTANT]

本项目想法来源于fuck-u-code,本项目仅仅是其的python版本实现(自认为相较于golang语言更方便使用)

仅需电脑中有python环境即可检测自己项目的评分,方便、已用、有趣。


📍 特点

  1. 后端语言支持:C++ Python Java C# Golang
  2. 前端框架支持:Vue React HTML + CSS + JS;
  3. 评分机制:D2S 评分,一眼顶针;
  4. Markdown输出:简易报告,却能深度解析你的代码问题;
  5. 高雅语言:像品酒一般品鉴你的代码,高雅人士必备。

💻 使用

[!NOTE]

建议在python = 3.10.9环境中运行,因为我装的是3.10.9,理论上其它也可行 UwU

  1. 将项目clone到本地:

    git clone https://github.com/Haruko386-UnOffical/Rate-Your-Code.git
    cd Rate-Your-Code
    
  2. 在命令行中输入:

    Python main.py --project_path path-to-your-project --language your-language
    
    • --project_path :即将评分的项目所在路径,为必填项。
    • --language :主要评分的语言,若指定语言(例如Python),则只会评价所有指定语言的代码(只评价.py文件);不指定则评判项目中的所有受支持的文件。
  3. 获取你的评分:

    你的总分数会在命令行中显示,具体的细节文档保存至CODE_RATING.md中。


🎫 License

[!CAUTION]

本项目基于 MIT License,欢迎PR以及汇报bug