Sublime如何设置默认以只读模式打开某些文件?(保护机制)

1次阅读

sublime text可通过编写插件监听on_load事件并延迟调用view.set_read_only(true)实现按后缀自动只读,需用sublime.set_timeout规避初始化冲突,且应同时监听on_activated以覆盖会话恢复场景。

Sublime如何设置默认以只读模式打开某些文件?(保护机制)

如何让 Sublime 自动以只读模式打开特定后缀的文件?

sublime text 本身不提供“按扩展名默认只读”的内置开关,但可以通过 view.set_read_only(True) + 插件监听实现。核心思路是:在文件加载完成时,检查 view.file_name() 后缀,匹配就设为只读。

常见错误是直接在 on_load 里调用 set_read_only —— 此时视图可能还没完成语法高亮初始化,导致状态被重置。必须用 set_timeout 延迟执行。

  • 新建插件(Preferences → Browse Packages → User,新建 readonly_on_open.py
  • 写入以下逻辑(注意替换你关心的后缀):
import sublime import sublime_plugin  class ReadOnlyOnOpenListener(sublime_plugin.EventListener):     def on_load(self, view):         fname = view.file_name()         if not fname:             return         ext = fname.split('.')[-1].lower()         if ext in ['log', 'out', 'tmp']:             sublime.set_timeout(lambda: view.set_read_only(True), 0)

这个方案兼容 Sublime Text 3/4,无需重启,保存即生效。注意 logout 这类后缀要全小写匹配,windows 下文件名大小写不敏感,但 Sublime 的 split('.')[-1] 返回的是原始大小写,统一转 lower() 更稳妥。

为什么不能靠文件系统权限或 .sublime-project 配置?

文件系统只读属性(如 chmod -w 或 Windows 属性勾选“只读”)确实能让 Sublime 显示锁图标,但用户仍可手动取消只读并保存——这违背“保护机制”的初衷。而 .sublime-project 只能控制整个项目的设置(如 default_encoding),无法按文件粒度干预只读状态。

真正起作用的是 Sublime 的视图级只读标记:view.is_read_only() 返回 True 时,Ctrl+S 会直接忽略,菜单“Save”变灰,编辑操作也不触发修改状态。这是唯一能阻断误保存的路径。

  • 插件方式能拦截所有打开途径:拖入、双击、ctrl+p 搜索、命令行 subl file.log
  • 如果用 on_activated 替代 on_load,会导致切换标签页时反复触发,没必要
  • 别在插件里加 view.set_status 提示——状态栏提示会被后续插件覆盖,且干扰正常工作流

如何临时关闭某次只读,又不改插件?

插件生效后,用户仍有完全控制权:按 Ctrl+Shift+P(Win/linux)或 Cmd+Shift+Pmacos),输入 Toggle Read Only 并回车,即可切换当前视图的只读状态。这个命令对应内置命令 toggle_read_only,不依赖插件,任何时候都可用。

注意:这不是“禁用插件”,而是对单个视图的覆盖。下次重新打开同名文件,插件仍会按规则设为只读——符合保护预期。

  • 快捷键未默认绑定,如需快速切换,可在 Preferences → Key Bindings 加一行:{"keys": ["ctrl+alt+r"], "command": "toggle_read_only"}
  • 如果某类文件(如 .env)偶尔需要编辑,建议把它们从插件的后缀列表中移除,而不是频繁 toggle
  • 不要试图用 view.settings().set('is_read_only', True) —— 这个设置项不存在,只会静默失败

容易被忽略的边界情况

插件逻辑看似简单,但实际使用中几个点常被跳过:

  • 新标签页里粘贴内容再保存为 xxx.log:此时 on_load 不触发(文件没从磁盘加载),需额外监听 on_post_save 判断后缀并设只读
  • 通过 subl --command "new_file" 创建的无名缓冲区,file_name()None,必须先判空
  • 符号链接文件:file_name() 返回的是链接路径,不是真实路径,但通常不影响后缀判断
  • Sublime 启动时自动恢复上次会话的文件:这些文件走的是 on_activated 流程,而非 on_load,需同时监听两个事件

真正的保护机制,不在“能不能设只读”,而在“是否覆盖了所有打开路径和生命周期阶段”。漏掉任意一种,就等于留了个口子。

text=ZqhQzanResources