Add a ton of pre-commit checks (#84)

* Add prettier

* Add cspell

* Add passing hooks

* Add codespell

* Add yamllint

* Add pylint

Author: Qalthos

.config/dictionary.txt

@@ -0,0 +1,44 @@
+# Ansible jargon
+cliconf
+devel
+fqcn
+hostvars
+httpapi
+netcommon
+netconf
+restconf
+# Resource modules and filter plugins
+acls
+cidr
+hwaddr
+ipaddr
+ipmath
+ipsubnet
+ipwrap
+lacp
+linkagg
+macaddr
+nthhost
+ospfv
+slaac
+# Python packages
+argcomplete
+redbaron
+ruamel
+textfsm
+# Jijna / RST / HTML directives
+colspan
+darkgreen
+dictsort
+endfor
+htmlify
+HORIZONTALLINE
+larr
+nbsp
+sameas
+seealso
+tojson
+# Misc
+bthornto
+levelname
+suboptions

.pre-commit-config.yaml

@@ -8,22 +8,65 @@ repos:
           - "--fix"
           - "--exit-non-zero-on-fix"
 
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.0-alpha.6"
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - prettier
+          - prettier-plugin-toml
+
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
 
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v6.31.0
+    hooks:
+      - id: cspell
+        name: Spell check with cspell
+
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.4.2
+    hooks:
+      - id: remove-tabs
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: check-merge-conflict
       - id: check-symlinks
       - id: debug-statements
       - id: end-of-file-fixer
+      - id: fix-byte-order-marker
       - id: no-commit-to-branch
       - id: trailing-whitespace
 
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.30.0
+    hooks:
+      - id: yamllint
+        args:
+          - --strict
+        types: [file, yaml]
+
   - repo: https://github.com/terrencepreilly/darglint
     rev: v1.8.1
     hooks:
       - id: darglint
+
+  - repo: https://github.com/pycqa/pylint
+    rev: v2.17.1
+    hooks:
+      - id: pylint
+        additional_dependencies:
+          - ansible-core
+          - pyyaml
+          - redbaron
+          - ruamel.yaml

README.md

@@ -1,13 +1,13 @@
 # Collection Prep Engine
 
-
 ## INSTALLATION
 
 ```console
 pip install .
 ```
 
 ## CONTENT UPDATER
+
 ```console
 collection_prep_update -c arista.eos -p ./
 ```
@@ -17,15 +17,15 @@ INFO      -------------------Processing ./arista.eos/plugins/modules/eos_lacp.py
 INFO      Updated metadata in ./arista.eos/plugins/modules/eos_lacp.py
 INFO      Updated documentation in ./arista.eos/plugins/modules/eos_lacp.py
 INFO      Found a resource module
-INFO      Setting short desciption to 'LACP resource module'
+INFO      Setting short description to 'LACP resource module'
 INFO      Updated examples in ./arista.eos/plugins/modules/eos_lacp.py
 INFO      Wrote ./arista.eos/plugins/modules/eos_lacp.py
 INFO      Running black against ./arista.eos/plugins/modules/eos_lacp.py
 INFO      -------------------Processing ./arista.eos/plugins/modules/eos_static_routes.py
 INFO      Updated metadata in ./arista.eos/plugins/modules/eos_static_routes.py
 INFO      Updated documentation in ./arista.eos/plugins/modules/eos_static_routes.py
 INFO      Found a resource module
-INFO      Setting short desciption to 'Static routes resource module'
+INFO      Setting short description to 'Static routes resource module'
 INFO      Updated examples in ./arista.eos/plugins/modules/eos_static_routes.py
 INFO      Wrote ./arista.eos/plugins/modules/eos_static_routes.py
 INFO      Running black against ./arista.eos/plugins/modules/eos_static_routes.py
@@ -43,12 +43,14 @@ This will generate an RST file for each plugin in the collection docs folder and
 This will also pull the requires_ansible information from the runtime.yml file and add an ansible compatibility section to the README.
 
 For the ansible compatibility, ensure the collection README.md has the following in it:
+
 ```
 <!--start requires_ansible-->
 <!--end requires_ansible-->
 ```
 
 For the plugin table, ensure the collection README.md has the following in it:
+
 ```
 
 <!--start collection content-->
@@ -65,8 +67,8 @@ INFO      Setting github repository url to https://github.com/ansible-collection
 INFO      Linking collection to user collection directory
 INFO      This is required for the Ansible fragment loader to find doc fragments
 INFO      Attempting to remove existing /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
-INFO      Deleteing: /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
-INFO      Creating namepsace directory /home/bthornto/.ansible/collections/ansible_collections/ansible
+INFO      Deleting: /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
+INFO      Creating namespace directory /home/bthornto/.ansible/collections/ansible_collections/ansible
 INFO      Linking collection /home/bthornto/github/collection_update/ansible.netcommon -> /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
 INFO      Purging content from directory /home/bthornto/github/collection_update/ansible.netcommon/docs
 INFO      Making docs directory /home/bthornto/github/collection_update/ansible.netcommon/docs
@@ -119,9 +121,11 @@ INFO      README.md updated
 ## meta/runtime.yml GENERATOR
 
 This is intended to operate against the repository clone.
+
 ```console
 collection_prep_runtime -c arista.eos -p ./
 ```
+
 ```console
 INFO      -------------------Processing runtime.yml for module eos_acl_interfaces
 INFO      -------------------Processing runtime.yml for module eos_acls