frameworkLint command

SYNOPSIS:
    Lint files of the current repository to ensure framework conventions
    are followed.


USAGE: frameworkLint [OPTIONS]
USAGE: frameworkLint [--help|-h] [--config]
  [--bash-framework-config <bash-framework-config>] [--verbose|-v] [-vv] [-vvv]
  [--log-level <log-level>] [--log-file <log-file>]
  [--display-level <display-level>] [--no-color] [--theme <theme>] [--version]
  [--quiet|-q] [--format <format>]
  [--expected-warnings-count <expected-warnings-count>]

GLOBAL OPTIONS:
  --help, -h {single}
    Displays this command help
  --config {single}
    Displays configuration
  --bash-framework-config <bash-framework-config> {single}
    Use alternate bash framework configuration.
  --verbose, -v {single}
    Info level verbose mode (alias of --display-level INFO)
  -vv {single}
    Debug level verbose mode (alias of --display-level DEBUG)
  -vvv {single}
    Trace level verbose mode (alias of --display-level TRACE)
  --log-level <log-level> {single}
    Set log level
    Possible values: 
      - OFF
      - ERR
      - ERROR
      - WARN
      - WARNING
      - INFO
      - DEBUG
      - TRACE
    Default value: OFF
  --log-file <log-file> {single}
    Set log file
    Default value: /bash/logs/frameworkLint.log
  --display-level <display-level> {single}
    Set display level
    Possible values: 
      - OFF
      - ERR
      - ERROR
      - WARN
      - WARNING
      - INFO
      - DEBUG
      - TRACE
    Default value: INFO
  --no-color {single}
    Produce monochrome output. alias of --theme noColor.
  --theme <theme> {single}
    Choose color theme - default-force means colors will be produced even if
    command is piped.
    Possible values: 
      - default
      - default-force
      - noColor
    Default value: default
  --version {single}
    Print version information and quit.
  --quiet, -q {single}
    Quiet mode, doesn't display any output.

OPTIONS:
  --format <format> {single}
    Define output format of this command.
    Possible values: 
      - plain
      - checkstyle
    Default value: plain
  --expected-warnings-count <expected-warnings-count> {single}
    Specify expected warning count (default: 0)


DESCRIPTION:
Lint files of the current repository
  - check if all Namespace::functions are existing in the framework
  - check that function defined in a .sh is correctly named
  - check each function has a bats file associated

  - shdoc     - check that shdoc valid annotations are used
    - check that @require function matches naming convention and exists
    - check that at least @description is provided

VERSION: 3.0

AUTHOR: [François Chastanet](https://github.com/fchastanet)

SOURCE FILE: https://github.com/fchastanet/bash-tools-framework/tree/master/src/_binaries/frameworkLint/frameworkLint-binary.yaml

LICENSE: MIT License
Copyright (c) 2023-now François Chastanet