xly README
简介(Introduction)
这是一个用于测试和演示的VS Code扩展项目,旨在提供一系列开发辅助工具,涵盖代码格式化、项目初始化、版本控制、开发辅助和包管理等功能。
- 开发环境:Windows 10, VS Code
- 技术栈:TypeScript, JavaScript, Rust, Dart, C++, Jest测试框架
- 使用环境:VS Code
- 代码架构:模块化设计,命令按功能分类
Features
代码格式化与修复
- JS/TS系列:自动修复代码风格问题(如缺少花括号)并格式化代码 (
Refine(Format) Js,Jsx,Ts,Tsx,Json,Css,Scss Files By Npm Command ) - 需先安装npm install --save-dev prettier
- Rust系列:自动修复和格式化 Rust 代码,支持递归查找项目 (
Refine(Fix/Format) Rust Code ) - 对当前项目先后执行rust的clippy和format命令
- Dart系列:自动修复和格式化 Dart 代码,支持递归查找项目 (
Refine(Fix/Format) Dart Code ) - 对当前项目先后执行Dart的fix --apply和format命令
项目初始化与配置
- C++/Qt项目:
- 创建基于 CMake 的终端/GUI项目,支持32/64位 (
Init C++/Qt Project )
- 添加类文件 (
Add A Cpp Class ) - 创建一个C++类
- 添加配置文件:
- 调试和智能感知配置 (
Add C++/Qt Debug, Intellisense Files For Current Project ) - 给当前C++项目配置专属debug和intellisense文件
- 完整配置 (
Add C++/Qt Debug, Intellisense And CMakeList Files For Current Project ) - 给当前项目添加debug、intellisense和CMakeList文件
- CMakeList配置 (
Add CMakeList For Current Project ) - 给当前项目配置CMakeList文件
- 支持一键调试(F5)和构建(Ctrl+Shift+B)
- Python项目:快速创建 Python 脚本项目 (
Init Python Project ) - 创建一个python hello world项目
- Rust项目:
- 生成可执行文件或库项目及调试配置 (
Init RUST Project )
- 添加配置文件 (
Add Rust Config File For Current Project ) - 给当前Rust项目配置专属debug和intellisense文件
- 工具链管理:
- 添加Nightly工具链 (
Add Nightly Toolchain For Current Project ) - 给当前项目添加nightly工具链
- 添加Android工具链 (
Add Android Toolchain For Current Project ) - 给当前项目添加安卓工具链
- 设置默认工具链 (
Set Default Toolchain (Stable Or Nightly) ) - 设置默认的工具链(稳定、夜间)
- 测试与依赖管理:
- 运行测试 (
Run Cargo Test For Rust Code ) - 对当前项目先后执行cargo test
- 刷新依赖 (
Fresh/Update The Rust Project's Cargo Modules ) - 刷新当前项目的cargo模块
- 发布管理 (
Publish The Rust Crate To Crates.io ) - 发布当前crate到crates.io
- Flutter项目:
- 改善Flutter项目配置 (
Refine Flutter Project Pubspec.yaml ) - 自动更新pubspec.yaml文件的SDK版本和常用依赖项
- 打开Flutter Debug文件夹 (
Open Flutter Debug Folder ) - 快速打开任何Dart/Flutter项目的Windows平台Debug构建目录,自动检测项目类型并提供个性化反馈
- Flutter Rust Bridge项目:
- 创建Flutter UI + Rust API的跨平台项目 (
Init Flutter Rust Bridge Project )
- 完善FRB项目自动初始化流程并引入单元测试以保障初始化稳定性。
- 为已存在的FRB项目添加配置文件 (
Add Config Files To Existing FRB Project ) - 可为现有项目添加codecov.yml、.github文件夹、justfile等配置
- FRB项目版本管理 (
Update FRB Project Version ) - 同步更新Flutter和Rust配置文件中的版本号
- FRB版本更新 (
Update Flutter Rust Bridge Version ) - 更新项目中的Flutter Rust Bridge依赖版本
- 重置初始化状态 (
Reset FRB Project Initialization State ) - 重置FRB项目的初始化状态,允许重新初始化
Git 版本控制
- 仓库初始化与远程配置:
- 初始化未记录的本地项目 (
Init Unrecorded Local Project ) - 自动初始化本地Git仓库、创建GitHub远程仓库并推送,支持私有/公开选择
- 关联远程仓库 (
Link/Init Local Project With Git Repository ) - 将本地项目强推到指定的远程仓库
- 分支管理:
- 创建并重置分支 (
Add/Create A New Branch And Reset To A Certain Commit ) - 创建新分支并重置到指定提交
- 批量删除分支 (
Delete/Remove Branches ) - 支持删除多个本地和远程分支
- 提交管理:
- 撤销最近提交 (
Reset/Revert Last Commit ) - 重置上一次提交
- 强制更新到远程最新版本 (
Force Update Local To Remote Latest ) - 会丢失本地更改
- 同步操作:
- 上游同步 (
Fetch And Reset To Remote Branch ) - 获取并将上游代码重置到本地指定分支
- 版本控制信息:
- 清理版本控制信息 (
Delete/Remove Local Project Git Repository Info ) - 完全删除当前项目的.git版本控制信息
开发辅助工具
- 文档助手:
- 清理非法字符 (
Replace Invalid Char With Space ) - 将非法字符串用指定字符代替
- 生成文件夹树状结构 (
Generate Folder Tree Structure ) - 右键文件夹菜单
- 生成项目大纲 (
Generate Project Outline Markdown ) - 生成项目树状结构并保存到project_outline.md文件
- Flutter工具:
- 包版本更新 (
Update All Flutter Package To Main Versions ) - 将所有flutter的包升级到主要版本
- 应用图标生成 (
Generate Dart/Flutter App Icons ) - 为Dart/Flutter应用生成各平台图标(使用xly包的简化图标生成功能,支持文件选择器,自动检测主项目和example项目)(智能检测xly包,优先使用xly的简化图标生成功能)
- 应用重命名 (
Rename Dart/Flutter App Name ) - 重命名Dart/Flutter应用名称
- VSCode调试配置 (
Add VSCode Config For Existing Dart/Flutter Project ) - 为已存在的Dart/Flutter/FRB项目添加VSCode调试配置文件
- AI辅助工具:
- 诊断信息收集 (
Copy All Diagnostic Messages In Project ) - 复制项目中所有诊断信息(错误/警告/信息/提示)到剪贴板,便于AI分析修复
- 终端内容收集 (
Copy All Content From a Terminal ) - 复制某个终端中的所有信息到剪贴板,便于AI分析修复
- VSCode工具:
- 缓存清理 (
Clear VSCode Service Worker Cache ) - 清除VSCode Service Worker缓存以解决WebView预览问题
- 新标签页打开 (
Open In New Tab ) - 在新标签页中打开文件
- 浮动窗口 (
Show Floating Window ) - 显示浮动窗口
包管理与发布
- Rust:
- 发布 crate (
Publish The Rust Crate To Crates.io ) - 发布当前crate到crates.io
- 刷新依赖 (
Fresh/Update The Rust Project's Cargo Modules ) - 刷新当前项目的cargo模块
- Dart/Flutter:
- 发布包 (
Publish Dart Package ) - 发布Dart包到pub.dev
- 更新依赖 (
Update All Flutter Package To Main Versions ) - 将所有flutter的包升级到主要版本
- 前端:
- 发布VSCode扩展 (
Publish VSCode Extension ) - 发布VSCode扩展到市场
TODO
笔记(Note)
- Jest测试框架:
- Jest已集成到本项目中,用于单元测试。
- 配置文件位于:
jest.config.js
- 测试文件通常位于
src/test/ 目录下,例如:src/test/flutter_rust_bridge.test.ts 。
- 运行所有测试:在终端执行
npm test 或 npx jest 。
copilot参考
Requirements
C++程序需要先安装微软的C++、cmake的vscode拓展。
| |