Sunset syntax module (#187)

Turn functions from sublime_lib.syntax module into aliases
of sublime API calls and prints deprecation warnings when being called.

ST4 provides compatible API calls, which can be used as drop-in replacement.

This change assumes SyntaxInfo members are accessed in sane ways, which
don't cause trouble by sublime.Syntax being a normal class.

This change fixes a compatibility issue with python 3.13, as plistlib
removed `readPlistFromBytes` function.

Deprecation is commmunicated via plump prints as warnings.deprecated is not supported by Python 3.8.

Author: deathaxe

sublime_lib/_util/simple_yaml.py

@@ -1,101 +1,18 @@
 from __future__ import annotations
 
-from collections import namedtuple
-import plistlib
-
-from ._util.simple_yaml import parse_simple_top_level_keys
-from .resource_path import ResourcePath
-from typing import List
+import sublime
 
 __all__ = ['list_syntaxes', 'get_syntax_for_scope']
 
 
-SyntaxInfo = namedtuple('SyntaxInfo', ['path', 'name', 'scope', 'hidden'])
-SyntaxInfo.__new__.__defaults__ = (None, None, False)  # type: ignore
-
-
-def get_sublime_syntax_metadata(path: ResourcePath) -> dict:
-    yaml = parse_simple_top_level_keys(path.read_text())
-    return {
-        'name': yaml.get('name') or path.stem,
-        'hidden': yaml.get('hidden', False),
-        'scope': yaml.get('scope'),
-    }
-
-
-def get_tmlanguage_metadata(path: ResourcePath) -> dict:
-    tree = plistlib.readPlistFromBytes(path.read_bytes())
-
-    return {
-        'name': tree.get('name') or path.stem,
-        'hidden': tree.get('hidden', False),
-        'scope': tree.get('scopeName'),
-    }
-
-
-def get_hidden_tmlanguage_metadata(path: ResourcePath) -> dict:
-    tree = plistlib.readPlistFromBytes(path.read_bytes())
-
-    return {
-        'name': path.stem,  # `name` key is ignored
-        'hidden': True,  # `hidden` key is ignored
-        'scope': tree.get('scopeName'),
-    }
-
-
-SYNTAX_TYPES = {
-    '.sublime-syntax': get_sublime_syntax_metadata,
-    '.tmLanguage': get_tmlanguage_metadata,
-    '.hidden-tmLanguage': get_hidden_tmlanguage_metadata,
-}
-
-
-def get_syntax_metadata(path: ResourcePath) -> SyntaxInfo:
-    return SyntaxInfo(
-        path=str(path),
-        **SYNTAX_TYPES[path.suffix](path)
-    )
-
-
-def list_syntaxes() -> List[SyntaxInfo]:
-    """Return a list of all loaded syntax definitions.
-
-    Each item is a :class:`namedtuple` with the following properties:
-
-    path
-        The resource path to the syntax definition file.
-
-    name
-        The display name of the syntax definition.
-
-    scope
-        The top-level scope of the syntax.
-
-    hidden
-        Whether the syntax will appear in the syntax menus and the command palette.
-    """
-    syntax_definition_paths = [
-        path for path in ResourcePath.glob_resources('')
-        if path.suffix in SYNTAX_TYPES
-    ]
-
-    return [
-        get_syntax_metadata(path)
-        for path in syntax_definition_paths
-        if not (
-            path.suffix in {'.tmLanguage', '.hidden-tmLanguage'}
-            and path.with_suffix('.sublime-syntax') in syntax_definition_paths
-        )
-    ]
+def list_syntaxes() -> list[sublime.Syntax]:
+    print("sublime_lib.list_syntaxes() is deprecated,"
+          " use sublime.list_syntaxes() instead!")
+    return sublime.list_syntaxes()
 
 
 def get_syntax_for_scope(scope: str) -> str:
-    """Returns the last syntax in load order that matches `scope`."""
-    try:
-        return next(
-            syntax.path
-            for syntax in reversed(list_syntaxes())
-            if syntax.scope == scope
-        )
-    except StopIteration:
-        raise ValueError("Cannot find syntax for scope {!r}.".format(scope)) from None
+    print("sublime_lib.get_syntax_for_scope() is deprecated,"
+          " use sublime.find_syntax_by_scope() instead!")
+    syntax = sublime.find_syntax_by_scope(scope)
+    return syntax[0].path if syntax else ""