Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-21 20:50:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

chore(tools): add check flag to browser_compat.ts (#4240)

Browse Source
This commit is contained in:
Tim Reichen 2024-02-05 02:53:06 +01:00 committed by GitHub
parent 980545f4b8
commit bcfec95e6f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
_tools/check_browser_compat.ts
View File

@ -6,11 +6,14 @@
*
* Run using: deno run --allow-read --allow-run _tools/check_browser_compat.ts
*/
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.";
const CHECK = Deno.args.includes("--check");
function isBrowserCompatible(filePath: string): boolean {
const command = new Deno.Command(Deno.execPath(), {
@ -26,24 +29,24 @@ function isBrowserCompatible(filePath: string): boolean {
return success;
}
function hasBrowserCompatibleComment(path: string): boolean {
const output = Deno.readTextFileSync(path);
return output.includes(DECLARATION);
function hasBrowserCompatibleComment(source: string): boolean {
return source.includes(DECLARATION);
}
const maybeBrowserCompatibleFiles: string[] = [];
for (const { path } of walkSync(ROOT, { exts: [".ts"], skip: SKIP })) {
if (isBrowserCompatible(path) && !hasBrowserCompatibleComment(path)) {
maybeBrowserCompatibleFiles.push(path);
for await (const { path } of walk(ROOT, { exts: [".ts"], skip: SKIP })) {
const source = await Deno.readTextFile(path);
if (isBrowserCompatible(path) && !hasBrowserCompatibleComment(source)) {
if (CHECK) {
console.log(
`${path} is likely browser-compatible and can have the "${DECLARATION}" comment added.`,
);
} else {
const index = source.indexOf(COPYRIGHT);
await Deno.writeTextFile(
path,
source.slice(0, index + COPYRIGHT.length) + "\n" + DECLARATION +
source.slice(index + COPYRIGHT.length),
);
}
}
}
if (maybeBrowserCompatibleFiles.length) {
console.log(
`The following files are likely browser-compatible and can have the "${DECLARATION}" comment added:`,
);
maybeBrowserCompatibleFiles.forEach((path, index) =>
console.log(`${index + 1}. ${path}`)
);
}

2
_tools/check_licence.ts
View File

@ -20,7 +20,7 @@ const CURRENT_YEAR = new Date().getFullYear();
const RX_COPYRIGHT = new RegExp(
`// Copyright ([0-9]{4})-([0-9]{4}) the Deno authors\\. All rights reserved\\. MIT license\\.\n`,
);
const COPYRIGHT =
export const COPYRIGHT =
`// Copyright ${FIRST_YEAR}-${CURRENT_YEAR} the Deno authors. All rights reserved. MIT license.`;
let failed = false;