flowmark 0.2.0__tar.gz → 0.2.1__tar.gz

{flowmark-0.2.0 → flowmark-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flowmark
-Version: 0.2.0
+Version: 0.2.1
 Summary: Better line wrapping and formatting for plaintext and Markdown
 License: MIT
 Author: Joshua Levy
@@ -54,7 +54,7 @@ command line usage and VSCode/Cursor auto-formatting in the future.
 
 ## Installation
 
-The simplest way to use the tool is to use pipx:
+The simplest way to use the tool is to use [pipx](https://github.com/pypa/pipx):
 
 ```shell
 pipx install flowmark
@@ -62,6 +62,24 @@ pipx install flowmark
 
 To use as a library, use pip or poetry to install `flowmark`.
 
+## Use in VSCode/Cursor
+
+You can use Flowmark to auto-format Markdown on save in VSCode or Cursor. Install
+the "Run on Save" (`emeraldwalk.runonsave`) extension. Then add to your `settings.json`:
+
+```json
+  "emeraldwalk.runonsave": {
+    "commands": [
+        {
+            "match": "\\.md$",
+            "cmd": "flowmark --auto ${file}"
+        }
+    ]
+  }
+```
+
+The `--auto` option is just the same as `--inplace --nobackup --sentences`.
+
 ## Usage
 
 Flowmark can be used as a library or as a CLI.

{flowmark-0.2.0 → flowmark-0.2.1}/README.md

@@ -35,7 +35,7 @@ command line usage and VSCode/Cursor auto-formatting in the future.
 
 ## Installation
 
-The simplest way to use the tool is to use pipx:
+The simplest way to use the tool is to use [pipx](https://github.com/pypa/pipx):
 
 ```shell
 pipx install flowmark
@@ -43,6 +43,24 @@ pipx install flowmark
 
 To use as a library, use pip or poetry to install `flowmark`.
 
+## Use in VSCode/Cursor
+
+You can use Flowmark to auto-format Markdown on save in VSCode or Cursor. Install
+the "Run on Save" (`emeraldwalk.runonsave`) extension. Then add to your `settings.json`:
+
+```json
+  "emeraldwalk.runonsave": {
+    "commands": [
+        {
+            "match": "\\.md$",
+            "cmd": "flowmark --auto ${file}"
+        }
+    ]
+  }
+```
+
+The `--auto` option is just the same as `--inplace --nobackup --sentences`.
+
 ## Usage
 
 Flowmark can be used as a library or as a CLI.

{flowmark-0.2.0 → flowmark-0.2.1}/pyproject.toml

@@ -8,7 +8,7 @@ readme = "README.md"
 license = "MIT"
 requires-python = ">=3.10,<4.0"
 dynamic = [ "dependencies", ]
-version = "0.2.0"
+version = "0.2.1"
 
 [tool.poetry]
 requires-poetry = ">=2.0"

{flowmark-0.2.0 → flowmark-0.2.1}/src/flowmark/cli.py

@@ -93,7 +93,7 @@ def _parse_args(args: Optional[List[str]] = None) -> Options:
         "-s",
         "--sentences",
         action="store_true",
-        default=True,
+        default=False,
         help="Enable sentence-based line breaks (only applies to Markdown mode)",
     )
     parser.add_argument(
@@ -104,16 +104,26 @@ def _parse_args(args: Optional[List[str]] = None) -> Options:
         action="store_true",
         help="Do not make a backup of the original file when using --inplace",
     )
-    parsed_args = parser.parse_args(args)
+    parser.add_argument(
+        "--auto",
+        action="store_true",
+        help="Same as `--inplace --nobackup --sentences`, as a convenience for auto-formatting files",
+    )
+    opts = parser.parse_args(args)
+
+    if opts.auto:
+        opts.inplace = True
+        opts.nobackup = True
+        opts.sentences = True
 
     return Options(
-        file=parsed_args.file,
-        output=parsed_args.output,
-        width=parsed_args.width,
-        plaintext=parsed_args.plaintext,
-        sentences=parsed_args.sentences,
-        inplace=parsed_args.inplace,
-        nobackup=parsed_args.nobackup,
+        file=opts.file,
+        output=opts.output,
+        width=opts.width,
+        plaintext=opts.plaintext,
+        sentences=opts.sentences,
+        inplace=opts.inplace,
+        nobackup=opts.nobackup,
     )