spell: turn on pre-commit auto spell checker #1184

dmyger · 2025-07-08T16:21:21Z

Turning on automatic static code analyzer: check words misspell for code files.

Closes #TNTP-3105

Come with second part in #1185

Well-written commit messages (see documentation how to write a commit message)

elhimov · 2025-07-21T23:51:02Z

.github/actions/static-code-check/action.yml

-        SKIP: golangci-lint-full
-      with:
-        extra_args: --all-files --from-ref=${{ env.BASE_BRANCH }} --to-ref=HEAD --hook-stage=manual
+    # - name: pre-commit checks (diff)


It looks a bit strange that this PR disables this job and the next PR (#1185) enables it back and it is the only change #1185 does. Why don't we just keep it intact here, so #1185 would not be needed at all.

Checking “all” files (including old code) is done with lightened requirements, but even this required minor changes. However, any changes are treated as “new” code. The purpose of this PR is to enable rules, not to fix problems in old code.
The step that is turned off here is just checking for changes to the code. Since any new code is checked under stricter rules.

elhimov · 2025-07-22T00:44:41Z

.cspell_project-words.txt

+equalf
+errf
+etcd*
+etcdserver


Looks unnecessary as previous entry matches it.

No, it doesn't work that way.
XXX* can be joined only with *YYY patterns.

elhimov · 2025-07-22T00:47:37Z

.cspell_project-words.txt

+tlsdialer
+tmpl
+tnt+
+tntp


Looks unnecessary as previous entry matches it.

See, comment about etcd*

elhimov · 2025-07-22T00:58:26Z

lib/cluster/integration_test.go

@@ -145,7 +145,7 @@ func startEtcd(t *testing.T, opts etcdOpts) integration.LazyCluster {
 func etcdPut(t *testing.T, etcd *clientv3.Client, key, value string) {
 	t.Helper()
 	var (
-		presp *clientv3.PutResponse
+		presp *clientv3.PutResponse // spell-checker:ignore presp


In 'cli/cluster/integration_test.go' the same identifier changed to pResp. Please consider single approach.

elhimov · 2025-07-22T01:00:20Z

lib/cluster/integration_test.go

@@ -273,10 +273,10 @@ func TestConnectEtcd(t *testing.T) {
 			etcdPut(t, etcd, "foo", "bar")

 			ctx, cancel := context.WithTimeout(context.Background(), timeout)
-			gresp, err := etcd.Get(ctx, "foo")
+			resp, err := etcd.Get(ctx, "foo")


In 'cli/cluster/integration_test.go' the similar identifier presp changed to pResp. Please consider similar approach here.

What will the letter p in this variable mean?
I don't see the need for it in this case.

By the similar approach I mean that if presp is changed to pResp then gresp should be changed to gResp (AFAIU pResp stands for PUT response and gResp stands for GET response).

elhimov · 2025-07-22T01:01:29Z

lib/cluster/etcd.go

@@ -502,6 +502,7 @@ func (publisher EtcdAllDataPublisher) Publish(revision int64, data []byte) error
 			txn = txn.If(cmps...)
 		}

+		// spell-checker:ignore tresp


In 'cli/cluster/integration_test.go' the similar identifier presp changed to pResp. Please consider similar approach here.

lib/cluster/etcd.go

elhimov · 2025-07-22T01:17:11Z

test/integration/replicaset/test_replicaset_promote.py

@@ -155,7 +155,7 @@ def test_promote_cconfig_failovers(
                "manual-failover-2",
                "election-failover-1",
                "election-failover-2",
-                "eleciton-failover-3",
+                "eleciton-failover-3",  # spell-checker:disable-line


Suggested change

"eleciton-failover-3", # spell-checker:disable-line

"election-failover-3",

No, the test will fail in this case.
The purpose of this PR is not to fix problematic code, but to enable spell checking.

elhimov · 2025-07-22T01:28:21Z

test/integration/completion/conftest.py

@@ -44,7 +46,7 @@ def skip_no_helpers(request: pytest.FixtureRequest, completion: Completion) -> N


 def pytest_configure(config):
-    config.addinivalue_line(
+    config.addinivalue_line(  # cSpell:words addinivalue


If it's possible I'd suggest to introduce separate project-words file for integration tests directory. All pytest identifiers that are currently in use could be listed there.

My opinion is that lists of “bad” words are workaround, because they should not exist. The fact that now a list of words is made at the project level is because there are too many such words already found throughout the old code. Ideally, the names should immediately meet the requirements of the checker.

And such marks raise a “red” flag - that something needs to be done here with refactoring. The word list on other hand hides this problem.

Closes #TNTP-3105

Part of #TNTP-3105

Due to formatting changes, it triggers the linter's errors. FIXME: turn on the checking with the following PR. Part of #TNTP-3105

dmyger force-pushed the dmyger/tntp-3105_turn_on_spell_checker_for_code branch from 370cdba to c04ce9f Compare July 10, 2025 12:09

dmyger changed the title ~~spell: turn on precommit spell checker for Python~~ spell: turn on pre-commit auto spell checker Jul 10, 2025

dmyger requested a review from oleg-jukovec July 10, 2025 12:11

dmyger marked this pull request as ready for review July 10, 2025 12:11

dmyger requested review from AlexandrLitkevich, elhimov and patapenka-alexey July 10, 2025 12:12

dmyger mentioned this pull request Jul 10, 2025

ci: turn on linters #1185

Open

dmyger force-pushed the dmyger/tntp-3105_turn_on_spell_checker_for_code branch from 2b4a206 to 59e26ec Compare July 10, 2025 13:03

dmyger added the full-ci Enables full ci tests label Jul 10, 2025

dmyger force-pushed the dmyger/tntp-3105_turn_on_spell_checker_for_code branch 3 times, most recently from b4547b7 to 20a96d7 Compare July 16, 2025 10:27

oleg-jukovec approved these changes Jul 17, 2025

View reviewed changes

elhimov requested changes Jul 22, 2025

View reviewed changes

dmyger force-pushed the dmyger/tntp-3105_turn_on_spell_checker_for_code branch from 20a96d7 to 707afff Compare July 22, 2025 10:17

dmyger added 2 commits July 23, 2025 20:03

ci: Turn on spell checker for code files

dbfc6e7

Closes #TNTP-3105

spell: turn on spell checker for Python

fcaafe1

Part of #TNTP-3105

dmyger force-pushed the dmyger/tntp-3105_turn_on_spell_checker_for_code branch from 707afff to 25a4d6e Compare July 23, 2025 17:03

dmyger requested a review from elhimov July 23, 2025 17:32

dmyger added 3 commits July 23, 2025 20:35

spell: turn on spell checker for Go code

9bb9bd9

Part of #TNTP-3105

spell: fix changelog spelling

975f3c3

Part of #TNTP-3105

ci: turn off linters for formatted old code

89506dd

Due to formatting changes, it triggers the linter's errors. FIXME: turn on the checking with the following PR. Part of #TNTP-3105

dmyger force-pushed the dmyger/tntp-3105_turn_on_spell_checker_for_code branch from 25a4d6e to 89506dd Compare July 23, 2025 17:35

	"eleciton-failover-3", # spell-checker:disable-line
	"election-failover-3",

spell: turn on pre-commit auto spell checker #1184

Are you sure you want to change the base?

spell: turn on pre-commit auto spell checker #1184

Conversation

dmyger commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dmyger commented Jul 8, 2025 •

edited

Loading