Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -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
25 changes: 25 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Pods/ArgumentParserKit/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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).

Expand Down Expand Up @@ -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`

<img width="300px" src="https://user-images.githubusercontent.com/11782590/164676495-3c07a73f-5254-47eb-a4ff-d6a943617954.png" alt="settings" />

Expand Down