Skip to content

Commit e326f04

Browse files
fix: add false positives for README install block validation
1 parent b6e94f9 commit e326f04

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

scripts/check-modules/index.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,9 @@ const README_TRAILING_COMMA_FALSE_POSITIVES = new Set([
375375
"MMM-MealieMenu",
376376
"MMM-Remote-Control"
377377
]);
378+
const README_INSTALL_BLOCK_FALSE_POSITIVES = new Set([
379+
"MMM-Remote-Control"
380+
]);
378381
const MISSING_DEPENDENCY_EXCEPTIONS = new Set([
379382
"electron",
380383
"pm2"
@@ -933,7 +936,10 @@ async function analyzeModule({ module, moduleDir, issues, config }) {
933936
issues,
934937
"Recommendation: The README seems not to have an install section (like `## Installation`). Please add one ([basic instructions](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/readme_bestpractices.md#Installation-Instructions))."
935938
);
936-
} else if (!sectionHasCopyableCommandBlock(installSection.content)) {
939+
} else if (
940+
!sectionHasCopyableCommandBlock(installSection.content) &&
941+
!README_INSTALL_BLOCK_FALSE_POSITIVES.has(module.name)
942+
) {
937943
addIssue(
938944
issues,
939945
"Recommendation: The README's install section should include a copyable fenced command block (for example ```bash ...). Please add one so the module can be installed with a single copy/paste ([basic instructions](https://github.com/MagicMirrorOrg/MagicMirror-3rd-Party-Modules/blob/main/guides/readme_bestpractices.md#Installation-Instructions))."

0 commit comments

Comments
 (0)