changelog.rst

Changelog

v0.6 series

v0.6.13

• Fix subpackages missing from python distribution

v0.6.12

• Fix --check missing early return.
• Fix wrong base class for TupleParser
• Add PATTERN as allowed duplicate keyword
• Enable cmake-lint: disable= within a statement
• Add cmake lint checks on tab policy and indentation size
• Closes: #31: Allow use of tabs instead of spaces
• Closes: #197: [C0103] Invalid CACHE variable
• Closes: #205: Multiple config files aren't merged...
• Closes: #208: Duplicate PATTERN in install(...
• Closes: #210: Usage: banning tabs and enforcing the spaces per tab
• Closes: #216: --check mode dumps entire file since 0.6.11
• Closes: #217: strange formatting for set_target_properties

v0.6.11

• Fix tag handling in release pipeline
• Fix positional specification removed from global configuration on first parse of legacy commands
• Add argcomplete to frontend commands enabling bash completion
• Parse template listfiles that contain @atword@ tokens at the statement level (e.g. @PACKAGE_INIT@).
• Simplify path specification for always_wrap to omit BodyNode, and number PargGroupNode[#].
• Fix spelling configuration option not plumbed through to the formatter
• Add a config option to disable formatting (e.g. in a subdirectory)
• Add documentation for cmake-lint disable
• Closes: #109: Formatting of files containing @VARIABLE@ fails
• Closes: #177: vscode extension: add support for variable substitution ...
• Closes: #179: Official docker image
• Closes: #180: ... regarding always_wrap
• Closes: #191: Inconsistent formatting for ...
• Closes: #202: Spelling not accounted for
• Closes: #207: Add DisableFormat option
• Closes: #211: Add documentation for "cmake-lint:disable"

• Closes: f0fcbce

v0.6.10

• Fix some bugs in genparsers
• Fix some typos in environment handling in extension
• Fix cmake-lint can't --dump-config
• Fix default max statement spacing was 1 instead of 2
• Cleanup legacy command specifications
• Autogenerate command specifications for standard modules
• Don't mark lint for add_custom_target() missing COMMAND
• Add missing annotate resources to distribution package
• Don't break long words when reflowing comment text
• Print violated regex for C0103 lint
• Make line number consistently start from "1" between tokenzizer and checker
• Fix Scope.PARENT is same enum value as scope.INTERNAL
• Skip travis deploy stage on pull request
• Move commands.py into parse_funs/standard_funs.py
• replace duplicates of parse_db update from standard_funs
• get rid of root makefile
• document the release process
• refactor basic_checker module into a class where common function parameters are now member state.
• analyze and document variable naming conventions
• add a pattern for function/macro argument names
• implement W0106 looks like a variable reference missing a brace
• fix name checks shouldn't be applied to variable references
• enable cmake-lint during build/CI
• Closes: #170: Comment is wrong
• Closes: #171: Crash when running cmake-lint --dump-config
• Closes: #172: Possibly false positives for too many newlines
• Closes: #173: find_package_handle_standard_args()
• Closes: #176: cmake-lint: [C0113] is issued for COMMAND in add_custom_target()
• Closes: #181: cmake-annotate is missing css file
• Closes: #182: line break in url
• Closes: #183: cmake-lint: add exact configuration item/value to output
• Closes: #184: Trailing whitespace reported on wrong line
• Closes: #185: cmake-lint: set with PARENT_SCOPE is not INTERNAL
• Closes: #187: Fixed typos and bugs in vscode extension
• Closes: 358e95c, 376422c, 5258b1b, 97f7956, d85b7c7, e03ec57, f0fcbce,

v0.6.9

• fix RTD push on Travis if the pseudo-release is already up-to-date
• added pattern for at-words to the lexer and new token type
• fix custom parsers didn't set lint spec for PositionalGroupNode
• don't pedantically error out on empty JSON config file
• parser can comprehend comments belonging to higher than the current depth in the semantic tree.
• cleanup README, move some stuff to documentation pointers
• generate the config options details page rather than hand writing it
• Closes: #109: Formatting of files containing @VARIBLE@ fails
• Closes: #122: parse_positionals consumes non-related comments after code
• Closes: #168: cmake-lint crashes on add_library function
• Closes: 031922e, 5bcc447, c07a668, efba824, 7eb2cb6

v0.6.8

• Reduce packaging depependency version numbers
• Add build rules to generate variable and property pattern lists
• Implement lint checks on assignment/use of variables that are "close" to builtins except for case.
• Move first_token from configuration object into format context
• Add line, col info to lex error message
• Fix wrong root parser for FetchContent_MakeAvailable
• Fix missing support for string integer npargs
• Fix missing spec for derived classes of PositionalGroupNode
• Fix on/off switch doesn't work inside a statement
• Fix extraneous whitespace inserted before line comment in some statements
• Add more helpful error message on failed configfile parse
• Move documentation build to build time and push documentation artifacts to an artifact repository
• Closes #162: cmake-lint crashes when evaluating math
• Closes #163: cmake-lint crashes when using VERBATIM in add_custom_target
• Closes #164: Internal error FetchContent_MakeAvailable
• Closes: 000bf9a, 6e4ef70, 85a3985, 9a3afa6, c297b3d, cf4570e

v0.6.7

• Add missing dependency on six
• Update pylint, flake8 used in CI
• Remove spurious config warning for some unfiltered command line options
• Add tags field to positional argument groups. Assign "file-list" tag to file lists from add_library and add_executable
• Remove "sortable" flag from root TreeNode class
• Custom commands can specify if a positional group is a command line
• Custom commands can specify multiple positional groups
• max_pargs_hwrap does not apply to cmdline groups
• Remove stale members from TreeNode
• Format extension.ts with two spaces
• Create a tool to generate parsers from cmake_parse_args
• Closes #139: Disable wrap for custom functions
• Closes #159: Missing dependency on six
• Closes: 6ef7d0d, 9669d02, cc60267, cf7ac49, cfa3c02, eefbde3, e75513a,
• Closes: f704714

v0.6.6

• Fix greedy match for bracket comments
• Implement some more readable error messages
• Add source support for sidecar tests
• Overhaul the configuration data structures, dividing configuration up among different classes.
• Remove configuration fields from config object __init__
• Add dump-config options to exclude helptext or defaults
• Implement explicit trailing comments
• Implement "include" from config files
• Move logging init into main() functions
• Closes #156: Linter exception when parsing certain multiline comments

• Closes: 19baaf5, 200a6ed, 3435d8a, 4e6ca84, 6397d42, 9fbebee, b7fb891,

  f097478

v0.6.5

• Fix bullet formatting in README
• Capture some input exceptions and print a more friendly error message
• Fix partialmethod docstrings in command tests
• Add a more detailed configuration description and samples
• Get rid of "extra" dictionary hack to get valid reflow bit out of process_file in __main__.py.
• Implement disabled lint codes config option
• Add preamble and summary to cmake-lint output
• Add test to ensure all cmake commands are in the database
• Implement all commands available in cmake 3.10.2
• Closes #154: cmake-lint: Human readable errors
• Closes: 06918d6, 0b6db3a, 26582bc, 7039c5c, c8d18f1, ea5583e, eb4fb01,
• Closes: 5abae5c

v0.6.4

• Split parser.py module into parse/ sub package.
• Implement derived classes of TreeNode for for many parsers
• Refactor parse functions into class members of the appropriate TreeNode derived class
• Add lint checkers for: C0103, C0113, C0202, C0305, E0103, E0104, E0108, E0109, E1120, E1122, W0101
• Fix wrong token pattern for unquoted literal was including literal tabs and newlines (not literal "t" and "n").
• Closes #153: Spaces added to generator expressions

v0.6.3

• Add ctest-to program
• Add cmake-lint program
• Separate documentation by program
• Add some more detailed configuration documentation
• Make some of the config logic generic and push into a base class
• Some groundwork for cleaning up the config into different sections
• Fix externalproject_add_stepdependencies
• Closes #152: AssertionError on externalproject_add_stepdependencies

v0.6.2

• some initial work on cmake helptext/usage parser
• fix set_target_properties
• fix TOUCH_NOCREATE
• copymode during --in-place
• add --check command
• supress spurious warnings in tests
• create add_custom_target parser
• update add_custom_command parser with different forms
• fix target form of install command
• implement require-valid-layout and add tests
• sidecar tests don't need a companion pyfile
• fix some typos in documentation
• Closes #133: Better handling of un-wrappable, too-long lines
• Closes #134: Wrong formatting of install(TARGETS)
• Closes #140: add USES_TERMINAL to kwargs
• Closes #142: Add a --check option that doesn't write the files
• Closes #143: Broken file attributes after formatting
• Closes #144: Wrong warning about "file(TOUCH_NOCREATE ...)"
• Closes #145: Bad formatting for set_target_properties
• Closes #147: foreach format
• Closes #150: Contributing documentation
• Closes #151: README.rst: fix two typos

v0.6.1

• consolidate --config-file command line flag variants
• add documentation on integration with pre-commit
• add documentation on sidecar tests
• simplify the tag format for sidecar tests
• add support of config options and lex/parse/layout assertions in sidecar tests
• add documentation on debugging with tests
• add tests to validate pull requests
• move most tests into sidecar files

v0.6.0

Significant refactor of the formatting logic.

• Move format_tests into command_tests.misc_tests
• Prototype sidecar tests for easier readability/maintainability
• ArgGroupNodes gain representation in the layout tree
• Get rid of WrapAlgo
• Eliminate vertical/nest as separate decisions. Nesting is just the wrap decision for StatementNode and KwargNode wheras vertical is the wrap decision for PargGroupnode and ArgGroupNode.
• Replace algorithm_order with _layout_passes
• Get rid of default_accept_layout and move logic into a member function
• Move configuration and node_path into new StackContext
• Stricter valid-child-set for most layout nodes

v0.5 series

v0.5.5

• Python config files now have __file__ set in the global namespace
• Add parse support for BYPRODUCTS in add_custom_command
• Modify vscode extension cwd to better support subtree configuration files
• Fix vscode extension args type configuration
• Support multiple config files
• Closes #121: Support BYPRODUCTS
• Closes #123: Allow multiple config files
• Closes #125: Swap ordering of cwd location in vscode extension
• Closes #128: Include LICENSE.txt in sdist and wheel
• Closes #129: cmakeFormat.args in settings.json yields Incorrect type
• Closes #131: cmakeFormat.args is an array of items of type string

v0.5.4

• Don't write un-changed file content when doing in-place formatting
• Fix windows line-endings dropped during read
• Add documentation on how to add custom commands
• Fix yaml-loader returns None instead of empty dictionary for an empty yaml config file.
• Closes #114: Example of adding custom cmake functions/macros
• Closes #117: Fix handling of --dump-config with empty existing yaml config
• Closes #118: Avoid writing outfile unnecessarily
• Closes #119: Fix missing newline argument
• Closes #120: auto-line ending option not working correctly under Windows

v0.5.3

• add some configuration options for next format Refactor
• update documentation source generator scripts and run to get updated dynamic doc texts
• add a couple more case studies
• split reflow methods into smaller methods per case
• fix os.expanduser on None
• Closes #115: crash when no config file

v0.5.2

• add parsers for different forms of add_library() and add_executable()
• move add_library, add_executable() and install() parsers to their own modules
• don't infer sortability in add_library or add_executable() if the descriminator token might be a cmake variable hiding the descriminator spelling
• Split configuration options into different groups during dump and --help
• Refactor long _reflow() implementations, splitting into methods for the different wrap cases. This is in preparation for the next rev of the format algorithm.
• Add documentation on the format algorithm and some case studies.
• Autosort defaults to False
• Changed documentation theme to something based on rtd
• Get rid of COMMAND kwarg specialization
• Closes #111: Formatting breaks add_library
• Closes #112: expanduser on configfile_path

v0.5.1

• Fix empty kwarg can yield a parg group node with only whitespace children
• Fix file(READ ...) and file(STRINGS ...) parser kwargs using set syntax instead of dict syntax
• Fix agressive positional parser within conditional parser
• Fix missing endif, endwhile in parsemap
• Split parse functions out into separate modules for better organization
• Add more sanity tests for file(...).
• Remove README from online docs, replace with expanded documentation for each README section
• Restore ability to accept paren-group in arbitrary parg-group
• Fix missing tests on travis
• Fix new tests using unicode literals (affects python2)
• Fix command parser after --
• Closes #104: Extra space for export targets
• Closes #106: Formatting of file(READ) fails
• Closes #107: multiline cmake commands
• Closes #108: Formatting of file(STRING) fails
• Closes #110: Formatting of Nested Expressions Fails

v0.5.0

• Implement canonical command case
• Canonicalize capitalization of keys in cmdspec
• Add README documentation regarding fences and enable/disable
• Statement parsers are now generic functions. Old standard parser remains for most statements, but some statements now have custom parsers.
• Implement deeper parse logic for install() and file() commands, improving the formatting of these statements.
• Implement input/output encoding configuration parameters
• Implement hashruler markup logic and preserve hashrulers if markup is disable or if configured to do so.
• Implement autosort and sortable tagging
• Separate cmake-annotate frontend
• Provider a Loader= to yaml load()
• Fix python3 lint
• Fix bad lexing of make-style variables
• Fix multiple hash chars lstrip()ed from comments
• Closes #62: Possible improvement on formatting "file"
• Closes #75: configurable positioning of flags
• Closes #87: Hash-rulers are stripped when markup disabled
• Closes #91: Add missing keyword arguments to project command
• Closes #95: added argument --encoding to allow for non-utf8
• Closes #98: Fix kwargs/flag index for non-lowercase functions
• Closes #100: Extra linebreak inserted when '$(' encountered
• Closes #101: Provide a Loader to yaml.load
• Closes #102: fences does not work as expected

v0.4 series

v0.4.5

• Fix testing instructions in README
• Fix dump-config instructions in README
• Remove numpy dependency
• Add travis CI configuration
• Fix some issues with lint under python3
• Closes #40
• Closes #76
• Closes #77
• Closes #80
• Fixes #82: Keyword + long coment + long argument asserts

v0.4.4

• Fix bug where rulers wouldn't break bulleted lists in comment markup
• Add missing flags COMPONENT and CONFIGURATIONS to command spec
• add --dump markup to dump the markup parse tree for debugging comment formatting behavior
• fix invalid NoneType value for --literal-comment-pattern
• shebang is preserved if present (without additional options)
• fix trailing comment of kwarg group consumes rparen
• add test to verify correct consumption of args matching outer kwargs
• add new quoted assignment pattern to lexer for cases like quoted compile definitions
• add --dump html-stub and --dump html-page listfile renderers
• Fixes #56: ignores boolean configuration values
• Closes #66: Positional argument of keyword incorrectly matched as keyword of containing command
• Resolves #73: Control of macro/function renaming
• Fixes #74: shebang in cmake scripts
• Fixes #79: BOM (Byte-order-mark) crashes parser
• Closes #81: Fix comment handling in kwarg group
• Fixes #85: commands: find_package broken
• Fixes #86: Breaking in Quotes

v0.4.3

• dump_config now dumps the active config, including loaded from file or modified by command line
• use cmake macros for cleaner listfiles
• fix argparse defaults override config file settings for boolean args

Closed issues:

• Fixes #70: ignores boolean configuration values

v0.4.2

• Add visual studio code extension
• Add algorithm order config option
• Add user specified fence regex config option
• Add user specified ruler regex config option
• Add config option to disable comment formatting altogether
• Fix get_config bug in __main__
• Fix missing elseif command specification
• Fix missing elseif/else paren spacing when specified
• Add enable_markup config option
• Fix kwargstack early breaking in conditionals
• Add some notes for developers.
• Add warning if formatter is inactive at the end of a print
• Add config options to preserve first comment or any matching a regex

Closed issues:

• Fixes #34: if conditions with many elements
• Closes #35: break_before_args
• Implements #42: user specified string for fencing
• Implements #43: allow custom string for rulers
• Fixes #45: config file not loaded properly
• Fixes #51: competing herustics for 2+ argument statements
• Implements #60: option to not reflow initial comment block
• Implements #61: add non-builtin commands
• Fixes #63: elseif like if
• Implements #65: warn if off doesn't have corresponding on
• Closes #67: global option to not format comments
• Fixes #68: seperate-ctrl-name-with-space

v0.4.1

• Add missing numpy dependency to setup.py
• Fix arg comments dont force vpack
• Fix arg comments dont force dangle parenthesis
• Add some missing function specifications

Closed issues:

• Fixes #53: add numpy as required
• Closes #54: more cmake commands
• Fixes #55: function with interior comment
• Fixes #56: function with trailing comment
• Fixes #59: improve export

v0.4.0

• Overhaul parser into a cleaner single-pass implementation that generates a more complete representation of the syntax tree.
• Parser now recognizes arbitrary nested command specifications. Keyword argument groups are formatted like statements.
• Complete rewrite of formatter (see docs for design)
• Support line comments inside statements and argument groups
• Add some additional command specifications
• Add --dump [lex|parse|layout] debug commands
• --dump-config dumps the active configuration (after loading)
• Add keyword case correction
• Improve layout of complicated boolean expressions

Closed issues:

• Implements #10: treat COMPONENT keyword different
• Implements #37: --dump-config dumps current config
• Implements #39: always wrap for certain functions
• Fixes #46: leading comment in function body
• Fixes #47: function argument incorrectly appended
• Implements #48: improve install target_*
• Fixes #49: removes entire while() sections
• Fixes #50: indented comments appended to preceding line

v0.3 series

v0.3.6

• Implement "auto" line ending option #27
• Implement command casing #29
• Implement stdin as an input file #30

Closed issues:

v0.3.5

• Fix #28: lexing pattern for quoted strings with escaped quotes
• Add lex tests for quoted strings with escaped quotes
• Fix windows format test

Closed issues:

v0.3.4

• Don't use tempfile.NamedTemporaryFile because it has different (and, honestly, buggy behavior) comparied to codecs.open() or io.open()
• Use io.open() instead of codecs.open(). I'm not sure why to prefer one over the other but since io.open is more or less required for printing to stdout I'll use io.open for everything
• Lexer consumes windows line endings as line endings
• Add inplace invocation test
• Add line ending configuration parameter
• Add configuration parameter command line documentation
• Add documentation to python config file dump output
• Strip trailing whitespace and normalize line endings in bracket comments

v0.3.3

• Convert all string literals in format.py to unicode literals
• Added python3 tests
• Attempt to deal with python2/python3 string differences by using codecs and io modules where appropriate. I probably got this wrong somewhere.
• Fix missing comma in config file matching

Closed issues:

• Implement #13: option to dangle parenthesis
• Fix #17: trailing comment stripped from commands with no arguments
• Fix #21: corruption upon trailing whitespace
• Fix #23: wrapping long arguments has some weird extra newline or missing indentation space.
• Fix #25: cannot invoke cmake-format with python3

v0.3.2

• Move configuration to it's own module
• Add lexer/parser support for bracket arguments and bracket comments
• Make stable_wrap work for any prefix / subsequent_prefix.
• Preserve scope-level bracket comments verbatim
• Add markup module with parse/format support for rudimentary markup in comments including nested bulleted and enumerated lists, and fenced blocks.
• Add pyyaml as an extra dependency in pip configuration

Closed issues:

• Fix #16: argparse defaults always override config

v0.3.1

• use exec instead of execfile for python3 compatibility

v0.3.0

• fix #2 : parser matching builtin logical expression names should not be case sensitive
• fix #3 : default code used to read long_description can't decode utf8
• implement #7 : add configuration option to separate control statement or function name from parenthesis
• implement #9 : allow configuration options specified from command line
• Add support for python as the configfile format
• Add --dump-config option
• Add support for "separator" lines in comments. Any line consisting of only five or more non-alphanum characters will be preserved verbatim.
• Improve python3 support by using print_function

Closed issues:

v0.2 series

v0.2.1

• fix bug in reflow if text goes to exactly the end of the line
• add python module documentation to sphinx autodoc
• make formatting of COMMANDs a bit more compact

v0.2.0

• add unit tests using python unit test framework
• accept configuration as yaml or json
• Implemented custom cmake AST parser, getting rid of dependency on cmlp
• Removed static global command configuration
• If no configuration file specified, search for a file based on the input file path.
• Moved code out of __main__.py and into modules
• More documentation and general cleanup
• Add setup.py
• Tested on a production codebase with 350+ listfiles and a manual scan of changes looked good, and the build seems to be healthy.