Merge pull request #6 from boozt-platform/feat-add-markdown-lint

feat: add yaml, json and markdown linters

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: Report a bug
+about: Found something broken? Let us know! If it's not yet reproducible,
+please `Ask a question` instead.
+labels: 'bug'
+---
+
+<!-- markdownlint-disable -->
+### Summary
+
+<!-- A brief summary of the problem. -->
+
+### Lefthook version
+
+<!-- The result of `lefthook version -f` -->
+
+### Steps to reproduce
+
+<!-- All bug reports should include detailed steps to reproduce -->
+
+### Expected results
+
+<!-- Outline what you expected to see -->
+
+### Actual results
+
+<!-- Outline the actual results -->
+
+### Possible Solution
+
+<!--- Optionally suggest a fix or reason for the bug -->
+
+### Logs / Screenshots
+
+<!---
+If the error can be reproduced via GUI or CLI command, please send the logs.
+Make sure you have set LEFTHOOK_VERBOSE=true before running the command.
+-->
+
+```bash
+LEFTHOOK_VERBOSE=true git ...
+```
+
+<!-- markdownlint restore -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: Copyright Boozt Fashion, AB
+# SPDX-License-Identifier: MIT
+---
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Want to add a new hook or improve it? Create a feature request!
+labels: 'feature request'
+---
+
+<!-- markdownlint-disable -->
+### Summary
+
+<!-- A brief summary of a feature. -->
+
+### Value
+
+<!-- A few words about what problem it is solving or how it makes life easier. -->
+
+### Behavior and configuration changes
+
+<!-- What should be changed in current behavior/configuration? -->
+
+<!-- markdownlint restore -->

.github/pull_request_template.md

@@ -1,19 +1,17 @@
-- **Description**: <!-- Briefly describe the changes made in this pull request. -->
-- **Current Behavior**: <!-- Describe the current behavior, or link to an open issue if applicable. -->
-- **New Behavior**: <!-- Describe the new behavior introduced by this PR, especially if it's a feature change. -->
-- **Breaking Changes**: <!-- Does this PR introduce any breaking changes? If so, provide guidelines to support backward compatibility and inform users how to resolve potential issues. -->
-- **Type of Change**: <!-- What kind of change does this PR introduce? (Bug fix, feature, docs update, etc.) -->
+<!-- markdownlint-disable -->
 
-<!--
+Closes # (issue)
 
-- Please review the CONTRIBUTING file for guidelines on contributing to this project.
-- Ensure that your commit messages follow the conventional commits guidelines.
-- Double-check if any documentation needs to be updated within your changes.
-- Have tests been added to cover the changes made?
+<!-- Link to an issue(s) this PR fixes -->
 
-### Additional Information
+#### Summary
 
-Please provide any additional information or context that may be relevant to this pull request.
+<!-- Brief description of what was done -->
 
-Thank you for your contribution to our project!
--->
+#### Checklist
+
+- [ ] Check locally
+- [ ] Add tests
+- [ ] Add documentation
+
+<!-- markdownlint restore -->

.github/workflows/release.yml

@@ -1,8 +1,9 @@
 # SPDX-FileCopyrightText: Copyright Boozt Fashion, AB
 # SPDX-License-Identifier: MIT
 
+---
 name: Release
-on:
+"on":
   push:
     branches:
       - 'main'

.goreleaser.yaml

@@ -3,12 +3,13 @@
 
 # For more information about the configuration file, see:
 # https://goreleaser.com/customization/build/
-
+---
 builds:
-  # By default we don't let to release packages. Our consideration is to use SemVer
-  # based by conventional commits to release new versions of the project once it's
-  # merged to the main branch. If this is a Go project, you can remove this section
-  # and use the default configuration to release the packages within the new version.
+  # By default we don't let to release packages. Our consideration is to use
+  # SemVer based by conventional commits to release new versions of the project
+  # once it's merged to the main branch. If this is a Go project, you can
+  # remove this section and use the default configuration to release the
+  # packages within the new version.
   - skip: true
 
 checksum:

.lefthook.yaml

@@ -1,12 +1,14 @@
 # SPDX-FileCopyrightText: Copyright Boozt Fashion, AB
 # SPDX-License-Identifier: MIT
-
+---
 extends:
   # lint commit messages based by the conventional commits
   - hooks/commitlint/.lefthook.yaml
-  # lint Dockerfiles
-  - hooks/hadolint/.lefthook.yaml
   # lint shell scripts
   - hooks/shellcheck/.lefthook.yaml
   # check if the license headers are present in the files
   - hooks/license-checker/.lefthook.yaml
+  # lint the markdown (.md) files
+  - hooks/markdown-lint/.lefthook.yaml
+  # lint the yaml (.yml, .yaml) files
+  - hooks/yamllint/.lefthook.yaml

.lefthook/pre-commit/license-checker.sh

@@ -4,19 +4,22 @@
 # SPDX-License-Identifier: MIT
 
 # Script is a pre-commit hook to check if the staged files
-# has the license header from the file license-header.txt (we only check if it's contains).
+# has the license header from the file license-header.txt or the
+# environment variable called LICENSE_HEADER (we only check if
+# it's contains).
 
 set -eo pipefail
 
-# include .license-checker file if exists in the root directory
-if [ -f .license-checker ]; then
-    # shellcheck source=/dev/null
-    source .license-checker
-fi
-
-EXCLUDE_FILES_EXT=${EXCLUDE_FILES_EXT:-"LICENSE|\\.md|\\.gitignore|\\.license-checker|CODEOWNERS|\\.gitattributes|\\.editorconfig|\\.json|\\.lock|\\.toml"}
+LICENSE_HEADER=${LICENSE_HEADER:-""}
+EXCLUDE_FILES_EXT=${EXCLUDE_FILES_EXT:-"LICENSE|\\.md|\\.gitignore|\\.license-checker.txt|CODEOWNERS|\\.gitattributes|\\.editorconfig|\\.json|\\.lock|\\.toml"}
 STAGED_FILES=$(git diff --name-only --diff-filter=d --staged)
 
+# read .license-checker.txt file if exists in the root directory
+if [[ -f .license-checker.txt && -z "$LICENSE_HEADER" ]]; then
+    # read the file and set the LICENSE_HEADER variable
+    LICENSE_HEADER=$(cat .license-checker.txt)
+fi
+
 # error message function printing in red color
 # usage: error "message"
 error() {
@@ -27,7 +30,7 @@ error() {
 # if the LICENSE_HEADER is empty, then exit
 if [ -z "$LICENSE_HEADER" ]; then
     error "The LICENSE_HEADER environment variable is empty."
-    error "Either create .license-checker file in the root directory or set the LICENSE_HEADER environment variable."
+    error "Either create .license-checker.txt file in the root directory or set the LICENSE_HEADER environment variable."
     exit 1
 fi
 

.license-checker → .license-checker.txt

@@ -1,5 +1,2 @@
-LICENSE_HEADER=$(cat <<EOF
 SPDX-FileCopyrightText: Copyright Boozt Fashion, AB
 SPDX-License-Identifier: MIT
-EOF
-)