Coding Standards & Linting

A formatter and linter in every repo, a short style guide for what tools cannot check, CI gates, a ratchet for legacy warnings and the habits that keep the rules earning their keep.

Free · Mac (Apple silicon) and Windows · v1.0.5 · Other platforms

Then open the Marketplace in the app, search for Coding Standards & Linting, and click Install. It goes into your own files, and works offline from then on.

What it installs.

1

Pillar

1

Area

50

Projects

199

Starter tasks

⚙️ Software Engineering

Coding Standards & Linting

Agreeing style rules and conventions, then enforcing them automatically with formatters and linters so reviews focus on substance.

  1. Inventory of linters and formatters in every repository
  2. Named owner for the lint and format configuration
  3. Choosing one code formatter per language
  4. Shared editor settings and format on save
  5. Baseline lint rule set from a recommended preset
  6. Team style guide for what tools cannot check
  7. Pre-commit hooks for fast local checks
  8. Lint and format check as a required CI status
  9. Pinned versions for every lint and format tool
  10. Monthly lint warning count review
  11. Quarterly lint rule set review
  12. Suppression comment audit
  13. Linter release notes and new rules watch
  14. Rule proposal and trial process
  15. New repository conformance checklist
  16. Style guide changelog and upkeep
  17. Lint job duration budget
  18. Turning repeated review nits into rules
  19. Understanding your linter's configuration model
  20. Writing a first custom lint rule
  21. Type-aware linting and what it costs
  22. Reading and acting on complexity warnings
  23. Safe and unsafe autofixes
  24. Import ordering and unused code rules
  25. Type checker strictness levels
  26. Naming conventions practice session
  27. Ratchet plan for legacy lint warnings
  28. All-in-one toolchain or separate linter and formatter
  29. Migrating to a faster linter
  30. Severity policy for warnings and errors
  31. Shared lint config package across repositories
  32. Excluding generated and vendored code from lint
  33. Commit message and branch name conventions
  34. Linting shell scripts, Dockerfiles and config files
  35. Style guide kick-off workshop
  36. Whole-codebase reformat cutover
  37. Lint-clean milestone for the flagship repository
  38. Annual coding standards retrospective
  39. Strict type checking switch-on for one package
  40. Minimum standards for a solo developer's repos
  41. Joining a codebase with conventions you disagree with
  42. Rolling out standards to a sceptical team
  43. Merging two teams' conventions after a reorganisation
  44. Polyglot repository with several linters
  45. Matching a client's standards as a contractor
  46. Holding AI-generated code to the same lint rules
  47. Architecture boundary rules enforced by lint
  48. Organisation-wide lint health dashboard
  49. Codemods to adopt a rule across many repositories
  50. Internal lint plugin with tests and releases

Where it starts.

Each project arrives with its purpose, milestones and first tasks written out. Here is how the first three read.

Inventory of linters and formatters in every repository

This is a team plan, best installed into a shared workspace so everyone with a role in it can see and own their tasks. Most teams discover they run three different formatter versions and a linter nobody has configured since the repo was created. A one-page inventory of what each repository actually runs, locally and in CI, shows where the gaps and contradictions are before anyone proposes new rules.

First tasks

  • List the active repositories your team owns in a shared document
  • Record each repo's formatter, linter and type checker with versions from the lockfile
  • Check each CI pipeline for which of those tools actually run
  • Mark the three biggest gaps and contradictions at the top of the inventory

Named owner for the lint and format configuration

Rules without an owner drift: someone disables a check to unblock a release and nobody turns it back on. Naming one person or a small rota as owner of the configuration, with a clear route for proposing changes, stops the config file becoming a battleground edited in passing.

First tasks

  • Agree with the team who owns the lint and format configuration
  • Add the configuration files to the code owners file under that owner
  • Write a short paragraph in the README on how to propose a rule change
  • Announce the owner and the route in the team channel

Choosing one code formatter per language

Formatting arguments about spacing, wrapping and quotes end when the answer is whatever the tool prints. Choosing one per language, with as few options changed from its defaults as possible, removes a whole category of review comments for good.

First tasks

  • List the languages that make up most of the code you own
  • Note the de facto standard formatter for each and what it leaves configurable
  • Run each candidate on a sample directory and read the diff
  • Record the chosen formatter and any changed defaults in the style guide

Make it yours.

Install Coding Standards & Linting, then tell Aurum the date you're aiming for. It checks whether the plan fits the weeks you actually have.

Free · Mac (Apple silicon) and Windows · v1.0.5 · Other platforms

Blueprints are general information to help you organise your own work. They are not medical, financial, legal or other professional advice. See the Terms.