SublimeJsPrettier 项目教程

SublimeJsPrettier 项目教程

SublimeJsPrettierJsPrettier is a Sublime Text Plug-in for Prettier, the opinionated code formatter.项目地址:https://gitcode.com/gh_mirrors/su/SublimeJsPrettier

1. 项目的目录结构及介绍

SublimeJsPrettier 是一个用于 Sublime Text 的 Prettier 插件。以下是该项目的目录结构及其介绍：

SublimeJsPrettier/
├── .gitignore
├── LICENSE
├── README.md
├── jsprettier-commands.sublime-commands
├── jsprettier-sublime.py
├── jsprettier.js
├── jsprettier.sublime-settings
├── node_bridge.py
├── package.json
└── yarn.lock

• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• jsprettier-commands.sublime-commands: 定义插件的命令。
• jsprettier-sublime.py: 插件的主要 Python 脚本。
• jsprettier.js: 与 Prettier 交互的 JavaScript 文件。
• jsprettier.sublime-settings: 插件的配置文件。
• node_bridge.py: 用于与 Node.js 交互的 Python 脚本。
• package.json: Node.js 项目的配置文件。
• yarn.lock: Yarn 包管理器的锁定文件。

2. 项目的启动文件介绍

SublimeJsPrettier 的启动文件是 jsprettier-sublime.py。这个文件包含了插件的主要逻辑和初始化代码。以下是该文件的主要功能：

• 初始化插件: 加载必要的配置和命令。
• 与 Prettier 交互: 通过 node_bridge.py 调用 Node.js 环境中的 Prettier。
• 处理命令: 定义和处理 Sublime Text 中的命令。

3. 项目的配置文件介绍

SublimeJsPrettier 的配置文件是 jsprettier.sublime-settings。这个文件定义了插件的各种设置选项。以下是一些常见的配置项：

• prettier_cli_path: Prettier 可执行文件的路径。
• auto_format_on_save: 是否在保存文件时自动格式化代码。
• allow_inline_formatting: 是否允许内联格式化。
• custom_file_extensions: 自定义文件扩展名。
• max_file_size_limit: 文件大小的限制。

这些配置项可以通过 Sublime Text 的设置界面进行修改，也可以直接编辑 jsprettier.sublime-settings 文件。

---

以上是 SublimeJsPrettier 项目的详细教程，希望对你有所帮助。

SublimeJsPrettierJsPrettier is a Sublime Text Plug-in for Prettier, the opinionated code formatter.项目地址:https://gitcode.com/gh_mirrors/su/SublimeJsPrettier