Commit Graph

40 Commits

Author SHA1 Message Date
Jeremiah Leary 799c54b9a8
Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
Alon Bar-Lev f9c2653e54 style: apply codespell
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:34 +02:00
Jeremiah Leary 6694078942
Issue#1143: Documentation updates (#1144)
* option all-phases to all_phases
  * fixed rev in pre-commit documentation
2024-03-19 06:12:26 -05:00
Alon Bar-Lev aeeeed6c27
alonbl patch series (#1017)
* Add linesep configuration option

Platform independent line ends are important to avoid conflicts.

Resolves: #1010
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

* Perform atomic write to files

Do not overwrite file as we may corrupt the file if something fails, instead
write into temporary location and move the result into the final destination.

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

* Synchronize README command-line usage

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

* Support files as positional argument

Tools such as pre-commit and other tools expects the tools to accept the
input files as positional argument and not as options.

Let's support the two variants.

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

* Support shallow git clone without tags

pre-commit uses shallow clone without tags, as this is not used to publish the
artifact, let's assume version '0' in this case.

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

* Add pre-commit hooks support

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>

---------

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2023-11-05 07:24:50 -06:00
Seth Gower 3b6fc9eefb
Adds ability to read from standard input (#897)
* adds basic functionality to send file to stdin

* updates usage docs to reflect stdin and adds new vim editor configs

* Adds better handling with stdin. Safer checks

* removes output over stdout for vhdl file since that's out of scope

* shortens cmd line args line to pass that check on codeclimate

* removes trailing white space

* changes is to == to prevent warning

* updates vim rst to have the null ls config ignore stderr

When editing a file sometimes things can cause VSG to fail and print to
stderr. If this happens, without ignoring stderr it will create an error
message in nvim, which was obnoxious
2023-09-08 14:55:15 -05:00
Jeremiah Leary d66da9a6a8
Issue 549a (#839)
* Updates for issue #549

Refactoring concurrent_011 into base rule multiline_simple_structure.

* Refactoring concurrent_009 into base rule multiline_conditional_alignment.

* Fixing name and identifier.

* Refactoring rule constant_012 into base rule multiline_array_alignment.

* Adding rule variable_assignment_007.

* Adding rule variable_assignment_008

  1)  Refactored multiline_structure to be configurable
  2)  Added documentation
  3)  Added tests

* Adding rule variable_assignment_400.

* Adding rule variable_assignment_400.

* Updating Documentation

  1)  Adding files which were not being built
  2)  Fixed links

* Adding rule concurrent_012.

* Adding rule concurrent_401

* Adding rule sequential_008.

* Adding rule sequential_009.

* Adding rule sequential_401

* Adding rule sequential_402

* Fixing documentation

* Fixing table rendering.

* Changing multiline_alignment_between_tokens to not work on arrays.

* Updating rule concurrent_011 to not operate on arrays.

* Fixing documentation issues:

  1)  Renamed several rules to improve readability
  2)  Fixed warnings from sphynx
  3)  Fixing links

* Adding links to rules.

* Updating docstring with correct links to configuration documentation.

* Updating formatting to match current standards.

* Updating formatting to current standard.

* Changing depricated to deprecated.

* Removing unused documentation.

* Updating table to current standards.

* Updating to latest standard.

* Updating to current formatting standards.

* Updating multiline indent rule:

  1)  Updated documentation
  2)  Added align left no align paren on tests
  3)  Updated the following options:
      a)  align_left_yes_align_paren_yes
  4)  Updated docstrings to have correct links.

* Adding example for align_left_no_align_paren_yes.

* Updating documentation per comments.

* Updating documentation per comments.

* Removing option move_last_comment from multiline_structure base rule.
2022-10-20 18:24:42 -05:00
Jeremiah Leary cc1242ee3b Minor updates to documentation. 2022-10-12 07:51:48 -05:00
Jeremiah Leary 6e58ab4a89 Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
Jeremiah Leary 8fb0875376 Attempting to fix ReadTheDocs build. 2021-10-28 07:39:54 -05:00
Jeremiah Leary 20b645660f Updates for issue #632
Fixing invalid command line combination -ap with --fix.

  1)  Updated documentation
  2)  Added test
  3)  Using -ap along with --fix will generate an error
2021-10-13 20:29:53 -05:00
Jeremiah Leary bb6aa6a267 Updates for issue #622
Updating usage documentation.

  1)  Clarified filenames can include paths
  2)  Added examples of using vsg
2021-10-12 07:08:59 -05:00
Jeremiah Leary 950338702a Updates for issue #560
Changed exit code for configuration a depricated rule to 2.
Added documentation for exit codes.
2021-05-13 20:01:54 -05:00
Jeremiah Leary bf51e6c02e Updating docs to prepare for release 3.0.0. 2021-03-16 08:18:37 -05:00
Emil Vanherp 73420cdca2
remove trailing whitespace 2021-01-11 21:55:56 +01:00
Jeremiah Leary 164a837f96 updates for issue #401 and #417:
Added --json command line argument to output violations in JSON format.

  1)  Added tests
  2)  Added code to output violations in JSON format
  3)  Updated documentation

(cherry picked from commit a39839e6466e581900febfc0305ef87adc82b00f)
2020-12-06 11:35:35 -06:00
Jeremiah Leary a3c5beedbd Updates for issue #401 and #416:
Added command line option --all_phases to allow VSG to not stop when a violation was found while analyzing a file.

(cherry picked from commit 43d4498815be9ed3187a34409ea06834d7b6dfce)
2020-12-06 10:43:30 -06:00
Jeremiah Leary 0c721d8866 Updating usage to include new command line options. 2020-07-18 12:32:00 -05:00
Jeremiah Leary 3328f3c2fe Updates for issue #426:
Moved multiple configuration documentation from usage.rst to it's own file and then it is called by configuring.rst.
2020-06-22 21:30:30 -05:00
Jeremiah C Leary 946bef5ed0 Updates for issue #354:
Changing "Violations" to "Rule" in header.
2020-03-27 07:30:29 -05:00
Jeremiah C Leary 3e0da792b2 Updates for issue #354:
Adding link to online documentation.
2020-03-25 16:58:37 -05:00
Jeremiah C Leary a63a30900c Updates for issue #354
Updated usage documentation to show new output format.
Fixed bug where VSG would crash if there was not a violation found.
2020-03-25 16:45:45 -05:00
Jeremiah C Leary 4c962c9bc6 Updates for issue #339:
The configuration of a single rule can be requested:

  1)  Added tests
  2)  Updated documentation
  3)  Updated code
2020-02-22 17:53:31 -06:00
Jeremiah C Leary b49228af3f Updating usage for version argument. 2019-07-03 21:00:43 -05:00
Jeremiah C Leary b287d7cd92 Fixing code example widths.
Minor grammar updates.
2019-03-24 22:07:50 -05:00
Jeremiah C Leary a91f5bb743 Updates for issue #223
Adding documentation for new --output_configuration command line argument
2019-03-24 21:56:48 -05:00
Jeremiah C Leary f906b3890c Reviewing and updating documentation. 2019-03-23 08:49:38 -05:00
Jeremiah C Leary 40206bbac0 Updates for issue #213
Adding documentation about YAML files.
2019-03-09 11:23:00 -06:00
Jeremiah C Leary 43d63c6b3b Updating documentation. 2019-03-02 15:26:57 -06:00
Jeremiah C Leary 27d86f58c4 Updates for issue #201
Globbing of 'file_list' in configurations are now supported.
2019-02-24 13:58:02 -06:00
Jeremiah C Leary 243880e87f Updates for issue #178
1)  Updating documentation to show correct boolean usage in JSON examples.
2018-11-16 22:10:01 -06:00
Jeremiah C Leary 3dc50cc876 Updates for issue #178
1)  Adding documentation for multi configuration option.
2018-11-16 18:52:20 -06:00
Jeremiah C Leary 738ff06054 Fixing documentation warnings. 2018-09-22 09:19:52 -05:00
Jeremiah C Leary f89b7e9391 Updates for issue #153:
1)  Added backup command line option
2018-07-30 22:07:22 -05:00
Jeremiah C Leary edcea7f577 Updates for issue #151:
1)  Added new command line parameter to support multiple outputs
      a)  vsg
      b)  syntastic
  2)  Updated documentation
  3)  Updated tests
2018-06-28 21:56:40 -05:00
Jeremiah C Leary efac84bab2 Updates for issue #149:
1)  Updated documentation to describe --fix_phase command line option
  2)  Added rule documentation for instantiation_001
2018-06-20 19:53:49 -05:00
Jeremiah C Leary 7591715a1a Updating documentation. 2018-05-21 04:56:57 -05:00
Jeremiah C Leary c3eeef5110 Updates for issue #131:
1)  Added "file_list" parsing in configuration file
  2)  Added ability to expand environment variables
  3)  Updated documentation
2018-05-17 05:52:41 -05:00
Jeremiah C Leary 5f415949a9 Minor updates to documentation. 2017-12-23 16:26:16 -06:00
Jeremiah C Leary 790ca38109 Updated user documentation. 2017-12-15 14:23:07 -06:00
Jeremiah C Leary 5da712cfcc Updating documentation. 2017-12-03 16:48:47 -06:00