chore: update doc linter, replace hardcoded entry list with dynamically created one #6491
Conversation
github-actions
bot
added
testing
collections
front-matter
media-types
uuid
expect
cli
labels
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6491 +/- ##
=======================================
Coverage 95.30% 95.30%
=======================================
Files 575 575
Lines 43266 43270 +4
Branches 6467 6467
=======================================
+ Hits 41234 41239 +5
+ Misses 1993 1992 -1
Partials 39 39 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| export function isTestFile(filePath: string): boolean { | ||
| if (!filePath.endsWith("test.ts")) return false; | ||
| const source = Deno.readTextFileSync(filePath); | ||
| const sourceFile = ts.createSourceFile( | ||
| filePath, | ||
| source, | ||
| ts.ScriptTarget.Latest, | ||
| ); | ||
|
|
||
| let result = true; | ||
|
|
||
| function visitNode(node: ts.Node) { | ||
| if (!result) return; | ||
| if ( | ||
| ts.isExportSpecifier(node) || | ||
| ts.isExportAssignment(node) || | ||
| ts.isExportDeclaration(node) || | ||
| node.kind === ts.SyntaxKind.ExportKeyword | ||
| ) { | ||
| result = false; | ||
| } else { | ||
| ts.forEachChild(node, visitNode); | ||
| } | ||
| } | ||
|
|
||
| visitNode(sourceFile); | ||
| return result; | ||
| } |
There was a problem hiding this comment.
This seems extraneous. What about this?
export function isTestFile(filePath: string): boolean {
return filePath.endsWith("test.ts");
}There was a problem hiding this comment.
The whole point of this function is to distinguish between test.ts which is used for testing (calling Deno.test()) and test.ts which is part of an api (like in @std/front-matter/test. This cannot be done by filename alone. I figured the best way was to check whether the file has exports or not, if so it must be part of an api.
There was a problem hiding this comment.
Maybe Deno.readTextFileSync(filePath).includes("\nDeno.test") would suffice? (leading \n ensures it's at the beginning of the line)
There was a problem hiding this comment.
This could lead to unintentional behaviour if Deno.test was wrapped in a function and therefore not at the beginning of the line (for example jsonc/testdata/JSONTestSuite/test.ts).
Also leads to unintentional behaviour when mentioned in a comment with unlucky line breaks:
/* bla bla bla...
Deno.test bla bla bla...
bla bla bla... */
So while this might work sometimes, it is not very robust.
Co-authored-by: Asher Gomez <[email protected]>
kt3k
changed the title
This PR removes the hardcoded entry list. Apparently some files were accidentally excluded by not updating the list.