https://github.com/davidalgis/autowrapstrings

A sublime text package to split long string on save on python
https://github.com/davidalgis/autowrapstrings

sublime-package sublime-text sublime-text-4

Last synced: 10 months ago
JSON representation

A sublime text package to split long string on save on python

• Host: GitHub
• URL: https://github.com/davidalgis/autowrapstrings
• Owner: davidAlgis
• License: mit
• Created: 2025-03-12T15:28:17.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-03-21T09:20:20.000Z (10 months ago)
• Last Synced: 2025-03-21T10:37:29.763Z (10 months ago)
• Topics: sublime-package, sublime-text, sublime-text-4
• Language: Python
• Homepage:
• Size: 224 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# AutoWrapStrings

**AutoWrapStrings** is a Sublime Text package that automatically wraps long Python string literals to fit within a specified maximum line length. The plugin processes both single/double-quoted strings and triple‑quoted strings, adjusting the content to avoid exceeding the defined column width.

![](auto_wrap_example.gif)

> [!WARNING]  

> While **AutoWrapStrings** aims to reformat Python string literals accurately, it may contain edge cases where the wrapping does not behave as expected. Use with caution and consider reviewing changes after applying auto wrap.

## Installation

You only need to place the packages files in a folder named `AutoWrapStrings` in your Sublime Text Packages directory.

## Usage

- **Manual Wrapping:**  

  Open the Command Palette (via `Ctrl+Shift+P` or `Cmd+Shift+P` on macOS) and run the command **AutoWrap: Apply Auto Wrap to File** to manually trigger auto wrapping.

- **Auto-Wrap on Save:**  

  When you save a Python file, if the setting `apply_on_save` is enabled (default is disabled), the plugin will automatically reformat string literals to ensure no line exceeds the `max-line-length` (default is 79).

- **Configurable Settings:**  

  Customize the maximum line length and enable or disable auto-wrapping on save through the settings available in ``Preferences/Package Settings\AutoWrapStrings\Settings`.

## Note

**AutoWrapStrings** has been made completely for **Python script**. 

For a more general plugin that wrapped lines you can use [Wrap Plus](https://packagecontrol.io/packages/Wrap%20Plus). It might works better for general purposes, but in a python context **AutoWrapStrings** might be more appropriate, for example:

```python

    long_f_string = f" mollis. Suscipit nisl suspendisse senectus at laoreet efficitur per consectetur. Posuere potenti sollicitudin metus dictum dictum neque magnis. Accumsan, {long_string}! "

```

is wrapped like this with ``WrapPlus``:

```python

    long_f_string = f" mollis. Suscipit nisl suspendisse senectus at laoreet

    efficitur per consectetur. Posuere potenti sollicitudin metus dictum

    dictum neque magnis. Accumsan, {long_string}! "

```

Which break the python code. While ``AutoWrapStrings`` does it like that:

```python

    long_f_string = f" mollis. Suscipit nisl suspendisse senectus at laoreet"

    f"efficitur per consectetur. Posuere potenti sollicitudin metus dictum"

    f"dictum neque magnis. Accumsan, {long_string}!"

```

Trying to not break the code.