diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..0c49324 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,*.lock,.codespellrc +check-hidden = true +# ignore-regex = +ignore-words-list = inout diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..b026c85 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [master] + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/Pods/ArgumentParserKit/ArgumentParserKit/Classes/ArgumentParser.swift b/Pods/ArgumentParserKit/ArgumentParserKit/Classes/ArgumentParser.swift index aeeef97..cd4fdec 100644 --- a/Pods/ArgumentParserKit/ArgumentParserKit/Classes/ArgumentParser.swift +++ b/Pods/ArgumentParserKit/ArgumentParserKit/Classes/ArgumentParser.swift @@ -125,7 +125,7 @@ public enum ShellCompletion { /// Conforming to this protocol will qualify the type to act as /// positional and option arguments in the argument parser. public protocol ArgumentKind { - /// Throwable convertion initializer. + /// Throwable conversion initializer. init(argument: String) throws /// Type of shell completion to provide for this argument. @@ -367,7 +367,7 @@ public final class PositionalArgument: ArgumentProtocol { let name: String - // Postional arguments don't need short names. + // Positional arguments don't need short names. var shortName: String? { return nil } let strategy: ArrayParsingStrategy @@ -631,7 +631,7 @@ public final class ArgumentParser { /// Create an argument parser. /// /// - Parameters: - /// - commandName: If provided, this will be substitued in "usage" line of the generated usage text. + /// - commandName: If provided, this will be substituted in "usage" line of the generated usage text. /// Otherwise, first command line argument will be used. /// - usage: The "usage" line of the generated usage text. /// - overview: The "overview" line of the generated usage text. diff --git a/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/ByteString.swift b/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/ByteString.swift index 5a9dc8d..cbc7663 100644 --- a/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/ByteString.swift +++ b/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/ByteString.swift @@ -12,7 +12,7 @@ /// /// This struct provides useful operations for working with buffers of /// bytes. Conceptually it is just a contiguous array of bytes (UInt8), but it -/// contains methods and default behavor suitable for common operations done +/// contains methods and default behavior suitable for common operations done /// using bytes strings. /// /// This struct *is not* intended to be used for significant mutation of byte diff --git a/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/Path.swift b/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/Path.swift index 937e4cb..165cb48 100644 --- a/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/Path.swift +++ b/Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/Path.swift @@ -483,7 +483,7 @@ extension AbsolutePath { func relative(to base: AbsolutePath) -> RelativePath { let result: RelativePath // Split the two paths into their components. - // FIXME: The is needs to be optimized to avoid unncessary copying. + // FIXME: The is needs to be optimized to avoid unnecessary copying. let pathComps = self.components let baseComps = base.components diff --git a/Pods/ArgumentParserKit/README.md b/Pods/ArgumentParserKit/README.md index 2624c36..81258cb 100644 --- a/Pods/ArgumentParserKit/README.md +++ b/Pods/ArgumentParserKit/README.md @@ -50,7 +50,7 @@ Use the initializer of the `ArgumentParser` class. /// Create an argument parser. /// /// - Parameters: -/// - commandName: If provided, this will be substitued in "usage" line of the generated usage text. +/// - commandName: If provided, this will be substituted in "usage" line of the generated usage text. /// Otherwise, first command line argument will be used. /// - usage: The "usage" line of the generated usage text. /// - overview: The "overview" line of the generated usage text. diff --git a/README.md b/README.md index 3295edf..39aefc2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # macOCR macOCR is a command line app that enables you to turn any text on your screen into text on your clipboard. -When you envoke the `ocr` command, a "screen capture" like cursor is shown. +When you invoke the `ocr` command, a "screen capture" like cursor is shown. Any text within the bounds will be converted to text. You could invoke the app using the likes of [Alfred.app](https://www.alfredapp.com/), [LaunchBar](https://obdev.at/products/launchbar/index.html), [Hammerspoon](http://www.hammerspoon.org/), [Quicksilver](https://qsapp.com/), [Raycast](https://raycast.com/) etc. @@ -10,7 +10,7 @@ Examples: - [macOS Shortcut Workflow](https://www.icloud.com/shortcuts/fa91687e481849d6a27ff873ec71599b) - [Alfred.app Workflow](https://files.littlebird.com.au/OCR2-ONrTkn.zip) - [Raycast Script](https://gist.github.com/cheeaun/1405816e5ceb397cbc9028204f82dc98) -- [LaunchBar Aciton](https://github.com/jsmjsm/macOCR-LaunchBar-Action) +- [LaunchBar Action](https://github.com/jsmjsm/macOCR-LaunchBar-Action) An example Alfred.app workflow is [available here](https://files.littlebird.com.au/OCR2-ONrTkn.zip). @@ -57,7 +57,7 @@ When running the app the first time, you will likely be asked to allow the app a 2. Create new `Shortcut` 3. Add `Run Shell script` 4. Set input as `/usr/local/bin/ocr` (runs this app) -5. Goto `Shorcut Details` +5. Goto `Shortcut Details` settings