support comma-separated string tags in config

Author: tfeldmann

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## WIP
+
+- Tag support (#199) to run subsets of rules in your config.
+
 ## v2.1.2 (2022-02-13)
 
 - Hotfix for `filecontent` filter.

docs/configuration.md

@@ -48,6 +48,34 @@ Optionally you can specify the working directory like this:
 organize sim [FILE] --working-dir=~/Documents
 ```
 
+## Running specific rules of your config
+
+You can tag your rules like this:
+
+```yml
+rules:
+  - name: My first rule
+    actions:
+      - echo: "Hello world"
+    tags:
+      - debug
+      - fast
+```
+
+Then use the command line options `--tags` and `--skip-tags` so select the rules you
+want to run. The options take a comma-separated list of tags:
+
+```
+organize sim --tags=debug,foo --skip-tags=slow
+```
+
+Special tags:
+
+- Rules tagged with the special tag `always` will always run
+  (except if `--skip-tags=always` is specified)
+- Rules tagged with the special tag `never` will never run
+  (except if ' `--tags=never` is specified)
+
 ## Environment variables
 
 - `ORGANIZE_CONFIG` - The path to the default config file.

docs/rules.md

@@ -34,6 +34,7 @@ rules:
     filter_mode: ...
     filters: ...
     actions: ...
+    tags: ...
 
   # Another rule
   - name: ...
@@ -51,6 +52,7 @@ The rule options in detail:
 - **filter_mode** (`str`): `"all"`, `"any"` or `"none"` of the filters must apply _(Default: `"all"`)_
 - **filters** (`list`): A list of [filters](filters.md) _(Default: `[]`)_
 - **actions** (`list`): A list of [actions](actions.md)
+- **tags** (`list`): A list of [tags](configuration.md#running-specific-rules-of-your-config)
 
 ## Targeting directories
 

organize/cli.py

@@ -64,7 +64,7 @@ class TagType(click.ParamType):
     def convert(self, value, param, ctx):
         if not value:
             return tuple()
-        return tuple(value.split(","))
+        return tuple(tag.strip() for tag in value.split(","))
 
 
 CLI_CONFIG = click.argument(

organize/core.py

@@ -268,8 +268,11 @@ def run_rules(rules: dict, tags, skip_tags, simulate: bool = True):
 
     console.spinner(simulate=simulate)
     for rule_nr, rule in enumerate(rules["rules"], start=1):
+        rule_tags = rule.get("tags")
+        if isinstance(rule_tags, str):
+            rule_tags = [tag.strip() for tag in rule_tags.split(",")]
         should_run = should_execute(
-            rule_tags=rule.get("tags", []),
+            rule_tags=rule_tags,
             tags=tags,
             skip_tags=skip_tags,
         )