README_CN.md

Nginx Formatter / Nginx 格式化工具

ENGLISH | 中文文档

一款 10MB 左右的，小巧、简洁的 Nginx 格式化工具，支持命令行、WebUI、Docker、x86、ARM、macOS、Linux。

程序下载

从发布页面下载适用于您系统和架构的二进制文件和压缩包。

如果使用 Docker，可以使用以下命令（DockerHub）：

docker pull soulteary/nginx-formatter:latest
docker pull soulteary/nginx-formatter:v1.1.1

程序使用

使用默认参数格式化当前目录中的所有的 Nginx 配置文件：

./nginx-formatter

通用玩法 (CLI & WebUI)

使用不同的缩进符号（可以使用空格、制表符、\s、\t、 ）和缩进量：

./nginx-formatter -indent=4 -char=" "

命令行用法（CLI）

格式化指定目录中的配置文件：

./nginx-formatter -input=./your-dir-path

在新目录中保存格式化后的配置文件：

./nginx-formatter -input=./your-dir-path -output=./your-output-dir

WebUI 用法

启动 WebUI 界面：

./nginx-formatter -web

指定服务端口：

./nginx-formatter -web -port=8123

Docker 用法

在 Docker 中使用和上面没有什么区别，比如我们启动一个在 Docker 中的 Web UI 格式化工具服务：

docker run --rm -it -p 8080:8080 soulteary/nginx-formatter:v1.1.1 -web

如果你希望格式化当前目录的配置，可以通过类似下面的命令，来使用 Docker 中的程序：

docker run --rm -it -v `pwd`:/app soulteary/nginx-formatter:v1.1.1 -input=/app

支持的完整参数列表

Nginx Formatter

Usage of ./nginx-formatter:
  -char  
    	Indent char, defualt:   (default " ")
  -indent int
    	Indent size, defualt: 2 (default 2)
  -input string
    	Input directory
  -output string
    	Output directory
  -port 8080
    	WebUI Port, defualt: 8080 (default 8080)
  -web false
    	Enable WebUI, defualt: false

鸣谢

格式化组件

• 2016/06/24 Slomkowski 使用 Python 创建了一个 nginx 配置文件美化器，在 [Apache-2.0 许可] 下发布。
  • https://github.com/1connect/nginx-config-formatter (https://github.com/slomkowski/nginx-config-formatter)
• 2016/08/24 Yosef 在 [Apache-2.0 许可] 下移植了 JavaScript beautifier。
  • https://github.com/vasilevich/nginxbeautifier
• 2023/04/18，soulteary 根据 [Apache-2.0 许可] 简化程序，修复错误，提高运行速度，并允许在 Golang 中运行。
  • https://github.com/soulteary/nginx-formatter

JavaScript 运行时组件：

• Go 中的 ECMAScript 5.1(+) 实现，在 [MIT 许可]下发布。
  • https://github.com/dop251/goja

网络组件

• Gin，HTTP Web 框架，在 [MIT 许可]下发布。
  • https://github.com/gin-gonic/gin
• Code Mirror, 浏览器内的编辑器，在 [MIT 许可]下发布。
  • https://github.com/codemirror/codemirror5