0.10.1: docs: updated changelog

This is the first patch release of the 0.10 version of the program. It brings only one fix for a bug. Below are changes since the last release:

Fixed

• Compilation with Nim 2.2.0

0.10.0

This is the first beta release of the program. It brings a new rule for the program, updated the project's documentation and fixes for some bugs. As usual, a couple of new bugs arrived too. Tag BREAKING means the change break compatibility with a previous version of the program. Below are changes since the last release:

Added

• New rule ranges to check ranges declarations in a code do they have spaces
  before and after the sign ...

Changed

• Updated the project's documentation.
• Updated README.md.

Fixed

• Building the project's documentation.
• Cross-compiling the Windows version of the program on Linux.
• Checking ref objects' types with the rule objects.
• Typos in the project's configuration's file's documentation.

0.9.0

This is the ninth alpha release of the program. It brings a couple of new options for the rules of the program, updated unit tests and fixes for some bugs. As usual, a couple of new bugs arrived too. Tag BREAKING means the change break compatibility with a previous version of the program. Below are changes since the last release:

Added

• The rule objects can now check for existence of constructors of objects.
  It follows Nim coding standard, the constructors must have names like
  newObjectName or initObjectName to be detected.
• The rule namingconv can now check naming conventions for declared types.
• The rule params can now check do routines use int or string for their
  parameters declarations.
• BREAKING: added option fields to objects rule to check only fields of
  objects. The old option all now also checks for existence of constructors
  of objects.

Changed

• Updated the project's documentation.
• BREAKING: changed the name of the rule paramsUsed to params. The
  reason after this change is to make the rule more generic, allowing it to
  check more things related to routines' parameters.

Removed

• BREAKING: Option checkType from complexity rule. It wasn't needed as the
  the rule checks only cyclomatic complexity. If in the future there will
  be added more types of complexities to check, the option can be
  reintroduced.

Fixed

• The rule hasDoc doesn't detect documentation in functions.
• Crash when trying to fix code documentation with hasDoc rule.
• Adding code documentation with hasDoc rule.
• Checking moveable branches with ifstatements rule.

0.8.0

This is the eight alpha release of the program. It brings a couple of new rules for the program, updated unit tests and fixes for many bugs. Plus a couple of new bugs arrived too. Tag BREAKING means the change break compatibility with a previous version of the program. Below are changes since the last release:

Added

• The configuration option to enable the program's summary at the end of its
  work. Currently, it shows only how much time elapsed and the highest memory
  usage.
• New rule tryStatements to check try statements' except branches in a
  code do they are empty or contain an exception with the selected name.
• More information about the program's error to error messages
• New rule object. It can check if the object's type's declarations have all
  their fields public or private and do they are declared by using int or
  string types.
• More types of the program's rules' options: natural for integer values of 0
  or more and positive for integer values greater than 0.
• The rule varDeclared can now detect do a variable was declared with int or
  string type.

Changed

• Using unittest2 package for the project's unit tests.
• BREAKING: adding or removing rules from the program doesn't need to
  update file rulesList.txt. Now it is just adding or removing the Nim file
  with the rule's code to rules directory.
• Better detection of if statements by the ifStatements rule.
• Better detection of for statements by the forStatements rule.
• Updated README.md.
• BREAKING: added the option to set if the log file should be cleared
  before the logging starts. It can break the old configuration file, because
  the syntax of the setting output was changed.
• Better detection of assignments by the assignments rule.

Fixed

• The rule ifstatements checks when statements for upgrade to case
  statements.
• Showing the explanation for negative checks of the forStatements rule.
• The result for negative count type check for assignments and
  varuplevel rules.
• The result for count type check for casestatements, ifstatements and
  localhides rules.
• Showing the detailed information about found result for count type of
  the program's rules.
• The summary information for negative count type check for hasdoc,
  hasentity, haspragma and localhides rules.
• The summary information for checks for paramsused and vardeclared rules.
• The result for search type check for casestatements, ifstatements,
  forstatements, localhides and varuplevel rules.
• The summary information for negative search type check for hasdoc and
  localhides rules.

0.7.1

This is the first patch release of the 0.7 version of the program. It brings only one fix for a bug. Below are changes since the last release:

Fixed

• Detecting a documentation of types by hasDoc rule if the type has defined a pragma(s).

0.7.0

This is the seventh alpha release of the program. It brings a couple of new settings for the program, and mostly fixes for various bugs. Plus perhaps a couple of new bugs too. Tag BREAKING means the change break compatibility with a previous version of the program. Below are changes since the last release:

Added

• The option to check only not borrowed procedures, functions and methods for
  pragmas with hasPragma rule.
• The configuration setting ignore to remove the selected file from the
  list of files to check.
• The rule's name to the program's rules' messages.

Changed

• Updated the project's documentation.
• BREAKING: name of module required to import for use the program's pragmas
  in the checked code.
• Updated contributing guide.

Fixed

• Don't install file rulesList.txt. It is needed only for compilation of the
  program.
• Checking usage of parameters of procedures by paramsUsed rule.
• Detecting a documentation of definition of procedures, functions, etc. with
  hasDoc rule.
• Crash when checking for named parameters in call by namedParams rule when
  there are more results than allowed.
• Crash when there are more results than set by the user in a configuration
  file.
• Detecting a documentation of types with hasDoc rule.
• Installing the program should also contain file nimalyzer.nim for ability
  to disable and enable rules.
• Detecting a documentation of variables in let section with hasDoc rule.
• Detecting calls by namedParams rule.
• Detecting empty if statements with ifStatements rule.
• Detecting empty for statements with forStatements rule.
• Don't check the last parameter of a call if it is a statements' list with
  namedParams rule.
• Crash when checking declarations of variables with varDeclared rule.
• Crash when checking variables with localHides rule.
• Checking declarations of multiple variables with varDeclared rule.

0.6.0

Added

• fix type of rule to paramsUsed rule. It now can remove unused parameters
  from procedures' declaration.
• BREAKING: rules forStatements and ifStatements need now option to set
  what kind of checks will be performed.
• Ability to check for empty for statements to forStatements rule.
• Coloring output of the program in console.
• Configuration setting maxreports to limit the amount of reported problems
  by the program.
• Ability to check the maximum and minimum amount of branches of if
  statements to ifStatements rule.
• BREAKING: checking for invalid the program's configuration's settings in
  a configuration files.
• Information about the line number to errors' messages during parsing the
  program's configuration files.
• Configuration setting explanation which allow adding message to the
  program's rules which shown when the checked code violates the rule's
  setting.
• New rule caseStatements to check case statements in a code for minimum
  and maximum amount of their branches.
• New rule comments to check the comments in a code with the selected regular
  expression or do a code contains a legal header.
• New rule assignments to check the assignments in a code, do they are
  shorthand assignments or not.
• New rule complexity to check code blocks in a code for their cyclomatic
  complexity.

Changed

• Made the program's configuration files syntax case-insensitive.
• Updated README.md.

Fixed

• Typos in the program's documentation.
• Checking usage of parameters in declarations by paramsUsed rule.
• Typos in the program's messages.

0.5.0

This is the fifth alpha release of the program. It brings the new rules forStatements and ifStatements, breaking changes to hasDoc rule's settings, several new settings for the program, a couple of fixes for bugs and new "features". Tag BREAKING means the change break compatibility with a previous version of the program. Below are changes since the last release:

Added

• Configuration setting reset which allows reset the program's configuration
  in the configuration file to change the program's settings without stopping
  it.
• Configuration setting message to add a custom messages to the program's
  output, console and the log file.
• Configuration setting forcefixcommand which allows force subsequent
  program's rules to use their auto fix code or the command defined with the
  fixcommand setting.
• BREAKING: rule hasDoc needs now option to set what kind of entities
  should be checked.
• fix type of rule to hasDoc rule. It can now delete documentation or
  add a template of documentation to the checked code.
• New rule ifStatements to check if statements in code for various things,
  like empty statements, negative conditions, etc.
• New rule forStatements to check for statements in code, do they use pairs
  and items iterators or not.

Changed

• Updated the project's documentation.
• Made rules' custom options case-insensitive.
• Better formatting of error message for rules.

Fixed

• Typos in Changelog.
• Typos in the program's configuration's documentation.
• Detecting documentation of objects types declaration by hasDoc rule.

0.4.0

This is the fourth alpha release of the program. It brings the new type of rules: fix which allows to automatically or semi-automatically fix the detected problems in the code. It also has some updates to existing rules, fixes for bugs and probably a nice amount of new ones. ;) Below are changes since the last release:

Added

• Checking global variables declarations, do they have documentation with
  hasDoc rule.
• New type of rules: fix. For most rules, it just executes a configured
  command when a rule finds a problem, but some rules can automatically fix
  the reported problem. Please refer to the program's documentation how the
  type of rules works.
• The option to enable checking public fields of types declarations for
  documentation for hasDoc rule.
• Ability to check usage of parameters in macros only for paramsUsed rule.

Changed

• Better checking for named parameters by namedParams rule.
• Don't check for named parameters in defined procedure by namedParams rule.
• Don't check for type or value for declarations which unpack tuples by
  varDeclared rule.
• Updated the project's documentation.
• BREAKING: rule hasDoc doesn't check public fields of objects types for
  documentation.
• Updated contributing guide.

Fixed

• Typos in Changelog.
• hasDoc rule doesn't detect if procedure doesn't have documentation if one
  of its child has it.
• Message level for hasEntity rule when it doesn't find the selected entity
  with check type of the rule.
• Message text for hasEntity rule when the program's verbosity is set to
  higher level than default.
• Negation doesn't work for paramsUsed rule.
• Detection of variables which can be updated to let or const with
  varUplevel rule.
• Result of negative check for varUplevel rule.

0.3.0

This is the third alpha release of the program. It brings three new rules, redesigned the rules code itself, some fixes to old bugs and probably a horde of new ones. :) Below are changes since the last release:

Added

• New rule varUplevel to check if declaration of variables can be updated to
  let or const.
• New rule localHides to check if local variables declarations hide global
  ones.
• New rule namingConv to check if variables, procedures and enumerations
  fields follow the selected naming convention.

Changed

• Updated the project's documentation
• Updated README.md
• Disabling and enabling rules' pragmas can be now placed before or in the
  code fragment for which rules should be disabled or enabled.
• Better checking for parameters usage by paramsUsed rule

Fixed

• Typos in Changelog
• hasPragma rule doesn't return error if a declaration doesn't have any
  pragmas
• hasEntity rule doesn't check properly for entities, regression
• hasDoc rule doesn't check properly if module has documentation
• hadDoc rule doesn't detect if template has documentation
• Detection of names of parameters of procedures in paramsUsed rule, when
  parameter has pragma
• Detection of values of variables' declarations in varDeclared rule