Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Feb 5, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a365d4e
initial commit
timreichen Jan 25, 2024
61ce8d0
Merge branch 'main' into tools_add_check_flag_to_browser_compat
timreichen Feb 2, 2024
5c8c221
remove newline
timreichen Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 21 additions & 18 deletions _tools/check_browser_compat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly related to this PR, but some file (data_structures/comparators.ts) seems having /** This module is browser compatible. */ comment

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I guess we should replace that with a single line comment in another PR.

const CHECK = Deno.args.includes("--check");

function isBrowserCompatible(filePath: string): boolean {
const command = new Deno.Command(Deno.execPath(), {
Expand All @@ -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 changes: 1 addition & 1 deletion _tools/check_licence.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading