Merge pull request #2034 from yarikoptic/enh-codespell

Add codespell config, workflow + have it fixed some typos

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = .git,*.pdf,*.svg,*.tsv,man,formats.jsonl,sample_data,*.cast,golden
+# some ad-hoc or less common word spellings or vars used
+ignore-words-list = vertexes,wil,ned,parms,datas,sav

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [develop]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

CHANGELOG.md

@@ -138,7 +138,7 @@
 
 - expose `CommandLogBase` (was `_CommandLog`)
 - [options] allow FooSheet.options instead of .class_options
-- add seperate non-async `select_row`, `toggle_row`, and `unselect_row` for selection of single rows
+- add separate non-async `select_row`, `toggle_row`, and `unselect_row` for selection of single rows
 - the before/after decorators now do not fail if api functions they are decorating do not already exist
 
 # v2.10.1 (2022-09-14)
@@ -652,7 +652,7 @@
     - [cmdlog] for `open-file` source logging in cmdlog, we want paths to physical files, so if src is a **Sheet** grabs its source
     - [defer] fix pasting in deferred sheets
     - [eval] fix **ExprColumns** on empty rows
-    - [help] move signal config earlier in runcycle, to accomodate --help (thanks @frosencrantz #926)
+    - [help] move signal config earlier in runcycle, to accommodate --help (thanks @frosencrantz #926)
     - [open] create blank sheet of appropriate type when path does not exist
     - [pandas] fix conflict between dropped index and existing column (thanks thomanq #937)
     - [plugins] only check for plugins.jsonl once daily (previously: every start-up)
@@ -690,7 +690,7 @@
 
     - [cli options] now global by default; use `-n` to set option as sheet-specific instead
         - add `-n`/`--nonglobal` to make subsequent CLI options "sheet-specific" (applying only to paths specified directly on the CLI)
-        - keep `-g`/`--global` to make subsequent CLI options "global" (applying to all sheets by default unless overriden)
+        - keep `-g`/`--global` to make subsequent CLI options "global" (applying to all sheets by default unless overridden)
         - invert the default: now CLI options are global by default (thus `-g` is a no-op unless preceded by `-n` on the CLI)
         - `-g` no longer acts as a toggle
 
@@ -809,7 +809,7 @@
     - [loaders zip] add extract-file, extract-selected, extract-file-to, extract-selected-to commands
     - [macros] add improved macro system (thanks @bob-u for feature request #755)
         - `m` (`macro-record`) begins recording macro; `m` prompts for keystroke, and completes recording
-        - macro can then be executed everytime provided keystroke is used, will override existing keybinding
+        - macro can then be executed every time provided keystroke is used, will override existing keybinding
         - `gm` opens an index of all existing macros, can be directly viewed with `Enter` and then modified with `Ctrl+S`
         - macros will run command on current row, column sheet
         - remove deprecated `z Ctrl+D` older iteration of macro system
@@ -1077,7 +1077,7 @@
         - sheet names for join-sheets are still joined with '+' or '&' for the time being
     - [loaders html] add `options.html_title` to exclude the sheetname when saving sheet as html table (thanks @geekscrapy for PR #566)
     - [loaders postgres] add support for custom postgres schema (Thanks @p3k for PR #615)
-        - schema defaults to `public` but can be overriden using the `--postgres-schema` flag:
+        - schema defaults to `public` but can be overridden using the `--postgres-schema` flag:
         - `vd --postgres-schema=foo postgres://user:pw@localhost/foobar`
     - [loaders zip] -f filetype now applies to inner files
     - [mouse] add options.mouse_interval to control the max time between press/release for click (ms)
@@ -1355,7 +1355,7 @@
     - [fixed] various improvements to fixed-width sheet loader (thanks @frosencrantz for thorough bughunting #331)
     - [http] use options.encoding when no encoding is provided by responses headers (thanks @tsibley for the PR #370)
     - [join] joining columns in the ColumnSheet resulted in exception (thanks @frosencrantz for bug report #336)
-    - [load] fix replay sync bug (required wait prevously)
+    - [load] fix replay sync bug (required wait previously)
         - however, look out for `vd *` with lots of big datasets, they will now all load simultaneously
     - [longname] fix getCommand() error reporting
     - [mbtiles] now works again
@@ -1365,7 +1365,7 @@
     - [options] no error on unset if option not already set
     - [path] filesize of url is 0
     - [path] fix piping bug (vd failed to read stdin) (thanks @ajkerrigan for bug report #354)
-    - [plugins] ensure consisten Python exe for plugin installs (thanks @ajkerrigan for fix)
+    - [plugins] ensure consistent Python exe for plugin installs (thanks @ajkerrigan for fix)
     - [plugins] make plugin removal more predictable (thanks @ajkerrigan for fix)
     - [prev-sheet] would stack trace if more than one sheet loaded and no other sheet visited (thanks @frosencrantz for bug report #342)
     - [regex] will not silently fail if some example rows are not matches
@@ -1524,7 +1524,7 @@
 - [loader fixed] provide a way to limit the max number of columns created (thanks @frosencrantz for suggestion #313)
     - added `options.fixed_maxcols` (default: no limit)
 - [loader fixed] loaders override putValue, not setValue (thanks @aborruso for bug report #298)
-- [loader jira] add suport for jira filetype, a markdown derivative compatible with Atlassian JIRA (thanks @layertwo #301)
+- [loader jira] add support for jira filetype, a markdown derivative compatible with Atlassian JIRA (thanks @layertwo #301)
 - [loader Pyobj] `py` filetype to import and explore a python module: `vd -f py curses`
 - [loader pyxlsb] add .xlsb loader (suggested by @woutervdijke #246)
 - [loader ndjson ldjson] add as aliases for jsonl
@@ -1541,7 +1541,7 @@
 - [option vd] `--config` option to specify visidatarc file (suggested by @jsvine #236)
 - [option vdtui] remove `curses_timeout` option (fix to 100ms)
 - [pandas] support multi-line column names (suggested by @jtrakk #223)
-- [pandas] impement sort() for pandas DataFrame (suggested by @migueldvb #257)
+- [pandas] implement sort() for pandas DataFrame (suggested by @migueldvb #257)
 - [pandas] use value_counts() for PandasSheetFreqTable (thanks @azjps for PR #267)
 - [pandas] selection support for PandasSheet (thanks @azjps for PR #267)
 - [pandas] reset index (thanks @danlat #277)
@@ -2065,7 +2065,7 @@ Command additions/changes:
 - Fix cursor row highlighting of identical rows
 
 ## v0.95.2
-- move some functionality out of vdtui into seperate python files
+- move some functionality out of vdtui into separate python files
 - add Ctrl+z command to launch external $EDITOR
 - add ``options.force_valid_names``
 

docs/formats.md

@@ -107,7 +107,7 @@ eleventyNavigation:
 - `vd "imap://[email protected]:[email protected]"` opens a connection to the IMAP server
     - e.g.  `vd "imap://[email protected]:[email protected]:993"`
     - e.g.  `vd "imap://[email protected]@imap.gmail.com"`
-        - note that you don't specifiy a password for gmail here -- instead, you will be prompted to follow some instructions
+        - note that you don't specify a password for gmail here -- instead, you will be prompted to follow some instructions
 
 ### using VisiData as a pager within psql
 

docs/man.md

@@ -252,7 +252,7 @@ vd(1)
       <span style="font-weight:bold;">^G</span>              show cursor position and bounds of current sheet on status line
       <span style="font-weight:bold;">^V</span>              show version and copyright information on status line
       <span style="font-weight:bold;">^P</span>              open <span style="font-weight:bold;">Status</span> <span style="font-weight:bold;">History</span>
-     m <span style="text-decoration:underline;">keystroke</span>      first, begin recording macro; second, prompt for <span style="text-decoration:underline;">keystroke</span> , and complete recording. Macro can then be executed everytime provided keystroke is used. Will override existing keybinding. Macros will run on current row, column, sheet.
+     m <span style="text-decoration:underline;">keystroke</span>      first, begin recording macro; second, prompt for <span style="text-decoration:underline;">keystroke</span> , and complete recording. Macro can then be executed every time provided keystroke is used. Will override existing keybinding. Macros will run on current row, column, sheet.
      gm               open an index of all existing macros. Can be directly viewed with <span style="font-weight:bold;">Enter</span>, and then modified with <span style="font-weight:bold;">^S</span>.
 
       <span style="font-weight:bold;">^Y</span>  <span style="font-weight:bold;">z^Y</span>  <span style="font-weight:bold;">g^Y</span>    open current row/cell/sheet as Python object

visidata/apps/vgit/CHANGELOG.md

@@ -27,7 +27,7 @@
     - `P`ushes the local refs to the currently set remote refs
     - `X` pushes the list of git commands executed
     - `H` pushes the git log sheet (history) for the current branch
-    - `Ctrl-s`tashes uncommited changes
+    - `Ctrl-s`tashes uncommitted changes
     - `Ctrl-p`ops the most recent stashed change and drops it
     - `A`bort the current in-progress action
     - `T` pushes the stashes sheet

visidata/apps/vgit/vgit-guide.md

@@ -2,7 +2,7 @@
 
 ## Global Commands
 
-- `^S` to stash all uncommited changes (`git stash`)
+- `^S` to stash all uncommitted changes (`git stash`)
 - `^P` to pops the most recent stashed change and drops it (`git stash pop`)
 - `A` to abort the cherry-pick/rebase/merge in-progress action shown on status line
 

visidata/basesheet.py

@@ -254,7 +254,7 @@ def recalc(self):
         pass
 
     def refresh(self):
-        'Recalculate any internal state needed for `draw()`.  Overrideable.'
+        'Recalculate any internal state needed for `draw()`.  Overridable.'
         pass
 
     def ensureLoaded(self):

visidata/column.py

@@ -291,7 +291,7 @@ def setCache(self, cache):
 
     @asyncthread
     def _calcIntoCacheAsync(self, row):
-        # causes isues when moved into _calcIntoCache gen case
+        # causes issues when moved into _calcIntoCache gen case
         self._cachedValues[self.sheet.rowid(row)] = INPROGRESS
         self._calcIntoCache(row)
 

visidata/loaders/toml.py

@@ -27,7 +27,7 @@ class TomlSheet(PythonSheet):
 Some helpful commands when working with cells of lists and dictionaries:
 
 - `(` (`expand-col`) on a column with lists or dictionaries will "expand" the structures in the cells into new columns within the current sheet.
-- `zEnter` on a cell with lists or dictionaries will "dive" into the current cell, expanding its structures into rows and columns in a seperate sheet.
+- `zEnter` on a cell with lists or dictionaries will "dive" into the current cell, expanding its structures into rows and columns in a separate sheet.
 '''
 
     rowtype = "values"  # rowdef: dict values, possibly nested

visidata/loaders/tsv.py

@@ -23,7 +23,7 @@ def adaptive_bufferer(fp, max_buffer_size=65536):
     """Loading e.g. tsv files goes faster with a large buffer. But when the input stream
     is slow (e.g. 1 byte/second) and the buffer size is large, it can take a long time until
     the buffer is filled. Only when the buffer is filled (or the input stream is finished)
-    you can see the data visiualized in visidata. Thats why we use an adaptive buffer.
+    you can see the data visiualized in visidata. That's why we use an adaptive buffer.
     For fast input streams, the buffer becomes large, for slow input streams, the buffer stays
     small"""
     buffer_size = 8