(lucenenet) branch master updated: Add pre-commit with codespell hook (#1216)

[pa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

paulirwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git


The following commit(s) were added to refs/heads/master by this push:
     new a4037062a Add pre-commit with codespell hook (#1216)
a4037062a is described below

commit a4037062a3b0a53f065a75ff0db5edafad118753
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Fri Apr 10 13:24:06 2026 +1000

    Add pre-commit with codespell hook (#1216)
    
    * Add pre-commit with codespell hook
    
    * Add exclude for Lucene.Net.Tests
---
 .github/linters/codespell.txt    | 489 +++++++++++++++++++++++++++++++++++++++
 .github/workflows/pre-commit.yml |  51 ++++
 .pre-commit-config.yaml          |  41 ++++
 3 files changed, 581 insertions(+)

diff --git a/.github/linters/codespell.txt b/.github/linters/codespell.txt
new file mode 100644
index 000000000..6e4b9d336
--- /dev/null
+++ b/.github/linters/codespell.txt
@@ -0,0 +1,489 @@
+abl
+absolut
+acccount
+accessability
+accidently
+aci
+addin
+additionaly
+adherance
+administr
+adquire
+advices
+afer
+afile
+afte
+afterwords
+aggreggates
+aliase
+aline
+alle
+allo
+allocte
+allong
+alocate
+alot
+alow
+alpha-numeric
+alredy
+als
+alternativley
+ambiguos
+ameba
+americ
+analyed
+analyer
+andd
+ane
+anothers
+appraently
+appropropriate
+apprpriate
+aquire
+aquired
+arbitarily
+arent
+arguents
+assemblie
+atempt
+ative
+atleast
+atmost
+attibute
+attibutes
+attirbute
+autor
+availble
+avarage
+avove
+bale
+becaus
+begining
+bellow
+betweeen
+betwen
+beween
+bloc
+blockin
+boostrap
+brunch
+bu
+bufferin
+calender
+callibrate
+cant
+capela
+captial
+categorie
+celle
+celles
+chancel
+chaning
+childs
+classs
+collapsable
+commend
+commiting
+commmand
+commun
+comparision
+compatability
+compatibity
+compatiblity
+completly
+concret
+condtions
+confguration
+conjuction
+conjuntions
+connexion
+contians
+continously
+contro
+contsructor
+convertable
+conveyer
+coo
+corelate
+corespondent
+correcty
+correponding
+corrsponding
+corse
+couldnt
+countr
+couterpart
+coversion
+covert
+cunt
+curren
+customizeable
+dalmation
+dcoumentation
+decalaration
+degrates
+deine
+deines
+delimter
+dependant
+despatch
+despatches
+detecing
+dicationary
+didnt
+differnetly
+diposing
+discreet
+discus
+displaing
+docuentation
+documenation
+documention
+doen
+doens't
+doesnt
+dum
+duplcate
+ect
+ede
+elemnts
+eles
+elipses
+elminate
+embeded
+empress
+endcodes
+ende
+ened
+entend
+enviornment
+equest
+esnure
+essentually
+euclidian
+everytime
+exaclty
+excepetion
+exeception
+execeptions
+exlusive
+exmaple
+explicitely
+explicity
+explict
+explictly
+faild
+failue
+fallow
+finis
+floatation
+fo
+folling
+followng
+formated
+formen
+formes
+fount
+fpr
+fro
+fuctionality
+fulfilment
+gage
+gaurd
+gaus
+genereic
+ges
+gird
+glamourous
+gord
+gost
+grup
+guerilla
+guiness
+hart
+hav
+havent
+heder
+hendler
+highligh
+hove
+hte
+idenitifies
+identifer
+ignora
+iif
+imbed
+implementatation
+implementor
+implementors
+implmeneted
+imposible
+improvment
+imrovements
+inate
+incase
+indexin
+ine
+ines
+infact
+informations
+ingenuous
+inital
+initilize
+innaccuracy
+instace
+instaed
+intance
+intead
+interger
+interruted
+intialized
+isnt
+isse
+isses
+ist
+ists
+iterms
+itsself
+kake
+ket
+lama
+lenght
+lief
+lien
+loner
+longwinded
+maching
+maka
+makin
+malicous
+mane
+mange
+manger
+matchs
+maxium
+maxosx
+maxumum
+ment
+meny
+metods
+meu
+meus
+millenium
+millepede
+mimicing
+mimick
+mimicks
+minimun
+mininum
+mis
+mot
+msbuid
+mye
+myu
+nam
+nce
+nd
+ned
+nessesary
+niether
+nin
+noe
+noen
+noes
+non-existant
+nonexistant
+noone
+notin
+nowe
+occcured
+occurances
+occured
+oder
+offets
+oint
+ois
+oje
+olt
+ommitted
+ond
+ons
+ony
+oposite
+oppertunity
+ore
+oriente
+ot
+othewise
+overide
+overriden
+ovewrite
+padd
+paranthesis
+pard
+parms
+patten
+patter
+perforamance
+perfromance
+placehoder
+plaforms
+pluse
+pont
+posin
+postion
+postions
+pre-pended
+pres
+prevend
+previoulsy
+probablistic
+profissional
+profund
+programatically
+programer
+pronounciation
+properies
+propery
+propeties
+propety
+publised
+querys
+ques
+quries
+racoon
+raison
+ream
+reasearch
+recipies
+recursivelly
+redundent
+refering
+refrenced
+relativly
+releae
+repot
+reproducability
+reproducable
+requries
+resoruces
+respnsibility
+returend
+returing
+re-use
+re-used
+re-uses
+re-using
+rime
+rouge
+rougly
+rute
+sate
+sav
+scenerios
+scrip
+seach
+selv
+sensititive
+sentances
+seperate
+seperated
+seperator
+ser
+serialzation
+sesssion
+shold
+shouldnt
+sideral
+sie
+sightly
+similiarty
+simle
+simplifed
+singe
+singl
+siz
+sizin
+slippy
+som
+somme
+speacial
+specifc
+specifiy
+splitted
+statics
+sting
+straightaway
+stye
+subseqence
+succesfully
+sucess
+suppresed
+supress
+synchonise
+syncronize
+te
+teh
+testof
+thar
+thats
+ther
+therefor
+theses
+thi
+thie
+thier
+this'd
+thown
+ths
+tittle
+tje
+toi
+tood
+towords
+tread
+trough
+trye
+trys
+tthe
+udo
+udpate
+ue
+ugprade
+unexpexted
+unknwown
+unkown
+unser
+unter
+useable
+utilty
+vai
+valies
+vart
+vas
+vell
+vender
+vie
+vise
+vists
+vor
+wast
+wee
+weired
+wether
+whats
+whet
+whit
+wierd
+wight
+wil
+wile
+wit
+withe
+wither
+wont
+worstcase
+wouldnt
+wraping
+wroth
+youself
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
new file mode 100644
index 000000000..8af754f54
--- /dev/null
+++ b/.github/workflows/pre-commit.yml
@@ -0,0 +1,51 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: pre-commit
+
+on: [pull_request]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  pre-commit:
+    name: Run pre-commit # https://pre-commit.com/
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout ${{ github.ref }} ( ${{ github.sha }} )'
+        uses: actions/checkout@v5
+      - uses: actions/setup-python@v6 # https://www.python.org/
+        with:
+          python-version: '3.10' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+      - name: Install dependencies # https://pip.pypa.io/en/stable/
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - name: set PY
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> "$GITHUB_ENV"
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Run pre-commit
+        run: pre-commit run --all-files
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 000000000..c02eb0a57
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,41 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+---
+# https://pre-commit.com/#installation
+default_stages: [pre-commit, pre-push]
+default_language_version:
+  # force all unspecified Python hooks to run python3
+  python: python3
+minimum_pre_commit_version: '3.2.0'
+repos:
+  - repo: meta
+    hooks:
+      - id: identity
+        name: run identity check
+        description: check you have set your git identity
+      - id: check-hooks-apply
+        name: run check hooks apply
+        description: check that all the hooks apply to the repository
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        name: run codespell
+        description: check spelling with codespell
+        exclude: ^.*Lucene\.Net\.Tests.*$
+        args: [--ignore-words=.github/linters/codespell.txt]