tools/go-cuckoo
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Releases 4 Wiki Activity

ci: require one sentence per line #24

Open
mvhutz wants to merge 2 commits from ci/one-sentence-per-line into main
pull from: ci/one-sentence-per-line
merge into: :main
Conversation 0 Commits 2 Files Changed 7
+1389 -19
mvhutz commented 2026-05-16 21:26:27 +00:00
Owner
Copy Link
Copy Source

Description

We should adopt the "One sentence per line" principle for mark-up languages. Nick Groenen's post on the subject describes the benefits clearly.

Design Decisions

  • Updated markdownlint config to markdownlint-cli2 config. The former does not allow custom markdown rules.
  • Created a NPM project to repository, to run custom rules with markdownlint-cli2. We could continue to use Docker by overriding the entrypoint of the file, but it doing so comes with complexity. It is more common to just use an NPM project.

Checklist

  • Tests pass
  • Docs updated
## Description We should adopt the "One sentence per line" principle for mark-up languages. [Nick Groenen's post](https://nick.groenen.me/notes/one-sentence-per-line/) on the subject describes the benefits clearly. ### Design Decisions - Updated `markdownlint` config to `markdownlint-cli2` config. The former does not allow custom markdown rules. - Created a NPM project to repository, to run custom rules with `markdownlint-cli2`. We could continue to use Docker by overriding the entrypoint of the file, but it doing so comes with complexity. It is more common to just use an NPM project. ## Checklist - [x] Tests pass - [x] Docs updated
mvhutz added 2 commits 2026-05-16 21:26:27 +00:00
feat: custom lint rule, fixed readme 46b59d743e
feat: using node version of markdown-lint, no custom rule
CI / Check PR Title (pull_request) Successful in 46s
Details
CI / Makefile Lint (pull_request) Failing after 1m23s
Details
CI / Markdown Lint (pull_request) Failing after 49s
Details
CI / Go Lint (pull_request) Successful in 1m33s
Details
CI / Unit Tests (pull_request) Successful in 55s
Details
CI / Fuzz Tests (pull_request) Successful in 1m52s
Details
CI / Mutation Tests (pull_request) Successful in 1m31s
Details
89bf93de8f
Some required checks failed
CI / Check PR Title (pull_request) Successful in 46s
Required
Details
CI / Makefile Lint (pull_request) Failing after 1m23s
Required
Details
CI / Markdown Lint (pull_request) Failing after 49s
Required
Details
CI / Go Lint (pull_request) Successful in 1m33s
Required
Details
CI / Unit Tests (pull_request) Successful in 55s
Required
Details
CI / Fuzz Tests (pull_request) Successful in 1m52s
Required
Details
CI / Mutation Tests (pull_request) Successful in 1m31s
Required
Details
This pull request has changes conflicting with the target branch.
  • Makefile
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin ci/one-sentence-per-line:ci/one-sentence-per-line
git checkout ci/one-sentence-per-line
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
mvhutz (Maxim Hutz)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: tools/go-cuckoo#24