forked from NeoVintageous/NeoVintageous
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugin.py
210 lines (170 loc) · 8.63 KB
/
plugin.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
import logging
import os
import traceback
PACKAGE_NAME = "NeoVintageous"
# The logger needs to be configured before any modules are loaded.
logger = logging.getLogger(PACKAGE_NAME)
logger.propagate = False
# To enable debug logging set the following environment variable to a non-blank value or to a logging level: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET
if not logger.hasHandlers(): # Avoid duplicate loggers e.g., if the plugin is reloaded.
_DEBUG = os.getenv('SUBLIME_NEOVINTAGEOUS_DEBUG')
if _DEBUG:
logger.setLevel(getattr(logging, _DEBUG.upper(), logging.DEBUG))
# print(f"+env, set log level at {getattr(logging, _DEBUG.upper(), logging.DEBUG)}")
else:
from NeoVintageous.nv.log import DEFAULT_LOG_LEVEL
logger.setLevel(DEFAULT_LOG_LEVEL)
# print(f"-env, set log level at {DEFAULT_LOG_LEVEL}")
stream_handler = logging.StreamHandler()
from NeoVintageous.nv.log import formatter
stream_handler.setFormatter(formatter)
logger.addHandler(stream_handler)
import sublime # noqa: E402
# The plugin loading is designed to handle errors gracefully.
#
# When upgrading the plugin, changes to the plugin structure can cause import
# errors. In these cases we want to notify the user about needing to restart
# Sublime Text to finish the upgrade.
#
# In the case of any errors we don't want to leave the normal functioning of the
# editor unusable. We can't access the sublime api until the plugin_loaded()
# hook is called, so we need to catch any exceptions and run cleanup operations
# when the plugin_loaded() hook is called.
try:
_startup_exception = None
from NeoVintageous.nv.rc import load_rc #, _import_plugins_with_user_data_kdl ,_import_plugins_with_user_data
from NeoVintageous.nv.session import load_session
from NeoVintageous.nv.vim import clean_views
# Commands.
from NeoVintageous.nv.commands import * # noqa: F401,F403
from NeoVintageous.nv.layout_generate import * # noqa: F401,F403
# Plugins.
from NeoVintageous.nv.plugin_abolish import * # noqa: F401,F403
from NeoVintageous.nv.plugin_commentary import * # noqa: F401,F403
from NeoVintageous.nv.plugin_input_method import * # noqa: F401,F403
from NeoVintageous.nv.plugin_multiple_cursors import * # noqa: F401,F403
from NeoVintageous.nv.plugin_sneak import * # noqa: F401,F403
from NeoVintageous.nv.plugin_sublime import * # noqa: F401,F403
from NeoVintageous.nv.plugin_surround import * # noqa: F401,F403
from NeoVintageous.nv.plugin_unimpaired import * # noqa: F401,F403
# Events.
from NeoVintageous.nv.events import * # noqa: F401,F403
except Exception as e: # pragma: no cover
traceback.print_exc()
_startup_exception = e
def _update_ignored_packages():
# Updates the list of ignored packages with packages that are redundant,
# obsolete, or cause problems due to conflicts e.g. Vintage, Vintageous,
# etc.
if int(sublime.version()) >= 3143:
# In Package Control 4, orphaned packages, e.g., packages listed as
# ignored, but not actually installed, are pruned. So only packages
# that actually installed should be considered as conflicting.
installed_packages = sublime.load_settings('Package Control.sublime-settings').get('installed_packages')
if installed_packages and isinstance(installed_packages, list):
conflict_candidates = [p for p in ['Six', 'Vintageous'] if p in installed_packages]
else:
conflict_candidates = []
# The Vintage is bundled with ST so it is always installed.
conflict_candidates.append('Vintage')
else:
conflict_candidates = ['Six', 'Vintage', 'Vintageous']
settings = sublime.load_settings('Preferences.sublime-settings')
ignored_packages = settings.get('ignored_packages', [])
if not isinstance(ignored_packages, list):
ignored_packages = []
conflict_packages = [x for x in conflict_candidates if x not in ignored_packages]
if conflict_packages: # pragma: no cover
print('NeoVintageous: update ignored packages with conflicts {}'.format(conflict_packages))
ignored_packages = sorted(ignored_packages + conflict_packages)
settings.set('ignored_packages', ignored_packages)
sublime.save_settings('Preferences.sublime-settings')
def _init_backwards_compat_patches():
# Some setting defaults are changed from time to time. To reduce the impact
# on users, their current preferences are updated so that when the default
# is changed later, their preferences will be override the new default.
try:
preferences = sublime.load_settings('Preferences.sublime-settings')
# The build number is in the format {major}{minor}{patch}, where the
# major number is one digit, minor two digits, and patch two digits.
#
# Version | Build (as integer)
# ------- | -----
# 1.11.0 | 11100
# 1.11.3 | 11103
# 1.17.1 | 11701
# 1.27.0 | 12700
build_version = preferences.get('neovintageous_build_version', 0)
if not isinstance(build_version, int):
build_version = 0
if build_version < 12700: # pragma: no cover
preferences.set('neovintageous_build_version', 12700)
old_file = os.path.join(os.path.dirname(sublime.packages_path()), 'Local', 'nvinfo')
new_file = os.path.join(os.path.dirname(sublime.packages_path()), 'Local', 'neovintageous.session')
if os.path.exists(old_file) and not os.path.exists(new_file):
os.rename(old_file, new_file)
sublime.save_settings('Preferences.sublime-settings')
if build_version < 13200: # pragma: no cover
if build_version != 0:
try:
# The super are now enabled by default. To avoid disruption
# to users, when upgrading, the super keys are set to false
# for users who have not already enabled them.
settings = sublime.decode_value(sublime.load_resource('Packages/User/Preferences.sublime-settings'))
use_super_keys = settings.get('vintageous_use_super_keys') # type: ignore[union-attr]
if use_super_keys is None:
preferences.set('vintageous_use_super_keys', False)
except Exception:
traceback.print_exc()
preferences.set('neovintageous_build_version', 13200)
sublime.save_settings('Preferences.sublime-settings')
except Exception: # pragma: no cover
traceback.print_exc()
def plugin_loaded():
_init_backwards_compat_patches()
loading_exeption = None
package_control_event = None
try:
from package_control import events
if events.install('NeoVintageous'): # pragma: no cover
package_control_event = 'install'
if events.post_upgrade('NeoVintageous'): # pragma: no cover
package_control_event = 'post_upgrade'
except ImportError: # pragma: no cover
pass # Package Control isn't available (PC is not required)
except Exception as e: # pragma: no cover
traceback.print_exc()
loading_exeption = e
try:
_update_ignored_packages()
except Exception as e: # pragma: no cover
traceback.print_exc()
loading_exeption = e
try:
load_session()
load_rc()
# _import_plugins_with_user_data()
# _import_plugins_with_user_data_kdl()
except Exception as e: # pragma: no cover
traceback.print_exc()
loading_exeption = e
if _startup_exception or loading_exeption: # pragma: no cover
clean_views()
if isinstance(_startup_exception, ImportError) or isinstance(loading_exeption, ImportError):
if package_control_event == 'post_upgrade':
message = "Failed to load some modules trying to upgrade NeoVintageous. "\
"Please restart Sublime Text to finish the upgrade."
else:
message = "Failed to load some NeoVintageous modules. "\
"Please restart Sublime Text."
else:
if package_control_event == 'post_upgrade':
message = "An error occurred trying to upgrade NeoVintageous. "\
"Please restart Sublime Text to finish the upgrade."
else:
message = "An error occurred trying to load NeoVintageous. "\
"Please restart Sublime Text."
print('NeoVintageous: ERROR', message)
sublime.message_dialog(message)
def plugin_unloaded():
clean_views()