AdvancedNewFile 项目教程
1. 项目的目录结构及介绍
AdvancedNewFile 是一个用于 Sublime Text 的插件,旨在简化文件和目录的创建过程。以下是该项目的目录结构及其介绍:
AdvancedNewFile/
├── README.md
├── advanced_new_file.py
├── commands.py
├── completion.py
├── core.py
├── keymap.py
├── messages.py
├── settings.py
├── sublime_plugin.py
└── tests/
├── test_completion.py
├── test_core.py
└── test_settings.py
- README.md: 项目说明文档,包含安装和使用说明。
- advanced_new_file.py: 主文件,包含插件的主要逻辑。
- commands.py: 定义插件的命令。
- completion.py: 实现路径自动补全功能。
- core.py: 核心功能实现,包括文件和目录的创建。
- keymap.py: 定义快捷键映射。
- messages.py: 处理插件的消息和提示。
- settings.py: 处理插件的配置和设置。
- sublime_plugin.py: Sublime Text 插件接口文件。
- tests/: 包含测试文件,用于测试插件的各个功能。
2. 项目的启动文件介绍
项目的启动文件是 advanced_new_file.py
。这个文件包含了插件的主要逻辑和入口点。当用户在 Sublime Text 中触发插件命令时,这个文件会被调用。
import sublime
import sublime_plugin
import os
from .core import Core
from .settings import Settings
class AdvancedNewFileCommand(sublime_plugin.WindowCommand):
def run(self):
Core(self.window).run()
- 导入模块: 导入了
sublime
和sublime_plugin
模块,以及项目内部的core
和settings
模块。 - AdvancedNewFileCommand 类: 继承自
sublime_plugin.WindowCommand
,定义了插件的主要命令。 - run 方法: 调用
Core
类的run
方法,启动插件的核心功能。
3. 项目的配置文件介绍
项目的配置文件主要位于 settings.py
文件中。这个文件负责处理插件的配置和设置,包括用户自定义的设置和默认设置。
import sublime
import os
class Settings:
def __init__(self):
self.settings = sublime.load_settings('AdvancedNewFile.sublime-settings')
def get(self, key, default=None):
return self.settings.get(key, default)
def set(self, key, value):
self.settings.set(key, value)
sublime.save_settings('AdvancedNewFile.sublime-settings')
- 导入模块: 导入了
sublime
模块。 - Settings 类: 负责加载和管理插件的设置。
- init 方法: 加载
AdvancedNewFile.sublime-settings
文件。 - get 方法: 获取指定键的设置值。
- set 方法: 设置指定键的设置值,并保存设置文件。
用户可以通过 Sublime Text 的设置界面修改这些配置,例如:
{
"advancedNewFile.exclude": [
"node_modules",
"dist"
],
"advancedNewFile.showInformationMessages": true
}
这些配置项可以在 AdvancedNewFile.sublime-settings
文件中找到,并通过 Settings
类进行读取和修改。