## What - Adds `configs/markdown/.markdownlint-cli2.jsonc` (and a copy at the root): every default markdownlint rule except **MD013 line length**, which K22-CODE-08 says we don't limit, plus a short list of allowed HTML (`<details>`, `<summary>`, …). - Fixes the 17 non-length findings from the first `docs` run: unlabeled code blocks, bold text used as headings in the exception register, double blank lines and a bare email in the Code of Conduct, spaces inside a code span. ## Why The first CI run on `main` failed the `docs` job: 655 of its 672 findings were line-length errors from markdownlint's default 80-column rule, which contradicts our own standard. ## How tested `npx markdownlint-cli2@0.23.3 "**/*.md"` (the version CI pins): 0 issues in 57 files. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: James Maes <james@kof22.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
3.0 KiB
3.0 KiB
Configs: what your IDE and tools import
Every file an editor, IDE, formatter, linter, or scanner needs to enforce the KofTwentyTwo coding standard (Kingsrook style) and the security standards. Each folder has a README with exact import steps for the IDE and the command line.
By editor or IDE
| You use | Start with | Then add |
|---|---|---|
| IntelliJ IDEA and other JetBrains IDEs (WebStorm, PyCharm, GoLand, DataGrip) | intellij/: Kingsrook code-style scheme, copyright profile, live templates, CheckStyle-IDEA settings |
The language folder for your project |
| Rider | dotnet/ (.editorconfig drives Rider's formatter and inspections) |
intellij/ for non-C# files |
| Visual Studio | dotnet/ |
|
| VS Code | vscode/: settings and recommended extensions |
The language folder |
| Eclipse | eclipse/: formatter profile |
java/ for Checkstyle |
| Xcode | swift/ |
|
| Any editor | editorconfig/: one .editorconfig for every language |
By language
| Language | Folder | Formatter / linters | Profile |
|---|---|---|---|
| C# / .NET | dotnet/ |
.editorconfig + analyzers + Meziantou, dotnet format |
csharp-dotnet.md |
| Java | java/, intellij/, eclipse/ |
IntelliJ scheme, Checkstyle (Maven/Gradle) | java.md |
| TypeScript / JavaScript | typescript/ |
ESLint flat config with ESLint Stylistic, strict tsconfig |
typescript.md |
| Python | python/ |
ruff (lint + format), pyright | python.md |
| Rust | rust/ |
rustfmt, clippy, cargo-deny | rust.md |
| Go | go/ |
gofmt, golangci-lint v2 | go.md |
| Swift | swift/ |
swift-format, SwiftLint | swift.md |
| Shell and PowerShell | shell/ |
ShellCheck, shfmt, PSScriptAnalyzer | shell.md |
| Terraform / OpenTofu | terraform/ |
fmt, TFLint |
terraform.md |
| SQL | sql/ |
sqlfluff | (Java and SQL live templates) |
Security and hooks (every repository)
| Folder | What |
|---|---|
security/ |
gitleaks, Trivy, and zizmor configurations, and how to run each locally |
markdown/ |
markdownlint-cli2 config: all default rules except line length (none, per K22-CODE-08) |
pre-commit/ |
The pre-commit hook set: hygiene, secrets, Conventional Commit messages, DCO sign-off, workflow linting |
Files adopted from Kingsrook's QQQ project keep their original copyright and Apache-2.0 license; see NOTICE.