chore(tools): add check flag to browser_compat.ts
#4240
Conversation
_tools/check_browser_compat.ts
Outdated
| const index = source.indexOf(COPYRIGHT); | ||
| await Deno.writeTextFile( | ||
| path, | ||
| source.slice(0, index + COPYRIGHT.length) + "\n" + DECLARATION + "\n" + |
There was a problem hiding this comment.
The second "\n" looks redundant to me.
There was a problem hiding this comment.
This section makes me wonder whether we should integrate both copyright and web compatibility checks. Either way, an idea for another issue/PR.
There was a problem hiding this comment.
The second
"\n"looks redundant to me.
removed
There was a problem hiding this comment.
This section makes me wonder whether we should integrate both copyright and web compatibility checks. Either way, an idea for another issue/PR.
I agree, this looks ugly and hacky. I had a try with the ts compiler API which would work without direct string manipulation, but the ts printer doesn't retain format and whitespaces. The same problem appeared on a draft of auto-inserting warnOnDeprecatedApi() calls for deprecated functions. Is there a simple ts parser that also retains format and whitespaces?
| import { walkSync } from "../fs/walk.ts"; | ||
|
|
||
| import { walk } from "../fs/walk.ts"; | ||
| import { COPYRIGHT } from "./check_licence.ts"; | ||
|
|
||
| const ROOT = new URL("../", import.meta.url); | ||
| const SKIP = [/(test|bench|\/_|\\_|testdata|version.ts)/]; | ||
| const DECLARATION = "// This module is browser compatible."; |
There was a problem hiding this comment.
Not directly related to this PR, but some file (data_structures/comparators.ts) seems having /** This module is browser compatible. */ comment
There was a problem hiding this comment.
Ok, I guess we should replace that with a single line comment in another PR.
_tools/check_browser_compat.ts
Outdated
| const index = source.indexOf(COPYRIGHT); | ||
| await Deno.writeTextFile( | ||
| path, | ||
| source.slice(0, index + COPYRIGHT.length) + "\n" + DECLARATION + "\n" + |
There was a problem hiding this comment.
This section makes me wonder whether we should integrate both copyright and web compatibility checks. Either way, an idea for another issue/PR.
kt3k
changed the title
browser_compat.tsbrowser_compat.ts
browser_compat.tstool to check missing comments in file. It will inject missing comments if the flag is not present.This feature is borrowed from the
check_licence.tstool.