search

jupyterhub / jupyter-server-proxy

Jupyter notebook server extension to proxy web services.
https://jupyter-server-proxy.readthedocs.io
BSD 3-Clause "New" or "Revised" License
354 stars 147 forks source link

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

Open yarikoptic opened 4 months ago

yarikoptic commented 4 months ago

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.

manics commented 4 months ago

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

yarikoptic commented 4 months ago

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.

manics commented 4 months ago

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.

yarikoptic commented 4 months ago

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