https://github.com/mysterywolf/formatting

formatter formatting

Last synced: about 2 months ago
JSON representation

源码格式自动化调整工具

README

# Formatting 源码格式自动化调整工具

### 如果喜欢请Star，这是对本开源项目最大的鼓励，谢谢
---------

本文件会自动递归遍历**指定文件夹**下的所有文件或者**指定的文件**（默认对`.c`/`.h`/`.cpp`/`.hpp`，也可以改成你想要的文件类型）进行扫描：

- 将源文件编码统一为UTF-8

- 将TAB键替换为4空格

- 将每行末尾多余的空格删除，并统一换行符为'\n'
- 将RT-Thread版权信息的截至年份修改至今年(若文件不涉及此问题，程序会自动忽略)
- 将上海睿赛德版权信息的截至年份修改至今年(若文件不涉及此问题，程序会自动忽略)

## 安装依赖软件包

```shell
pip install -r requirements.txt
```

本软件为python3源码

## 使用方法

### 方法一

直接运行脚本,根据提示信息,输入要扫描的**文件夹或者文件名**即可。

``` shell
▸ python formatting.py
Please enter work path or file to format: test_dir
```

### 方法二

可以直接在命令行参数中指定需要格式化的**文件夹或者文件名**

``` shell
▸ python formatting.py [dir/file_name]
```

> [] 表示内容是可选的

### 教学视频

> https://www.bilibili.com/video/BV1XN411Q7n3

### 注意

建议git的换行转换设置为：

``` shell
git config --global core.autocrlf input
git config --global core.safecrlf false
git config --global core.filemode false
```

## 使用协议

本软件为MIT协议，可以自由免费使用，无论是个人目的还是商业目的，但是发现本脚本有任何问题，请提PR协助修复。