Walkthrough: Code Linters and formatters #137

New issue

Open

opened 2025-10-11 07:28:41 +00:00 by mahesh-panchal · 1 comment

mahesh-panchal commented

2025-10-11 07:28:41 +00:00

(Migrated from github.com)

How to lint and format code following best practices

A linter is like a proofreader who checks your writing for grammar mistakes, logical errors, and awkward phrasing (potential bugs).
A formatter is like a typesetter who adjusts the document's margins, font size, and line spacing to make it look clean and consistent.

Potential tools to cover:

Nextflow lint and --format
Python: Ruff
R: Styler and lintr
Shell: shellchk
Javascript: ESLint and Prettier
Markdown: Prettier

How to lint and format code following best practices - A linter is like a proofreader who checks your writing for grammar mistakes, logical errors, and awkward phrasing (potential bugs). - A formatter is like a typesetter who adjusts the document's margins, font size, and line spacing to make it look clean and consistent. Potential tools to cover: * Nextflow lint and --format * Python: Ruff * R: Styler and lintr * Shell: shellchk * Javascript: ESLint and Prettier * Markdown: Prettier

👍 7

jwindhager commented

2025-10-11 07:30:39 +00:00

(Migrated from github.com)