{"id":16271,"date":"2020-03-06T23:03:04","date_gmt":"2020-03-06T23:03:04","guid":{"rendered":"https:\/\/www.bartbusschots.ie\/s\/?p=16271"},"modified":"2020-03-06T23:03:04","modified_gmt":"2020-03-06T23:03:04","slug":"macos-quick-actions-for-text","status":"publish","type":"post","link":"https:\/\/www.bartbusschots.ie\/s\/2020\/03\/06\/macos-quick-actions-for-text\/","title":{"rendered":"MacOS Quick Actions for Text"},"content":{"rendered":"

While I wrote these MacOS Quick Actions to scratch my own proverbial itch, I think they could be of use to others, so I’m releasing them as open source.<\/p>\n

The actions allow you to calculate the word count, line count, and character count of selected text, to convert a text selection to upper case, lower case, or title case, to do the same to the contents of the clipboard, and to convert the clipboard from rich text to plain text and to trim the contents of the clipboard.<\/p>\n

You can download the actions and read the docs on GitHub<\/a>.<\/p>\n

As well as describing what each of the Quick Actions do, the GitHub docs also describe how to install the actions, how to use them, and how to assign keyboard shortcuts to them if desired.<\/p>\n

If you’re curious to learn how these Quick Actions work, read on.<\/p>\n

<\/p>\n

Automator Quick Actions<\/h2>\n

All of these Quick Actions are Automator workflows of type Quick Action.<\/p>\n

\"Screenshot<\/p>\n

The actions for altering the clipboard are configured not to take any input and to be available in any app:<\/p>\n

\"Screenshot<\/p>\n

The actions that alter or measure selected text are configured to take selected text in any app. Those for altering the text are configured to replace the exiting value, and those for measuring are not:<\/p>\n

\"Screenshot<\/p>\n

\"Screenshot<\/p>\n

Displaying Messages<\/h2>\n

The actions that alter the clipboard or measure the selected text report their actions using the Display Notification<\/em> Automator Action. The actions that measure the selection use a variable to output the calculated value:<\/p>\n

\"Screenshot<\/p>\n

Reading Input Text & Outputting Replacement Text<\/h2>\n

The actions that interact with a text selection receive the selection as the input automatically, so no work is needed to fetch the data. The same holds for the output. If the Output replaces selected text<\/em> checkbox is ticked the output of the last action in the workflow will replace the text selection automatically.<\/p>\n

Interacting with the clipboard is not automatic, but trivial.<\/p>\n

Interacting with the Clipboard<\/h3>\n

The actions that alter the clipboard all have the same basic structure \u00e2\u20ac\u201d start by getting the current value of the clipboard using a Get Contents of Clipboard<\/em> action, alter that value in some way, write the updated value back to the clipboard using a Copy to Clipboard<\/em> action, and finally let the user know the action has completed:<\/p>\n

\"Screenshot<\/p>\n

Processing the Text<\/h2>\n

Because JavaScript is more powerful, and because I’m very comfortable writing in that language, I prefer to use JavaScrip rather than AppleScript or shell script when writing code blocks in Automator Workflows. This is why most of the quick actions use the Run JavaScript action to process the text, however, I do use the Run Shell Script action for two of the workflows.<\/p>\n

Automatic Conversion to Plain Text<\/h3>\n

If you enable the log at the bottom of the Automator window (View<\/em> \u00e2\u2020\u2019 Log<\/em> menu or \u00e2\u0152\u00a5\u00e2\u0152\u02dcL<\/code>) you’ll see evidence of a extremely useful Automator behaviour. When you add either a Run Shell Script<\/em> or Run JavaScript<\/em> action into a work-flow Automator converts all inputs to those actions to plain text strings before the action executes. Thos means we can be guaranteed that the text that arrives into the scripting actions is plain text.<\/p>\n

Automator even tries to be clever about the conversion \u00e2\u20ac\u201d if one of the inputs is a file rather than rich or plain text, automator will replace it with the path to the file as a string. <\/p>\n

String Processing with Shell Script<\/h3>\n

The Run Shell Script action gives you the choice of which shell to execute the script with, and how to send the input to the shell.<\/p>\n

Given Apple’s recent move to deprecate Bash and switch to Zsh I’m now using Zsh in my Automation Workflows.<\/p>\n

As for the input, that can either be as command line arguments, or, a STDIN. Most terminal commands are designed to receive information from STDIN, so that’s usually the best solution. The way to think of this input method is that it is as if the output from another command was piped into the command in the Run Shell Script<\/code> action with the |<\/code> operator.<\/p>\n

Regardless of the input method, the output from a Run Shell Script action is STDOUT.<\/p>\n

In this case I used the wc<\/code> command with -l<\/code> and -w<\/code> flags to in the Quick actions for calculating the number of lines and words in a text selection. Since you can pipe text to the wc<\/code> command (e.g. cat \/etc\/hosts | wc -l<\/code>), it can accept input via STDIN. The wc<\/code> command prints the number it calculated to STDOUT.<\/p>\n

So, because wc can take input form STDIN and outputs to STDOUT, the content of the Run Shell Script action simply needs to be the bare command, so wc -l<\/code> to calculate the number of lines, and wc -w<\/code> to calculate the number of words.<\/p>\n

\"Screenshot<\/p>\n

Note that I did not use wc to calculate the character count. Why? Because wc is not sufficiently UTF-8-aware for my tastes. It counts accented characters like \u00c3\u00a9<\/em> as two characters, and the same with emoji. For that reason I chose to use JavaScript to do the character count.<\/p>\n

String Processing with JavaScript<\/h3>\n

The Run JavaScript<\/em> Automator Action behaves a little differently to the Run Shell Script<\/em> action. It’s simpler in the sense that it doesn’t need any configuration (no choosing of shell or input method), but its more complex in the sense that it takes some boiler-plate code to get the action working.<\/p>\n

Automator will load all the JavaScript in the action and then execute a function named run()<\/code>. This means you are free to define any variables and helper functions you wish, but to get the action to actually do anything you must include a run()<\/code> function.<\/p>\n

When Automator executes the run()<\/code> function it passes the inputs received as an array of strings as the first argument. It passes a hash table with some status and configuration data as the second argument.<\/p>\n

Since we know our input will always be the contents of the clipboard or the contents of a text selection we know we’ll always be passed an array of zero or one strings. Why sometimes zero? If the clipboard contains something that can’t be converted to a string then the input will be an empty array.<\/p>\n

To measure or alter text we need to convert the input array to a string. I chose to do that by joining the input into a string using no separator:<\/p>\n

input.join('').toLowerCase();<\/pre>\n
If the input is an array of one string that will evaluate to that string, and if the input is an empty array that will evaluate to an empty string.<\/p>\n
As a practical example, here is all the code in the Run JavaScript<\/em> action in the Selection to lower case<\/code> quick action:<\/p>\n
\r\nfunction run(input, parameters) {\r\n\treturn input.join('').toLowerCase();\r\n}\r\n<\/pre>\n
Using Variables to Store Information<\/h2>\n
In order to output the number of lines, words, or characters in an alert we need to capture the output of the relevant Run Shell Script or Run JavaScript action and store it in an Automator variable.<\/p>\n
Storing the variable is straight forward, simply add a Set Value of Variable<\/em> action into the workflow directly after the scripting action that produced the output to be saved.<\/p>\n
Using the variable is a little less obvious, but just as easy. Be sure the list of variables is visible at the bottom of the Automator window via either the View \u00e2\u2020\u2019 Variables<\/em> menu, or by clicking the very small variables icon at the very bottom of the window. This will show all variables that exist in the workflow. These can be dragged and dropped into other actions. In this case I dragged and dropped the variable holding the relevant count into the text box for the body of the notification in the Show Notification<\/em> action:<\/p>\n
\"Screenshot<\/p>\n","protected":false},"excerpt":{"rendered":"
While I wrote these MacOS Quick Actions to scratch my own proverbial itch, I think they could be of use to others, so I’m releasing them as open source. The actions allow you to calculate the word count, line count, and character count of selected text, to convert a text selection to upper case, lower […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[543,12,16],"tags":[269,420,549,457,580],"series":[],"class_list":["post-16271","post","type-post","status-publish","format-standard","hentry","category-automation","category-computers-tech","category-programming","tag-automator","tag-javascript","tag-macos","tag-software-release","tag-zsh"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p7t9xK-4er","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/posts\/16271","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/comments?post=16271"}],"version-history":[{"count":7,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/posts\/16271\/revisions"}],"predecessor-version":[{"id":16290,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/posts\/16271\/revisions\/16290"}],"wp:attachment":[{"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/media?parent=16271"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/categories?post=16271"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/tags?post=16271"},{"taxonomy":"series","embeddable":true,"href":"https:\/\/www.bartbusschots.ie\/s\/wp-json\/wp\/v2\/series?post=16271"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}