cmake-lint(1)

📦
version 0.6.13 · 6 versions
, in debian bookworm, ubuntu noble

🌸 NAME 🌸

okay so bestie, listen up — cmake-lint is the tool that checks your cmake listfile for lint. That's it, that's the job. She's the friend who reads your CMakeLists.txt and goes "girl…" 💅

Oh and btw, this whole thing is the cmake-lint(1) page from the General Commands Manual — just so you know what you're reading. 🎀

✨ SYNOPSIS ✨

cmake-lint [-h] [--dump-config {yaml,json,python} | -o OUTFILE_PATH] [-c
CONFIG_FILE] infilepath [infilepath ...]

🦋 DESCRIPTION 🦋

Check cmake listfile for lint.

that's the whole description. she said what she said. no notes. 👑

💖 OPTIONS 💖

  • infilepaths — the file paths you want linted, and yeah you can pass more than one, she eats. 🍓
  • -v, --version — show the program's version number and then dip. exit stage left. ✨
  • -l {error,warning,info,debug}, --log-level {error,warning,info,debug} — how chatty do you want the logs? pick your volume: error, warning, info, or debug. 🔥
  • --dump-config [{yaml,json,python}] — if you specify this, it prints the default configuration to stdout and then exits. like, "here's my whole personality" and then leaves. 💀
  • -o OUTFILE_PATH, --outfile-path OUTFILE_PATH — write errors to this file instead. default is stdout, so by default she's just yelling into the terminal. 😭
  • --no-help — when used with --dump-config, it will omit helptext comments in the output. no little explanations, just the raw facts. 🤫
  • --no-default — when used with --dump-config, it will omit any unmodified configuration value. if you didn't touch it, it's not invited. 🙈
  • --suppress-decorations — suppress the file title decoration and the summary statistics. minimalism era. 🎀
  • -c CONFIG_FILES [CONFIG_FILES ...], --config-files CONFIG_FILES [CONFIG_FILES ...] — path to configuration file(s). plural. she can hold more than one. 💅
  • --vartags [VARTAGS ...] — specify variable tags. 🏷️
  • --proptags [PROPTAGS ...] — specify property tags. 🏷️
  • --disable [DISABLE] — disable formatting entirely, making cmake-format a no-op. she's off duty, don't perceive her. 💤
  • --line-width LINE_WIDTH — how wide to allow formatted cmake files. this is the lewkkk. 📏
  • --tab-size TAB_SIZE — how many spaces to tab for indent.
  • --use-tabchars [USE_TABCHARS] — if true, lines are indented using tab characters (utf-8 0x09) instead of <tab_size> space characters (utf-8 0x20). In cases where the layout would require a fractional tab character, the behavior of the fractional indentation is governed by <fractional_tab_policy>. yes it's that specific, she's not playing around.
  • --fractional-tab-policy {use-space,round-up} — if <use_tabchars> is True, then the value of this variable indicates how fractional indentions are handled during whitespace replacement. If set to 'use-space', fractional indentation is left as spaces (utf-8 0x20). If set to round-up fractional indentation is replaced with a single tab character (utf-8 0x09) effectively shifting the column to the next tabstop.
  • --max-subgroups-hwrap MAX_SUBGROUPS_HWRAP — if an argument group contains more than this many sub-groups (parg or kwarg groups) then force it to a vertical layout. it's giving "too many friends in the group chat, everybody line up." 🫶
  • --max-pargs-hwrap MAX_PARGS_HWRAP — if a positional argument group contains more than this many arguments, then force it to a vertical layout.
  • --max-rows-cmdline MAX_ROWS_CMDLINE — if a cmdline positional group consumes more than this many lines without nesting, then invalidate the layout (and nest).
  • --separate-ctrl-name-with-space [SEPARATE_CTRL_NAME_WITH_SPACE] — if true, separate flow control names from their parentheses with a space. personal space matters. 🧚
  • --separate-fn-name-with-space [SEPARATE_FN_NAME_WITH_SPACE] — if true, separate function names from parentheses with a space.
  • --dangle-parens [DANGLE_PARENS] — if a statement is wrapped to more than one line, than dangle the closing parenthesis on its own line. (that "than" is literally what the original says, we don't edit the queen's words 💀)
  • --dangle-align {prefix,prefix-indent,child,off} — if the trailing parenthesis must be 'dangled' on its on line, then align it to this reference: prefix: the start of the statement, prefix-indent: the start of the statement, plus one indentation level, child: align to the column of the arguments.
  • --min-prefix-chars MIN_PREFIX_CHARS — if the statement spelling length (including space and parenthesis) is smaller than this amount, then force reject nested layouts.
  • --max-prefix-chars MAX_PREFIX_CHARS — if the statement spelling length (including space and parenthesis) is larger than the tab width by more than this amount, then force reject un-nested layouts.
  • --max-lines-hwrap MAX_LINES_HWRAP — if a candidate layout is wrapped horizontally but it exceeds this many lines, then reject the layout. rejected. blocked. 🚫
  • --line-ending {windows,unix,auto} — what style line endings to use in the output. pick your fighter. ⚔️
  • --command-case {lower,upper,canonical,unchanged} — format command names consistently as 'lower' or 'upper' case.
  • --keyword-case {lower,upper,unchanged} — format keywords consistently as 'lower' or 'upper' case.
  • --always-wrap [ALWAYS_WRAP ...] — a list of command names which should always be wrapped.
  • --enable-sort [ENABLE_SORT] — if true, the argument lists which are known to be sortable will be sorted lexicographically.
  • --autosort [AUTOSORT] — if true, the parsers may infer whether or not an argument list is sortable (without annotation). she's intuitive like that. ✨
  • --require-valid-layout [REQUIRE_VALID_LAYOUT] — by default, if cmake-format cannot successfully fit everything into the desired linewidth it will apply the last, most aggressive attempt that it made. If this flag is True, however, cmake-format will print error, exit with non-zero status code, and write-out nothing. she will simply not participate. zero output. periodt.
  • --bullet-char BULLET_CHAR — what character to use for bulleted lists.
  • --enum-char ENUM_CHAR — what character to use as punctuation after numerals in an enumerated list.
  • --first-comment-is-literal [FIRST_COMMENT_IS_LITERAL] — if comment markup is enabled, don't reflow the first comment block in each listfile. Use this to preserve formatting of your copyright/license statements. protect the legal text bestie, do not touch it. ⚠️
  • --literal-comment-pattern LITERAL_COMMENT_PATTERN — if comment markup is enabled, don't reflow any comment block which matches this (regex) pattern. Default is None (disabled).
  • --fence-pattern FENCE_PATTERN — regular expression to match preformat fences in comments default= r'^\s*([`~]{3}[`~]*)(.*)$'
  • --ruler-pattern RULER_PATTERN — regular expression to match rulers in comments default= r'^\s*[^\w\s]{3}.*[^\w\s]{3}$'
  • --explicit-trailing-pattern EXPLICIT_TRAILING_PATTERN — if a comment line matches starts with this pattern then it is explicitly a trailing comment for the preceding argument. Default is '#<'
  • --hashruler-min-length HASHRULER_MIN_LENGTH — if a comment line starts with at least this many consecutive hash characters, then don't lstrip() them off. This allows for lazy hash rulers where the first hash char is not separated by space. lazy era, we respect it. 💤
  • --canonicalize-hashrulers [CANONICALIZE_HASHRULERS] — if true, then insert a space between the first hash char and remaining hash chars in a hash ruler, and normalize its length to fill the column.
  • --enable-markup [ENABLE_MARKUP] — enable comment markup parsing and reflow. 🎀
  • --disabled-codes [DISABLED_CODES ...] — a list of lint codes to disable. block them, we don't want them here. 🙅
  • --function-pattern FUNCTION_PATTERN — regular expression pattern describing valid function names.
  • --macro-pattern MACRO_PATTERN — regular expression pattern describing valid macro names.
  • --global-var-pattern GLOBAL_VAR_PATTERN — regular expression pattern describing valid names for variables with global (cache) scope.
  • --internal-var-pattern INTERNAL_VAR_PATTERN — regular expression pattern describing valid names for variables with global scope (but internal semantic).
  • --local-var-pattern LOCAL_VAR_PATTERN — regular expression pattern describing valid names for variables with local scope.
  • --private-var-pattern PRIVATE_VAR_PATTERN — regular expression pattern describing valid names for privatedirectory variables.
  • --public-var-pattern PUBLIC_VAR_PATTERN — regular expression pattern describing valid names for public directory variables.
  • --argument-var-pattern ARGUMENT_VAR_PATTERN — regular expression pattern describing valid names for function/macro arguments and loop variables.
  • --keyword-pattern KEYWORD_PATTERN — regular expression pattern describing valid names for keywords used in functions or macros.
  • --max-conditionals-custom-parser MAX_CONDITIONALS_CUSTOM_PARSER — in the heuristic for C0201, how many conditionals to match within a loop in before considering the loop a parser.
  • --min-statement-spacing MIN_STATEMENT_SPACING — require at least this many newlines between statements. give the statements room to breathe. 🌬️
  • --max-statement-spacing MAX_STATEMENT_SPACING — require no more than this many newlines between statements.
  • --max-returns MAX_RETURNS — the max returns. that's it, that's the description, she trusts you. 😌
  • --max-branches MAX_BRANCHES — the max branches.
  • --max-arguments MAX_ARGUMENTS — the max arguments.
  • --max-localvars MAX_LOCALVARS — the max localvars.
  • --max-statements MAX_STATEMENTS — the max statements.
  • --emit-byteorder-mark [EMIT_BYTEORDER_MARK] — if true, emit the unicode byte-order mark (BOM) at the start of the file.
  • --input-encoding INPUT_ENCODING — specify the encoding of the input file. Defaults to utf-8.
  • --output-encoding OUTPUT_ENCODING — specify the encoding of the output file. Defaults to utf-8. Note that cmake only claims to support utf-8 so be careful when using anything else. fr fr, be careful, she only speaks utf-8. ⚠️

👑 AUTHORS 👑

cmake-lint was written by Josh Bialkowski <josh.bialkowski@gmail.com>. we love an author who's also a baddie. 💜

🌈 DISTRIBUTION 🌈

The latest version of cmake-lint may be downloaded from https://github.com/cheshirekow/cmake_format. go get her. 🦋

and that's the page bestie!! this little masterpiece lives in the Manual section as cmake-lint(1) — you're literally reading the cmake-lint(1) manual page right now, so congrats, you were here for it. 💖✨ no cap. go lint something and slay. 💅🎀

📦 where this page comes from