From cc55027cb4a5edfcaf42317a4aca8c35516d1598 Mon Sep 17 00:00:00 2001 From: Pablo Hdez <62877300+pheralb@users.noreply.github.com> Date: Tue, 30 Jan 2024 18:25:09 +0000 Subject: [PATCH] =?UTF-8?q?feat:=20=E2=9C=A8=20Add=20``lychee``=20workflow?= =?UTF-8?q?=20&=20new=20components=20library=20(#47)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: add ``lychee`` command to check links * feat: initial custom ``lychee`` config * feat: initial check-links action with lychee * feat: add new components library * fix: update ``exclude`` links * feat: update components menu with new date --- .github/workflows/check-links.yml | 16 +++++++++++ docs/frontend/components_library.mdx | 14 ++++++++++ docs/menu.mdx | 2 +- lychee.toml | 40 ++++++++++++++++++++++++++++ package.json | 3 ++- 5 files changed, 73 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/check-links.yml create mode 100644 lychee.toml diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 0000000..0a9f49c --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,16 @@ +name: Links + +on: [push] + +jobs: + linkChecker: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Link Checker + id: lychee + uses: lycheeverse/lychee-action@v1.9.0 + with: + fail: true + args: --config './lychee.toml' . \ No newline at end of file diff --git a/docs/frontend/components_library.mdx b/docs/frontend/components_library.mdx index de7118d..65ed234 100644 --- a/docs/frontend/components_library.mdx +++ b/docs/frontend/components_library.mdx @@ -6,6 +6,7 @@ contributors: - github_username: 'nsdonato' - github_username: 'gonzalochale' - github_username: 'rodrigaocabrera' + - github_username: 'pheralb' submenu: - imgPlaceholder: 'Shadcn' @@ -215,4 +216,17 @@ submenu: createdAt: '2024-01-28T00:00:00Z' updatedAt: '2024-01-28T00:00:00Z' videos: [] + + - imgPlaceholder: 'Buttons ibelick' + titleCard: 'Buttons ibelick' + links: + - type: 'Web' + url: 'https://buttons.ibelick.com/' + cover: + src: '' + height: 80 + width: 190 + createdAt: '2024-01-30T00:00:00Z' + updatedAt: '2024-01-30T00:00:00Z' + videos: [] --- diff --git a/docs/menu.mdx b/docs/menu.mdx index b1a1dd7..7e8246e 100644 --- a/docs/menu.mdx +++ b/docs/menu.mdx @@ -43,7 +43,7 @@ menu: - name: 'Componentes' url: '/docs/frontend/components_library' createdAt: '2024-01-14T00:00:00Z' - updatedAt: '2024-01-27T00:00:00Z' + updatedAt: '2024-01-30T00:00:00Z' - name: 'Dominios' url: '/docs/frontend/domains' diff --git a/lychee.toml b/lychee.toml new file mode 100644 index 0000000..3ad0905 --- /dev/null +++ b/lychee.toml @@ -0,0 +1,40 @@ +############################# Display ############################# + +# Verbose program output +# Accepts log level: "error", "warn", "info", "debug", "trace" +verbose = "info" + +############################# Exclusions ########################## + +# Skip missing input files (default is to error if they don't exist). +skip_missing = false + +# Check links inside `` and `
` blocks as well as Markdown code
+# blocks.
+include_verbatim = false
+
+# Ignore case of paths when matching glob patterns.
+glob_ignore_case = false
+
+# Exclude URLs and mail addresses from checking (supports regex).
+exclude = ['^https://www\.twitter\.com', '^https://twitter\.com', '^https://discord\.io', '^https://discord\.com', 'https://github.com/nsdonato/recursostech/']
+
+# Exclude these filesystem paths from getting checked.
+exclude_path = ["./.git", "./.github", "./app", "./public", "./docs/doc_template_general.mdx"]
+
+# Exclude all private IPs from checking.
+# Equivalent to setting `exclude_private`, `exclude_link_local`, and
+# `exclude_loopback` to true.
+exclude_all_private = false
+
+# Exclude private IP address ranges from checking.
+exclude_private = false
+
+# Exclude link-local IP address range from checking.
+exclude_link_local = false
+
+# Exclude loopback IP address range and localhost from checking.
+exclude_loopback = false
+
+# Check mail addresses
+include_mail = false
\ No newline at end of file
diff --git a/package.json b/package.json
index 438c846..7e0cd69 100644
--- a/package.json
+++ b/package.json
@@ -12,7 +12,8 @@
 		"test:watch": "jest --watch",
 		"format": "prettier -w -u .",
 		"prepare": "husky install",
-		"tsc": "tsc"
+		"tsc": "tsc",
+		"check-links": "lychee --config './lychee.toml' ."
 	},
 	"dependencies": {
 		"@radix-ui/react-icons": "^1.3.0",