From 393aa12ae2cfa52eb55199137c7362a207d2df4c Mon Sep 17 00:00:00 2001 From: silverwind Date: Mon, 25 Mar 2024 23:29:59 +0100 Subject: [PATCH 1/5] Add svg linter and fix incorrect svgs --- .github/workflows/pull-compliance.yml | 4 ++++ Makefile | 3 ++- templates/devtest/flex-list.tmpl | 4 ++-- templates/repo/diff/comment_form.tmpl | 2 +- tools/lint-templates-svg.js | 26 ++++++++++++++++++++++++++ 5 files changed, 35 insertions(+), 4 deletions(-) create mode 100755 tools/lint-templates-svg.js diff --git a/.github/workflows/pull-compliance.yml b/.github/workflows/pull-compliance.yml index 02a265b1ffdad..99a69ab174957 100644 --- a/.github/workflows/pull-compliance.yml +++ b/.github/workflows/pull-compliance.yml @@ -35,8 +35,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: "3.12" + - uses: actions/setup-node@v4 + with: + node-version: 20 - run: pip install poetry - run: make deps-py + - run: make deps-frontend - run: make lint-templates lint-yaml: diff --git a/Makefile b/Makefile index 236f115a2f27b..a7e175e76b479 100644 --- a/Makefile +++ b/Makefile @@ -434,7 +434,8 @@ lint-actions: $(GO) run $(ACTIONLINT_PACKAGE) .PHONY: lint-templates -lint-templates: .venv +lint-templates: .venv node_modules + @node tools/lint-templates-svg.js @poetry run djlint $(shell find templates -type f -iname '*.tmpl') .PHONY: lint-yaml diff --git a/templates/devtest/flex-list.tmpl b/templates/devtest/flex-list.tmpl index d5678566d8846..015ab1e154631 100644 --- a/templates/devtest/flex-list.tmpl +++ b/templates/devtest/flex-list.tmpl @@ -25,7 +25,7 @@
diff --git a/templates/repo/diff/comment_form.tmpl b/templates/repo/diff/comment_form.tmpl index 6a5dec6c48bf0..856b3da01a345 100644 --- a/templates/repo/diff/comment_form.tmpl +++ b/templates/repo/diff/comment_form.tmpl @@ -26,7 +26,7 @@ {{end}}
- {{svg "octicon-markup"}} {{ctx.Locale.Tr "repo.diff.comment.markdown_info"}} + {{svg "octicon-markdown"}} {{ctx.Locale.Tr "repo.diff.comment.markdown_info"}}
{{if $.reply}} diff --git a/tools/lint-templates-svg.js b/tools/lint-templates-svg.js new file mode 100755 index 0000000000000..e7b0b91112204 --- /dev/null +++ b/tools/lint-templates-svg.js @@ -0,0 +1,26 @@ +#!/usr/bin/env node +import {readdirSync, readFileSync} from 'node:fs'; +import {parse, relative} from 'node:path'; +import {fileURLToPath} from 'node:url'; +import {exit} from 'node:process'; +import fastGlob from 'fast-glob'; + +const knownSvgs = new Set(); +for (const file of readdirSync(new URL('../public/assets/img/svg', import.meta.url))) { + knownSvgs.add(parse(file).name); +} + +const rootPath = fileURLToPath(new URL('..', import.meta.url)); +let hadErrors = false; + +for (const file of fastGlob.sync(fileURLToPath(new URL('../templates/**/*.tmpl', import.meta.url)))) { + const content = readFileSync(file, 'utf8'); + for (const [_, name] of content.matchAll(/svg ["'`]([a-z0-9-]+)["'`]/g)) { + if (!knownSvgs.has(name)) { + console.info(`SVG "${name}" not found, used in ${relative(rootPath, file)}`); + hadErrors = true; + } + } +} + +exit(hadErrors ? 1 : 0); From 318f3e7201cb07ab1ccb6b10b9ea2e92e54505c5 Mon Sep 17 00:00:00 2001 From: silverwind Date: Mon, 25 Mar 2024 23:38:08 +0100 Subject: [PATCH 2/5] insensitive --- tools/lint-templates-svg.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/lint-templates-svg.js b/tools/lint-templates-svg.js index e7b0b91112204..663e079de408f 100755 --- a/tools/lint-templates-svg.js +++ b/tools/lint-templates-svg.js @@ -15,7 +15,7 @@ let hadErrors = false; for (const file of fastGlob.sync(fileURLToPath(new URL('../templates/**/*.tmpl', import.meta.url)))) { const content = readFileSync(file, 'utf8'); - for (const [_, name] of content.matchAll(/svg ["'`]([a-z0-9-]+)["'`]/g)) { + for (const [_, name] of content.matchAll(/svg ["'`]([a-z0-9-]+)["'`]/gi)) { if (!knownSvgs.has(name)) { console.info(`SVG "${name}" not found, used in ${relative(rootPath, file)}`); hadErrors = true; From 66aebb3182bf6087893382bcdae5404e3a4b79d2 Mon Sep 17 00:00:00 2001 From: silverwind Date: Mon, 25 Mar 2024 23:39:48 +0100 Subject: [PATCH 3/5] better regex --- tools/lint-templates-svg.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/lint-templates-svg.js b/tools/lint-templates-svg.js index 663e079de408f..74692bd90e07b 100755 --- a/tools/lint-templates-svg.js +++ b/tools/lint-templates-svg.js @@ -15,7 +15,7 @@ let hadErrors = false; for (const file of fastGlob.sync(fileURLToPath(new URL('../templates/**/*.tmpl', import.meta.url)))) { const content = readFileSync(file, 'utf8'); - for (const [_, name] of content.matchAll(/svg ["'`]([a-z0-9-]+)["'`]/gi)) { + for (const [_, name] of content.matchAll(/svg ["'`]([^"'`]+?)["'`]/g)) { if (!knownSvgs.has(name)) { console.info(`SVG "${name}" not found, used in ${relative(rootPath, file)}`); hadErrors = true; From 88dfe34ecd41cba1fede2d30929ddceec21e7b30 Mon Sep 17 00:00:00 2001 From: silverwind Date: Mon, 25 Mar 2024 23:46:14 +0100 Subject: [PATCH 4/5] fix lint --- tools/lint-templates-svg.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/lint-templates-svg.js b/tools/lint-templates-svg.js index 74692bd90e07b..72f756400de2f 100755 --- a/tools/lint-templates-svg.js +++ b/tools/lint-templates-svg.js @@ -15,7 +15,7 @@ let hadErrors = false; for (const file of fastGlob.sync(fileURLToPath(new URL('../templates/**/*.tmpl', import.meta.url)))) { const content = readFileSync(file, 'utf8'); - for (const [_, name] of content.matchAll(/svg ["'`]([^"'`]+?)["'`]/g)) { + for (const [_, name] of content.matchAll(/svg ["'`]([^"'`]+)["'`]/g)) { if (!knownSvgs.has(name)) { console.info(`SVG "${name}" not found, used in ${relative(rootPath, file)}`); hadErrors = true; From cac1eb96ed2287dc0fc8c61a57b770d639c8a77c Mon Sep 17 00:00:00 2001 From: silverwind Date: Tue, 26 Mar 2024 01:23:10 +0100 Subject: [PATCH 5/5] add script to templates files-changed --- .github/workflows/files-changed.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/files-changed.yml b/.github/workflows/files-changed.yml index f9b6b1ec495c1..b8535cb42b267 100644 --- a/.github/workflows/files-changed.yml +++ b/.github/workflows/files-changed.yml @@ -73,6 +73,7 @@ jobs: - "Makefile" templates: + - "tools/lint-templates-*.js" - "templates/**/*.tmpl" - "pyproject.toml" - "poetry.lock"