Skip to content

Commit 21d3961

Browse files
fix: add false positives for README update block validation
1 parent e326f04 commit 21d3961

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

scripts/check-modules/index.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,12 @@ const README_TRAILING_COMMA_FALSE_POSITIVES = new Set([
376376
"MMM-Remote-Control"
377377
]);
378378
const README_INSTALL_BLOCK_FALSE_POSITIVES = new Set([
379+
"MMM-CalendarExt3",
379380
"MMM-Remote-Control"
380381
]);
382+
const README_UPDATE_BLOCK_FALSE_POSITIVES = new Set([
383+
"MMM-CalendarExt3"
384+
]);
381385
const MISSING_DEPENDENCY_EXCEPTIONS = new Set([
382386
"electron",
383387
"pm2"
@@ -924,7 +928,10 @@ async function analyzeModule({ module, moduleDir, issues, config }) {
924928
issues,
925929
"Recommendation: The README seems not to have an update section (like `## Update`). Please add one ([basic instructions](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/readme_bestpractices.md#Update-Instructions))."
926930
);
927-
} else if (!sectionHasCopyableCommandBlock(updateSection.content)) {
931+
} else if (
932+
!sectionHasCopyableCommandBlock(updateSection.content) &&
933+
!README_UPDATE_BLOCK_FALSE_POSITIVES.has(module.name)
934+
) {
928935
addIssue(
929936
issues,
930937
"Recommendation: The README's update section should provide a copyable fenced command block (for example ```bash ...). Please add one so users can update the module quickly ([basic instructions](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/readme_bestpractices.md#Update-Instructions))."

0 commit comments

Comments
 (0)