FilesExpand file tree

main

/

scan-todos.mjs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

51 lines (44 loc) · 1.39 KB

main

/

scan-todos.mjs

Copy path

Top

File metadata and controls

• Code
• Blame

51 lines (44 loc) · 1.39 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

#!/usr/bin/env node

import { globSync, readFileSync } from "node:fs";

import { relative, resolve } from "node:path";

const root = resolve(import.meta.dirname, "..");

// Native globSync is available throughout the Node versions in package.engines.

// Its exclusion option is `exclude`; `ignore` and `nodir` belong to npm glob.

const sourceFiles = globSync(

[

"src/**/*.ts",

"tests/**/*.ts",

"scripts/**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx}",

"bridge/**/*.py",

"bridge/**/*.java",

],

{

cwd: root,

exclude: (path) => path.split(/[\\/]/u).includes("node_modules"),

},

);

const patterns = [

{ regex: /TODO(?::\s*(.*))?$/gm, label: "TODO" },

{ regex: /FIXME(?::\s*(.*))?$/gm, label: "FIXME" },

{ regex: /HACK(?::\s*(.*))?$/gm, label: "HACK" },

];

let count = 0;

for (const file of sourceFiles) {

const content = readFileSync(resolve(root, file), "utf-8");

for (const { regex, label } of patterns) {

for (const match of content.matchAll(regex)) {

const comment = (match[1] ?? "").trim();

const line = content.slice(0, match.index).split("\n").length;

console.log(

`${relative(root, resolve(root, file))}:${line}: ${label}${comment ? ` - ${comment}` : ""}`,

);

count++;

}

}

}

if (count > 0) {

console.log(`\n${count} tech-debt marker(s) found.`);

process.exitCode = 1;

} else {

console.log("No tech-debt markers found.");

}