1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Followup TODOCS linter fixes (#58000)

This commit is contained in:
Sarah Schneider
2025-10-15 15:38:38 -04:00
committed by GitHub
parent 97568cfa45
commit c427ce78f4
2 changed files with 12 additions and 8 deletions

View File

@@ -430,10 +430,14 @@ function getFormattedResults(allResults, isPrecommit) {
const formattedResults = results
.map((flaw) => formatResult(flaw, isPrecommit))
.filter((flaw) => shouldIncludeResult(flaw, key))
const errors = formattedResults.filter((result) => result.severity === 'error')
const warnings = formattedResults.filter((result) => result.severity === 'warning')
const sortedResult = [...errors, ...warnings]
output[key] = [...sortedResult]
// Only add the file to output if there are results after filtering
if (formattedResults.length > 0) {
const errors = formattedResults.filter((result) => result.severity === 'error')
const warnings = formattedResults.filter((result) => result.severity === 'warning')
const sortedResult = [...errors, ...warnings]
output[key] = [...sortedResult]
}
}
})
return output

View File

@@ -1,6 +1,5 @@
// Configuration for which rules should be included in automated weekly reports
export const reportingConfig = {
// Always include all rules with these severities
// Always include all rules with these severities in automated weekly reports
includeSeverities: ['error'],
// Specific rules to include regardless of severity
@@ -10,18 +9,19 @@ export const reportingConfig = {
'expired-content',
],
// Specific rules to exclude from reports (overrides severity-based inclusion)
// Specific rules to exclude from CI and reports (overrides severity-based inclusion)
// Add rule names here if you want to suppress them from reports
excludeRules: [
// Example: 'GHD030' // Uncomment to exclude code-fence-line-length warnings
'british-english-quotes', // Exclude from reports but keep for pre-commit
],
// Files to exclude from specific rules in reports
// Files to exclude from specific rules in CI and reports
// Format: { 'rule-name': ['file/path/pattern1', 'file/path/pattern2'] }
excludeFilesFromRules: {
'todocs-placeholder': [
'content/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes.md',
'content/contributing/collaborating-on-github-docs/index.md',
],
},
}