jupyter-server-proxy icon indicating copy to clipboard operation
jupyter-server-proxy copied to clipboard

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

Open yarikoptic opened this issue 1 year ago • 4 comments

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.

yarikoptic avatar Jul 10 '24 18:07 yarikoptic

Is it possible to use codespell with just pre-commit, so we don't need another GitHub workflow?

manics avatar Jul 12 '24 12:07 manics

Is it possible to use codespell with just pre-commit, so we don't need another GitHub workflow?

yes*! I just was not sure if any of existing workflows already would run pre-commit on changes -- I pushed TEMP commit with a typo, let's see if gets picked up... so far I do not see any other CI step raising an error...

* codespell workflow also includes "matcher" step which annotates PR diff on where&which typo has happened like did now:

image

if we remove workflow - that would be gone - but it would just remove that convenience.

yarikoptic avatar Jul 12 '24 19:07 yarikoptic

We can deal with enforcing pre-commit in https://github.com/jupyterhub/jupyter-server-proxy/issues/489

I think keeping things simple and using just pre-commit is best, especially as typos should be infrequent after an initial review of the repo.

manics avatar Jul 16 '24 16:07 manics

Coolio, your call, rebased kicking away action and the TEMP commit with a typo, took out of draft.

yarikoptic avatar Jul 18 '24 03:07 yarikoptic