tm1-prettier
一个用于 TM1/C1 语言代码开发的 VS Code 扩展插件,提供代码格式化、函数提示、语法高亮等功能。
兼容性
- TM1 版本:V10.9.2+
- VS Code 版本:^1.108.1
功能特性
代码处理
- 代码格式化 - 自动格式化 TM1/C1 代码
- 语法检查 - 检查代码语法错误
- 文件推送 - 将文件推送到 TM1 服务器
- 同步执行 - 同步执行 TM1 代码
- 异步执行 - 异步执行 TM1 代码
- 日志下载 - 下载执行日志
编辑辅助
- 函数提示 - TM1 函数自动补全与说明
- 语法高亮 - 专为 TM1 语言设计的语法高亮主题
- 文件图标 - 支持 TM1 相关文件的自定义图标
支持的文件类型
.tm1 - TM1 数据文件
.pro - TM1 过程文件
.ti - TM1 导入文件
.rule - TM1 规则文件
.t1 - TM1 兼容文件
安装
从源码安装
# 克隆项目
git clone https://github.com/puboop/tm1-prettier.git
# 安装依赖
pnpm install
# 编译项目
pnpm run compile
# 打包扩展
vsce package
开发模式
# 启动调试
pnpm run watch
使用方法
右键菜单命令
在编辑器或文件资源管理器中右键点击 TM1 文件,可使用以下命令:
| 命令 |
说明 |
| 语法检查 |
检查当前文件的语法错误 |
| 文件推送 |
将文件推送到 TM1 服务器 |
| 同步执行 |
同步方式执行代码 |
| 异步执行 |
异步方式执行代码 |
| 日志下载 |
下载执行日志 |
配置选项
| 选项 |
类型 |
默认值 |
说明 |
tm1.completion.enableFunctionHint |
boolean |
true |
启用 TM1 函数自动提示功能 |
tm1.completion.matchCase |
boolean |
false |
函数提示是否区分大小写 |
项目结构
tm1-prettier/
├── src/ # 源代码目录
│ ├── api/ # API 调用模块
│ ├── expandCode/ # 代码扩展功能
│ ├── formatCode/ # 代码格式化模块
│ ├── providerCode/ # 代码提供者
│ ├── publicCommands/ # 公共命令
│ ├── test/ # 测试文件
│ ├── types/ # 类型定义
│ ├── utils/ # 工具函数
│ └── extension.ts # 插件入口
├── syntaxes/ # 语法定义
│ ├── tm1.tmLanguage.json
│ └── tm1-functions.json
├── themes/ # 主题配置
│ ├── tm1-syntax-theme.json
│ └── tm1-icon-theme.json
├── icons/ # 图标资源
├── images/ # 截图资源
├── scripts/ # 构建脚本
└── package.json # 项目配置
技术栈
- 语言: TypeScript
- 框架: VS Code Extension API
- 包管理: pnpm
- 测试: @vscode/test-electron
开发指南
环境要求
- Node.js 22.x
- pnpm 8.x+
- VS Code 1.108.1+
常用命令
# 安装依赖
pnpm install
# 编译
pnpm run compile
# 监听模式
pnpm run watch
# 代码检查
pnpm run lint
# 运行测试
pnpm run test
# 打包扩展
vsce package
更新日志
详见 CHANGELOG.md
贡献
欢迎提交 Issue 和 Pull Request!
许可证
MIT License
联系方式
- 作者:white
- GitHub:https://github.com/puboop/tm1-prettier
| |