Changelog

[FichteFoll]

This issue is to be used to announce potentially breaking changes or new feature additions.

Package developers using sublime_lib in their code may subscribe to this issue in order to be notified of changes.

The plan is to announce new features once they are released and to announce breaking changes at least a week ahead of time before release.

Update: Since this issue was created, GitHub has been updated and you may instead want to follow the project's releases. We will always post the changelog there as well. Deprecation notices will still be posted only here!

[Thom1729]

Version 1.2

Enhancements

• Added ResourcePath, a pathlib-inspired representation of a Sublime Text resource path.
• Added new_window and close_window functions.
• Added show_selection_panel, a convenient wrapper for sublime.show_quick_panel.
• ViewStream.seek now accepts any integer offset for any value of whence.
• Added ViewStream.show_cursor and the ViewStream(follow_cursor) argument.
• Added new_view(line_endings) argument and LineEnding enum.
• All enums in sublime_lib can be constructed from a member name. Flag enums can be constructed using multiple arguments.

Bug Fixes

• Significantly improved list_syntaxes and find_syntax_by_scope:
  • Correctly observe resource loading order.
  • Ignore tmLanguage and hidden-tmLanguage files that are “shadowed” by sublime-syntax files. (#73)
  • Support hidden-tmLanguage files. (#76)

Documentation Changes

• New single-page design for API reference.
• Many improvements to individual docstrings.

Internal Changes

• 100% test coverage.
• Simplified documentation build process.
• Moved non-exported utility functionality to _util submodule.
• Vendored pathlib.

[Thom1729]

Version 1.2.1

Bug Fixes

• ResourcePath.from_file_path now handles paths within installed packages and default packages.

[Thom1729]

Version 1.2.2

Bug Fixes

• All IntFlag descendants in sublime_lib.flags properly handle multiple arguments. (#94)

[Thom1729]

Version 1.3

Enhancements

• New Panel class for use with panels other than output panels, such as the console.
• Several new methods of ResourcePath:
  • copy and copytree.
  • relative_to.
  • add_suffix and remove_suffix.
• The flags argument of show_selection_panel accepts more values.

Bug Fixes

• sublime_lib.encodings.to_sublime and from_sublime explicitly handle lookup errors.

Documentation Changes

• Minor improvements to docs layout. (#102)

Internal Changes

• Use MyPy type checking.

[Thom1729]

Version 1.4

Enhancements

• Add ActivityIndicator. (#119)
• Add HoverLocation, QueryContextOperator, and CompletionOptions enums. (#111)

Bug Fixes

• Fix bug in glob matching. (#117)
• Add missing default value of -1 for the size argument of ViewStream.read().

Internal changes

• Add comprehensive type declarations. (#116 )
• If a pathlib is available, use that instead of the vendored version. (#113)
• Improved performance of ResourcePath.from_file_path(). (#112)

[Thom1729]

Version 1.5

Enhancements

• ActivityIndicator no longer uses a thread. (#140)
• Two SettingsDicts are equal if and only if they are the same type and refer to the same underling Settings object. (#129)
• Add the Central European (Mac) encoding. (#138)

Bug Fixes

• When an ActivityIndicator is garbage collected, it should stop running. (#153)
• When modifying settings in a SettingsDict.subscribe() callback, don't call the subscription again if the subscribed settings haven't changed. (#152)
• When force-closing views with close_view() or close_window(), revert the scratch state of any clones of those views. (#147)
• A glob pattern like foo/**/* shouldn't match foo/. (#134)

Documentation Changes

• Improved SettingsDict.subcribe documentation to clarify how it detects changes in the selected value.

Internal Changes

• Update documentation for Sphinx 4. (#146)
• Use sphinxcontrib.prettyspecialmethods instead of our original implementation. (#145)
• Fix some typing issues for the latest MyPy. (#155)