From 436c42abf99a268684f3d4c85d4cffd1c2636bc2 Mon Sep 17 00:00:00 2001
From: Abel Soares Siqueira <abel.siqueira@esciencecenter.nl>
Date: Wed, 4 Sep 2024 16:18:05 +0200
Subject: [PATCH] Make lychee configuration to a hidden file .lychee.toml

Move lychee.toml to .lychee.toml to make it hidden.
Local calls to lychee now require .

Closes #388
---
 .github/workflows/Lint.yml                         | 1 +
 lychee.toml => .lychee.toml                        | 0
 CHANGELOG.md                                       | 1 +
 docs/src/20-explanation.md                         | 2 +-
 template/.github/workflows/Lint.yml.jinja          | 1 +
 template/{lychee.toml.jinja => .lychee.toml.jinja} | 0
 6 files changed, 4 insertions(+), 1 deletion(-)
 rename lychee.toml => .lychee.toml (100%)
 rename template/{lychee.toml.jinja => .lychee.toml.jinja} (100%)

diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml
index d7ba1d15..388a8ffc 100644
--- a/.github/workflows/Lint.yml
+++ b/.github/workflows/Lint.yml
@@ -53,3 +53,4 @@ jobs:
         uses: lycheeverse/lychee-action@v1
         with:
           fail: true
+          args: --config '.lychee.toml' .
diff --git a/lychee.toml b/.lychee.toml
similarity index 100%
rename from lychee.toml
rename to .lychee.toml
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b692de01..432a063e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning].
 - Update pre-commit hook versions
   - JuliaFormatter 1.0.58 -> 1.0.59
 - Default Indentation changed from 2 to 4 (#403)
+- Change lychee configuration to a hidden file `.lychee.toml`
 
 ## [0.9.1] - 2024-07-24
 
diff --git a/docs/src/20-explanation.md b/docs/src/20-explanation.md
index dd47e490..30bafd76 100644
--- a/docs/src/20-explanation.md
+++ b/docs/src/20-explanation.md
@@ -158,7 +158,7 @@ Installing pre-commit (`pre-commit install`) will make sure that it runs the rel
 Furthermore, if you run `pre-commit run -a`, it runs all hooks.
 
 Some hooks in the `.pre-commit-config.yaml` file have configuration files of their own:
-`.JuliaFormatter.toml`, `.markdownlint.json`, `lychee.toml`, and `.yamllint.yml`.
+`.JuliaFormatter.toml`, `.markdownlint.json`, `.lychee.toml`, and `.yamllint.yml`.
 
 Also slightly related, is the `.editorconfig` file, which tells your editor, if you install the correct plugin, how to format some things.
 
diff --git a/template/.github/workflows/Lint.yml.jinja b/template/.github/workflows/Lint.yml.jinja
index 0da6eccf..c4b0283b 100644
--- a/template/.github/workflows/Lint.yml.jinja
+++ b/template/.github/workflows/Lint.yml.jinja
@@ -54,3 +54,4 @@ jobs:
         uses: lycheeverse/lychee-action@v1
         with:
           fail: true
+          args: --config '.lychee.toml' .
diff --git a/template/lychee.toml.jinja b/template/.lychee.toml.jinja
similarity index 100%
rename from template/lychee.toml.jinja
rename to template/.lychee.toml.jinja