Skip to content

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

Draft
yarikoptic wants to merge 4 commits intoallysonlister:masterfrom
yarikoptic:enh-codespell
Draft

Add codespell support (config, workflow to detect/not fix) and make it fix few typos#65
yarikoptic wants to merge 4 commits intoallysonlister:masterfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

This a draft to seek feedback/desire to see it fixed etc.

The full list of potential typos with counts - some are false positives to ignore
❯ codespellit list-hits-sorted
      1 descreases ==> decreases
      1 editted ==> edited
      1 malicously ==> maliciously
      1 offical ==> official
      1 perfoming ==> performing
      1 wont ==> won't
      6 hhttps ==> https
      7 Chromum ==> Chromium
      7 occuring ==> occurring
      7 posession ==> possession
      7 specifiction ==> specification
      7 tiple ==> triple, tuple
      8 deliberatly ==> deliberately
      8 measurment ==> measurement
      8 obsolesence ==> obsolescence
      9 actuall ==> actually, actual
      9 Bcause ==> Because
      9 desicion ==> decision
      9 dscribes ==> describes
      9 funtion ==> function
      9 Licens ==> License
      9 patten ==> pattern, patent
      9 preceeded ==> preceded, proceeded
      9 Sofware ==> Software
     10 Conditons ==> Conditions
     11 accross ==> across
     11 anlysis ==> analysis
     11 annoation ==> annotation
     11 capabilites ==> capabilities
     11 dentify ==> identify
     11 dependance ==> dependence
     11 enviroments ==> environments
     11 FPR ==> FOR, FAR, FPS
     11 Fuctions ==> Functions
     11 inplements ==> implements
     11 peform ==> perform
     11 referencial ==> referential
     11 ressources ==> resources
     11 segway ==> segue
     11 seperate ==> separate
     11 specifity ==> specificity
     11 substitue ==> substitute
     11 tranformed ==> transformed
     11 utlize ==> utilize
     11 Wraper ==> Wrapper
     14 SAEM ==> SAME
     16 ND ==> AND, 2ND
     18 ambidexterous ==> ambidextrous
     18 defintion ==> definition
     22 covert ==> convert, cover, covet
     23 Expresso ==> Espresso
     24 postively ==> positively
     42 vaue ==> value
     43 Segway ==> Segue
     46 entites ==> entities
     60 possibilites ==> possibilities
     63 aquired ==> acquired
  • excludes: I already excluded historical_files/ but do you see other ones to exclude? For those two typo fixes I did (see individual commits -- they include commands I ran to find/fix) we have affected:
❯ git wdiff HEAD^^ --stat
 src/IRIrefactor/2023-03/swo-completed.owl  | 14 +++++++-------
 src/IRIrefactor/2023-03/swo-refactored.owl | 14 +++++++-------
 src/ontology/imports/bfo_import.owl        | 16 ++++++++--------
 src/ontology/imports/iao_import.owl        | 16 ++++++++--------
 src/ontology/imports/obi_import.owl        | 16 ++++++++--------
 src/ontology/swo-edit.owl                  | 14 +++++++-------
 swo-full.json                              | 22 +++++++++++-----------
 swo-full.owl                               | 30 +++++++++++++++---------------
 swo-non-classified.json                    | 22 +++++++++++-----------
 swo-non-classified.owl                     | 30 +++++++++++++++---------------
 swo.json                                   | 22 +++++++++++-----------
 swo.owl                                    | 30 +++++++++++++++---------------
 12 files changed, 123 insertions(+), 123 deletions(-)

should I also exclude src/IRIrefactor/2023-03/ or also imports ? (were to complain/fix them instead/in addition)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "git grep -l possibilites ':^historical_files/**' | xargs sed -i -e 's,possibilites,possibilities,g'",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "git grep -l aquired ':^historical_files/**' | xargs sed -i -e 's,aquired,acquired,g'",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant