0

0

Sublime构建基于意图的API(Intent-based API)_让用户声明“什么”而非“如何”

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-24 14:01:25

|

383人浏览过

|

来源于php中文网

原创

Sublime Text 本身不原生支持意图式 API,但可通过插件封装实现:定义高层语义命令(如 mark_function_as_reviewed)、基于LSP的上下文感知、声明式配置(JSON/YAML规则)、intent-aware快捷键与动态命令面板入口,使用户专注“做什么”而非“怎么做”。

sublime构建基于意图的api(intent-based api)_让用户声明“什么”而非“如何”

Sublime Text 本身不原生支持“基于意图的 API”(Intent-based API),它提供的是一套面向操作的插件接口(如 sublime_pluginView.run_command() 等),开发者需明确指定“如何做”——比如调用哪个命令、在什么位置插入文本、如何遍历 region。但你可以通过封装和抽象,在插件层面构建出接近“声明‘什么’而非‘如何’”的体验。

用高层语义封装底层命令

意图的本质是隐藏实现细节,暴露业务语义。例如,用户想“标记当前函数为已审核”,不必关心光标在哪、怎么找函数边界、如何写注释——你可定义一个 intent 命令:

  • 定义 intent 接口:如 mark_function_as_reviewed,它内部自动检测当前光标所在的函数范围(用 view.find_by_selector("entity.name.function") 或 AST 解析)
  • 自动上下文感知:不依赖用户预选区域或手动定位,而是基于语法作用域、符号表或轻量解析推断“当前函数”“当前测试块”“配置节”等概念
  • 幂等与状态管理:重复执行同一 intent 不产生副作用(如已标记则跳过,或切换状态),让用户放心“说一次”,无需担心执行逻辑

借助 declarative 配置降低意图表达门槛

让用户用 JSON/YAML 声明意图,比写 Python 插件更贴近“声明什么”。例如在 IntentRules.sublime-settings 中写:

{
  "intent": "add_api_logging",
  "when": { "selector": "source.python - string - comment", "has_symbol": "def " },
  "apply": {
    "before": ["import logging", "logger = logging.getLogger(__name__)"],
    "inside": ["logger.debug('entering %s', __name__)"]
  }
}

你的插件监听保存/快捷键,匹配规则并自动注入——用户只描述“我要给函数加日志”,不写一行执行代码。

Subtxt
Subtxt

生成有意义的文本并编写完整的故事。

下载

结合 LSP 和语义分析提升意图准确性

纯文本正则容易误判。接入 LSP(如 pylsp、rust-analyzer)后,你能真正理解“当前光标指向的是哪个函数声明”“该变量是否可变”“这个 if 块是否属于错误处理路径”。这样,“标记错误处理分支为已覆盖”这类意图才能被可靠执行,而不是靠行号或关键词硬匹配。

提供 intent-aware 快捷键与命令面板入口

把 intent 命令注册进 Command Palette,命名直击目的:
• “Intent: Wrap Selection in Try-Except”
• “Intent: Promote Local to Class Field”
• “Intent: Extract Constant from This Number”
用户无需记住命令名或参数结构,看到名字就知道“这正是我想要的”,点即生效。配合 is_enabled() 动态控制可见性(如仅当光标在数字字面量上才显示“Extract Constant”),进一步强化意图感。

不复杂但容易忽略:Intent-based 不是推翻 Sublime 的 API 模型,而是站在它之上做语义升维——把“怎么干”的体力活收到底层,把“想干嘛”的表达权还给用户。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

706

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

624

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

734

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1234

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

573

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

694

2023.08.11

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

微信小程序开发之API篇
微信小程序开发之API篇

共15课时 | 1.2万人学习

Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号