Merge pull request #9 from zarhus/add-pre-commit

pre-commit: add pre-commit

Author: DaniilKl

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+exclude-file = .codespellx
+ignore-words-list = FPT,FTP,fpt,ftp,SoM

.codespellx

@@ -0,0 +1,16 @@
+---
+policies:
+  - type: commit
+    spec:
+      header:
+        length: 80
+        imperative: false
+        invalidLastCharacters: .
+      body:
+        required: false
+      dco: true
+      gpg:
+        required: true
+      spellcheck:
+        locale: US
+      maximumOfOneCommit: false

.conform.yaml

@@ -0,0 +1,3 @@
+https://fosstodon.org/@TBD
+https://twitter.com/TBD
+https://www.reddit.com/r/TBD

.lycheeignore

@@ -0,0 +1,196 @@
+---
+# Documentation:
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+
+# Default state for all rules
+default: false
+
+# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
+MD001: true
+
+# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
+MD002:
+  # Heading level
+  level: 1
+
+# MD003/heading-style/header-style - Heading style
+
+MD003:
+  # Heading style
+  # # ATX style H1
+  style: "atx"
+
+# MD004/ul-style - Unordered list style
+MD004:
+  # List style
+  style: "sublist"
+
+# MD005/list-indent - Inconsistent indentation for list items at the same level
+MD005: true
+
+# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line
+MD006: true
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 4
+  # Whether to indent the first level of the list
+  start_indented: false
+
+# MD009/no-trailing-spaces - Trailing spaces
+MD009:
+  # Spaces for line break
+  br_spaces: 2
+  # Allow spaces for empty lines in list items
+  list_item_empty_lines: false
+  # Include unnecessary breaks
+  strict: false
+
+# MD010/no-hard-tabs - Hard tabs
+MD010:
+  # Include code blocks
+  code_blocks: false
+  # Number of spaces for each hard tab
+  spaces_per_tab: 1
+
+# MD011/no-reversed-links - Reversed link syntax
+MD011: true
+
+# MD012/no-multiple-blanks - Multiple consecutive blank lines
+MD012:
+  # Consecutive blank lines
+  maximum: 1
+# MD013/line-length - Line length
+#
+MD013:
+  # Number of characters
+  line_length: 80
+  # Number of characters for headings
+  heading_line_length: 80
+  # Number of characters for code blocks
+  code_block_line_length: 160
+  # Include code blocks
+  code_blocks: false
+  # Include tables
+  tables: false
+  # Include headings
+  headings: true
+  # Strict length checking (e.g. allow for longer URLs)
+  strict: false
+  # Stern length checking
+  stern: false
+
+# MD014/commands-show-output - Dollar signs used before commands without showing output
+# TODO: set false for now but we should consider enabling it
+# https://cirosantilli.com/markdown-style-guide#dollar-signs-in-shell-code
+MD014: false
+
+# MD018/no-missing-space-atx - No space after hash on atx style heading
+MD018: true
+
+# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
+MD019: true
+
+# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
+MD022:
+  # Blank lines above heading
+  lines_above: 1
+  # Blank lines below heading
+  lines_below: 1
+
+# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
+MD023: true
+
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+# TODO: consider enabling it
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
+
+# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
+MD027: true
+
+# MD028/no-blanks-blockquote - Blank line inside blockquote
+MD028: true
+
+# MD029/ol-prefix - Ordered list item prefix
+MD029:
+  # List style
+  style: "one_or_ordered"
+
+# MD030/list-marker-space - Spaces after list markers
+MD030:
+  # Spaces for single-line unordered list items
+  ul_single: 1
+  # Spaces for single-line ordered list items
+  ol_single: 1
+  # Spaces for multi-line unordered list items
+  ul_multi: 1
+  # Spaces for multi-line ordered list items
+  ol_multi: 1
+
+# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
+MD031:
+  # Include list items
+  list_items: true
+
+# # MD033/no-inline-html - Inline HTML
+# MD033:
+#   # Allowed elements
+#   allowed_elements: ["br", "center", "img", "script", "form", "input"]
+
+# MD034/no-bare-urls - Bare URL used
+MD034: true
+
+# MD035/hr-style - Horizontal rule style
+MD035:
+  # Horizontal rule style
+  style: "---"
+
+# MD037/no-space-in-emphasis - Spaces inside emphasis markers
+MD037: true
+
+# MD038/no-space-in-code - Spaces inside code span elements
+MD038: true
+
+# MD039/no-space-in-links - Spaces inside link text
+MD039: true
+
+# MD040/fenced-code-language - Fenced code blocks should have a language specified
+MD040: true
+
+# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD042/no-empty-links - No empty links
+MD042: true
+
+# # MD046/code-block-style - Code block style
+# MD046:
+#   # Block style
+#   style: "fenced"
+
+# MD047/single-trailing-newline - Files should end with a single newline character
+MD047: true
+
+# MD048/code-fence-style - Code fence style
+MD048:
+  # Code fence style
+  style: "backtick"
+
+# MD049/emphasis-style - Emphasis style should be consistent
+MD049:
+  # Emphasis style should be consistent
+  style: "underscore"
+
+# MD050/strong-style - Strong style should be consistent
+MD050:
+  # Strong style should be consistent
+  style: "asterisk"

.markdownlint.yaml

@@ -0,0 +1,61 @@
+---
+default_stages: [pre-commit]
+
+default_install_hook_types: [pre-commit, commit-msg]
+
+exclude: (^vendor/|.*\.pdf|.*\.svg$)
+
+ci:
+  autoupdate_commit_msg: 'pre-commit: autoupdate hooks'
+  autofix_prs: false
+  # docker is not supported on pre-commit.ci
+  skip: [shellcheck]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: ^.*\.patch$
+      - id: mixed-line-ending
+        exclude: ^.*\.patch$
+
+  - repo: https://github.com/talos-systems/conform
+    rev: v0.1.0-alpha.30
+    hooks:
+      - id: conform
+        stages:
+          - commit-msg
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: [-c=.yamllint]
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.41.0
+    hooks:
+      - id: markdownlint
+      - id: markdownlint-fix
+
+  - repo: https://github.com/lycheeverse/lychee
+    rev: v0.15.1
+    hooks:
+      - id: lychee-docker
+        # Optionally include additional CLI arguments
+        args: [
+          "--no-progress", "--exclude", "file://", "--exclude", "0.0.0.0",
+          "--exclude", ".git", "--timeout", "10",
+          "--exclude-all-private", "-m", "10", "-q"
+        ]

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+---
+extends: default
+
+rules:
+  comments:
+    require-starting-space: true
+    ignore-shebangs: true
+    min-spaces-from-content: 2
+  document-start:
+    present: true
+    level: error
+  indentation:
+    spaces: 2
+  line-length: disable
+  truthy:
+    check-keys: false

.yamllint

@@ -56,29 +56,26 @@ mkdocs.yml)
 
 There should be no TBD or TODO visible on the website.
 
-<!--
 ### pre-commit hooks
 
 - [Install pre-commit](https://pre-commit.com/index.html#install), if you
   followed [local build](#local-build) procedure `pre-commit` should be
   installed
 
-- [Install go](https://go.dev/doc/install)
-
 - Install hooks into repo:
 
-```shell
-pre-commit install
-```
+  ```shell
+  pre-commit install
+  ```
 
 - Enjoy automatic checks on each `git commit` action!
 
 - (Optional) Run hooks on all files (for example, when adding new hooks or
   configuring existing ones):
 
-```shell
-pre-commit run --all-files
-```
+  ```shell
+  pre-commit run --all-files
+  ```
 
 #### To skip verification
 
@@ -88,11 +85,10 @@ use:
 ```shell
 git commit --no-verify
 ```
--->
 
 ### Embedding videos
 
 Embedding videos with in-line HTML `iframe` tag does not work.
 [mkdocs-video](https://github.com/soulless-viewer/mkdocs-video) plugin is used
 instead. To embed an video simply type the following in markdown:
-`![type:video](https://www.youtube.com/embed/LXb3EKWsInQ)` (example).
+`![type:video](https://www.youtube.com/embed/LXb3EKWsInQ)` (example).

README.md

@@ -1 +1 @@
-docs.zarhus.com
+docs.zarhus.com

docs/CNAME

@@ -31,7 +31,7 @@ Currently, we use following custom layers:
       +----------+----------------+   +---------+-----------------+
       |                           |   |                           |
       |       BSP layers          |   |      Software layers      |
-      |   (hardware depended)     |   |   (hardware independed)   |
+      |   (hardware dependent)    |   |   (hardware independent)  |
       |                           |   |                           |
       | +------------------------+|   | +------------+            |
       | |meta-zarhus-bsp-rockchip||   | | meta-zarhus|            |