From 9c26591ec1f48784dbf5c816a3c8e9288dfdf963 Mon Sep 17 00:00:00 2001 From: Future-Outlier Date: Thu, 26 Oct 2023 05:35:52 +0800 Subject: [PATCH] Add codespell in `make lint` (#4283) Signed-off-by: Future Outlier Co-authored-by: Future Outlier --- boilerplate/flyte/golang_test_targets/Makefile | 5 ++++- doc-requirements.in | 1 + doc-requirements.txt | 11 +++++++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/boilerplate/flyte/golang_test_targets/Makefile b/boilerplate/flyte/golang_test_targets/Makefile index 280e1e55e4..9b17490323 100644 --- a/boilerplate/flyte/golang_test_targets/Makefile +++ b/boilerplate/flyte/golang_test_targets/Makefile @@ -3,6 +3,9 @@ # # TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst +.PHONY: codespell +codespell: + git ls-files | grep -vE 'go\.mod|go\.sum|flyteidl/|\.pb$$|\.git|\.pdf|\.svg|requirements\.txt|gen/' | xargs codespell -w .PHONY: download_tooling download_tooling: #download dependencies (including test deps) for the package @@ -13,7 +16,7 @@ generate: download_tooling #generate go code @boilerplate/flyte/golang_test_targets/go-gen.sh .PHONY: lint -lint: download_tooling #lints the package for common code smells +lint: codespell download_tooling #lints the package for common code smells GL_DEBUG=linters_output,env golangci-lint run --deadline=5m --exclude deprecated -v # If code is failing goimports linter, this will fix. diff --git a/doc-requirements.in b/doc-requirements.in index 791b7a9ae7..49f7439659 100644 --- a/doc-requirements.in +++ b/doc-requirements.in @@ -1,3 +1,4 @@ +codespell git+https://github.com/flyteorg/furo@main sphinx sphinx-prompt diff --git a/doc-requirements.txt b/doc-requirements.txt index 557c1958f6..289144e3ad 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.11 +# This file is autogenerated by pip-compile with Python 3.9 # by the following command: # # pip-compile doc-requirements.in @@ -20,6 +20,8 @@ cfgv==3.4.0 # via pre-commit charset-normalizer==3.2.0 # via requests +codespell==2.2.6 + # via -r doc-requirements.in distlib==0.3.7 # via virtualenv docutils==0.17.1 @@ -37,6 +39,8 @@ idna==3.4 # via requests imagesize==1.4.1 # via sphinx +importlib-metadata==6.8.0 + # via sphinx jinja2==3.0.3 # via # sphinx @@ -92,7 +96,6 @@ sphinx==4.5.0 # sphinx-tags # sphinxcontrib-video # sphinxcontrib-youtube - # sphinxext-remoteliteralinclude sphinx-autoapi==2.0.1 # via -r doc-requirements.in sphinx-basic-ng==1.0.0b2 @@ -133,6 +136,8 @@ sphinxcontrib-youtube==1.2.0 # via -r doc-requirements.in sphinxext-remoteliteralinclude==0.4.0 # via -r doc-requirements.in +typing-extensions==4.8.0 + # via astroid unidecode==1.3.6 # via sphinx-autoapi urllib3==2.0.6 @@ -141,6 +146,8 @@ virtualenv==20.24.5 # via pre-commit wrapt==1.15.0 # via astroid +zipp==3.17.0 + # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: # setuptools