marked-conductor 1.0.12 → 1.0.14

data/src/_README.md

@@ -23,7 +23,7 @@ If you use Homebrew, you can run
 
 To use Conductor, you need to set up a configuration file in `~/.config/conductor/tracks.yaml`. Run `conductor` once to create the directory and an empty configuration. See [Configuration](#configuration) below for details on setting up your "tracks." 
 
-Once configured, you can set up conductor as a Custom Processor in Marked. Run `which conductor | pbcopy` to get the full path to the binary and copy it, then open <b>Marked Preferences > Advanced</b> and select either Custom Processor or Custom Preprocessor (or both) and paste into the <b>Path:</b> field. You can select <i>Automatically enable for new windows</i> to have the processor enabled by default when opening documents.
+Once configured, you can set up conductor as a Custom Processor in Marked. Run `which conductor | pbcopy` to get the full path to the binary and copy it, then open **Marked Preferences > Advanced** and select either Custom Processor or Custom Preprocessor (or both) and paste into the **Path:** field. You can select *Automatically enable for new windows* to have the processor enabled by default when opening documents.
 
 <!--JEKYLL {% img aligncenter /uploads/2024/04/marked-preferences-conductor.jpg 593 673 "marked-preferences-conductor.jpg" %}-->
 <!--GITHUB-->![Marked preferences](images/preferences.jpg)<!--END GITHUB-->
@@ -122,13 +122,45 @@ Conditions can be combined with AND or OR (must be uppercase) and simple parenth
 
 ### Actions
 
-The action can be either `script` or `command`. 
+The action can be `script`, `command`, or `filter`. 
 
-Scripts are located in `~/.config/conductor/scripts/` and should be executable files that take input on STDIN (unless `$file` is specified in the `script` definition). If a script is defined starting with `~` or `/`, that will be interpreted as a full path to an alternate location.
+**Scripts** are located in `~/.config/conductor/scripts/` and should be executable files that take input on STDIN (unless `$file` is specified in the `script` definition). If a script is defined starting with `~` or `/`, that will be interpreted as a full path to an alternate location.
 
-Commands are interpreted as shell commands. If a command exists in the `$PATH`, a full path will automatically be determined, so a command can be as simple as just `pandoc`. Add any arguments needed after the command.
+> Example:
+> 
+>    script: github_pre
 
-Using `$file` as an argument to a script or command will bypass processing of STDIN input, and instead use the value of $MARKED_PATH to read the contents of the specified file.
+**Commands** are interpreted as shell commands. If a command exists in the `$PATH`, a full path will automatically be determined, so a command can be as simple as just `pandoc`. Add any arguments needed after the command.
+
+> Example:
+> 
+>    command: multimarkdown
+
+
+> Using `$file` as an argument to a script or command will bypass processing of STDIN input, and instead use the value of $MARKED_PATH to read the contents of the specified file.
+
+**Filters** are simple actions that can be run on the content without having to write a separate script for it. Available filters are:
+| filter | description |
+| :----  | :---------- |
+| `setMeta(key, value)` | adds or updates a meta key, aware of YAML and MMD |
+| `stripMeta` | strips all metadata (YAML or MMD) from the content |
+| `stripMeta(key)` | removes a specific key (YAML or MMD) |
+| `setStyle(name)` | sets the Marked preview style to a preconfigured Style name
+| `replace(search, replace)` | performs a (single) search and replace on content | 
+| `replaceAll(search, replace)` | global version of `replaceAll`) |
+| `insertTitle` | adds a title to the document, either from metadata or filename |
+| `insertScript(path[,path])` | injects javascript(s) |
+
+For `insertScript`, if path is just a filename it will look for a match in `~/.config/conductor/javascript` or `~/.config/conductor/scripts` and turn that into an absolute path if the file is found.
+
+For `replace` and `replaceAll`: If *search* is surrounded with forward slashes followed by optional flags (*i* for case-insensitive, *m* to make dot match newlines), e.g. `/contribut(ing)?/i`, it will be interpreted as a regular expression. The *replace* value can include numeric capture groups, e.g. `Follow$2`.
+
+> Example:
+> 
+>    filter: setStyle(github)
+
+
+> Filters can be camel case (replaceAll) or snake case (replace_all), either will work, case insensitive.
 
 ## Custom Processors
 
@@ -142,8 +174,8 @@ A script run by Conductor already knows it has the right type of file with the e
 ## Tips
 
 - Config file must be valid YAML. Any value containing colons, brackets, or other special characters should be quoted, e.g. (`condition: "text contains my:text"`)
-- You can see what condition matched in Marked by opening <b>Help->Show Custom Processor Log</b> and checking the STDERR output.
-- To run [a custom processor for Bear](https://brettterpstra.com/2023/10/08/marked-and-bear/), use the condition `"text contains <!-- source: bear.app -->"`
+- You can see what condition matched in Marked by opening **Help->Show Custom Processor Log** and checking the STDERR output.
+- To run [a custom processor for Bear](https://brettterpstra.com/2023/10/08/marked-and-bear/), use the condition `"text contains <!-- source: bear.app -->"`. You might consider running a commonmark CLI with Bear to support more of its syntax.
 - To run a custom processor for Obsidian, use the condition `tree contains .obsidian`
 
 ## Testing
@@ -154,6 +186,8 @@ In Marked's Custom Processor Log, you can see both the STDOUT output and the STD
 
 ### From the command line
 
+> There's a script included in the repo called [test.sh](https://github.com/ttscoff/marked-conductor/blob/main/test.sh) that will take a file path as an argument and set all of the environment variables for testing. Run `test.sh -h` for usage instructions.
+
 In order to test from the command line, you'll need certain environment variables set. This can be done by exporting the following variables with your own definitions, or by running conductor with all of the variables preceding the command, e.g. `$ MARKED_ORIGIN=/path/to/markdown_file.md [...] conductor`.
 
 The following need to be defined. Some can be left as empty or to defaults, such as `MARKED_INCLUDES` and `MARKED_OUTLINE`, but all need to be set to something.

data/test.sh

@@ -0,0 +1,83 @@
+#!/bin/bash
+
+# ./test.sh PATH [pr[eo]]
+
+OPTIND=1         # Reset in case getopts has been used previously in the shell.
+
+# Initialize our own variables:
+output_file=""
+verbose=0
+
+show_help() {
+	echo "$(basename $0): Shortcut for testing conductor with a given file"
+	echo "Options:"
+	echo "  -p [pre|pro] (run as preprocessor(*) or processor)"
+	echo "  -o [err|out] (output stderr, stdout, both(*))"
+	echo "  -d (debug, only show stderr)"
+	echo "Usage:"
+	echo "  $0 [-p PHASE] [-o OUTPUT] FILE_PATH"
+}
+
+if [[ -d bin ]]; then
+	CMD="./bin/conductor"
+else
+	CMD="$(which conductor)"
+fi
+
+PHASE="PREPROCESS"
+STD="BOTH"
+
+while getopts "h?p:o:d" opt; do
+  case "$opt" in
+    h|\?)
+      show_help
+      exit 0
+      ;;
+    p)  PHASE=$OPTARG
+      ;;
+    o)  STD=$OPTARG
+      ;;
+    d)
+ 		STD="ERR"
+ 	  ;;
+  esac
+done
+
+shift $((OPTIND-1))
+
+[ "${1:-}" = "--" ] && shift
+
+if [[ -z $1 ]]; then
+	show_help
+	exit 1
+fi
+
+FILE=$(realpath $1)
+FILENAME=$(basename -- "$FILE")
+EXTENSION="${FILENAME##*.}"
+PHASE=$(echo $PHASE | tr [a-z] [A-Z])
+STD=$(echo $STD | tr [a-z] [A-Z])
+
+if [[ $PHASE =~ ^PRE ]]; then
+	PHASE="PREPROCESS"
+else
+	PHASE="PROCESS"
+fi
+
+export OUTLINE="NONE"
+export MARKED_ORIGIN="$FILE"
+export MARKED_EXT="$EXTENSION"
+export MARKED_CSS_PATH="/Applications/Marked 2.app/Contents/Resources/swiss.css"
+export PATH="$PATH:$(dirname "$FILE")"
+export MARKED_PATH="$FILE"
+export MARKED_INCLUDES=""
+export MARKED_PHASE="$PHASE"
+
+if [[ $STD =~ ^(STD)?E ]]; then
+	command cat "$FILE" | $CMD 1>/dev/null
+elif [[ $STD =~ ^(STD)?O ]]; then
+	command cat "$FILE" | $CMD 2>/dev/null
+else
+	command cat "$FILE" | $CMD
+fi
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marked-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.14
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -212,6 +212,7 @@ files:
 - html/Conductor/Env.html
 - html/Conductor/Script.html
 - html/FalseClass.html
+- html/Filter.html
 - html/Hash.html
 - html/Object.html
 - html/README_rdoc.html
@@ -269,12 +270,14 @@ files:
 - lib/conductor/condition.rb
 - lib/conductor/config.rb
 - lib/conductor/env.rb
+- lib/conductor/filter.rb
 - lib/conductor/hash.rb
 - lib/conductor/script.rb
 - lib/conductor/string.rb
 - lib/conductor/version.rb
 - marked-conductor.gemspec
 - src/_README.md
+- test.sh
 homepage: https://github.com/ttscoff/marked-conductor
 licenses:
 - MIT