FilesExpand file tree

main

/

normalize-headers.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

192 lines (166 loc) · 5.17 KB

main

/

normalize-headers.ts

Copy path

Top

File metadata and controls

• Code
• Blame

192 lines (166 loc) · 5.17 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

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

// SPDX-License-Identifier: AGPL-3.0-or-later

import * as childProcess from "node:child_process";

import * as fs from "node:fs";

import * as path from "node:path";

import { fileURLToPath } from "node:url";

const __filename = fileURLToPath(import.meta.url);

const __dirname = path.dirname(__filename);

const REPO_ROOT = path.resolve(__dirname, "..");

const EXCLUDED_PATTERNS = [

/^languages\/modelica\/testsuite\//,

/\/src-gen\//,

/\/as-gen\//,

/\/dist\//,

/\/build\//,

/\/node_modules\//,

/\/vendor\//,

/\.d\.ts$/,

/\/scratch/,

/^\.agents\//,

/^\.gemini\//,

/\.react-router\//,

];

const CODE_EXTENSIONS = new Set([".ts", ".tsx", ".js", ".mjs", ".cjs", ".sh", ".py"]);

interface HeaderStats {

scanned: number;

alreadyNormalized: number;

added: number;

repositioned: number;

skippedExcluded: number;

violations: string[];

}

function shouldExclude(relPath: string): boolean {

for (const pattern of EXCLUDED_PATTERNS) {

if (pattern.test(relPath)) return true;

}

return false;

}

function normalizeFile(

fullPath: string,

relPath: string,

dryRun: boolean,

checkOnly: boolean,

stats: HeaderStats,

): void {

const content = fs.readFileSync(fullPath, "utf-8");

const ext = path.extname(fullPath);

const isHashComment = ext === ".sh" || ext === ".py";

const spdxTag = isHashComment

? "# SPDX-License-Identifier: AGPL-3.0-or-later"

: "// SPDX-License-Identifier: AGPL-3.0-or-later";

const lines = content.split(/\r?\n/);

const firstLine = lines[0] ?? "";

const hasShebang = firstLine.startsWith("#!");

// Check if file already contains SPDX-License-Identifier

const spdxLineIdx = lines.findIndex((l) => l.includes("SPDX-License-Identifier"));

if (spdxLineIdx === -1) {

stats.violations.push(`${relPath} (missing SPDX header)`);

if (checkOnly) {

stats.added++;

return;

}

// Missing SPDX header entirely

let newContent: string;

if (hasShebang) {

const rest = lines.slice(1);

while (rest.length > 0 && rest[0]!.trim() === "") rest.shift();

newContent = `${firstLine}\n${spdxTag}\n\n${rest.join("\n")}`;

} else {

const cleanLines = [...lines];

while (cleanLines.length > 0 && cleanLines[0]!.trim() === "") cleanLines.shift();

newContent = `${spdxTag}\n\n${cleanLines.join("\n")}`;

}

if (!dryRun) {

fs.writeFileSync(fullPath, newContent, "utf-8");

}

stats.added++;

return;

}

// Already has SPDX header - verify position

const expectedLine = hasShebang ? 1 : 0;

if (spdxLineIdx === expectedLine) {

stats.alreadyNormalized++;

return;

}

// Header is misplaced (e.g. after blank line or imports)

stats.violations.push(

`${relPath} (misplaced SPDX header at line ${spdxLineIdx + 1}, expected line ${expectedLine + 1})`,

);

if (checkOnly) {

stats.repositioned++;

return;

}

const oldSpdxLine = lines[spdxLineIdx]!;

lines.splice(spdxLineIdx, 1);

const tagToUse = oldSpdxLine.includes("AGPL-3.0-or-later") ? spdxTag : oldSpdxLine.trim();

let newContent: string;

if (hasShebang) {

const rest = lines.slice(1);

while (rest.length > 0 && rest[0]!.trim() === "") rest.shift();

newContent = `${firstLine}\n${tagToUse}\n\n${rest.join("\n")}`;

} else {

while (lines.length > 0 && lines[0]!.trim() === "") lines.shift();

newContent = `${tagToUse}\n\n${lines.join("\n")}`;

}

if (!dryRun) {

fs.writeFileSync(fullPath, newContent, "utf-8");

}

stats.repositioned++;

}

export function run(targetFilter = "", dryRun = false, checkOnly = false): HeaderStats {

const trackedFiles = childProcess

.execSync("git ls-files", { cwd: REPO_ROOT, encoding: "utf-8" })

.split(/\r?\n/)

.filter(Boolean);

const stats: HeaderStats = {

scanned: 0,

alreadyNormalized: 0,

added: 0,

repositioned: 0,

skippedExcluded: 0,

violations: [],

};

for (const relPath of trackedFiles) {

if (targetFilter && !relPath.startsWith(targetFilter)) {

continue;

}

const ext = path.extname(relPath);

if (!CODE_EXTENSIONS.has(ext)) {

continue;

}

if (shouldExclude(relPath)) {

stats.skippedExcluded++;

continue;

}

const fullPath = path.join(REPO_ROOT, relPath);

if (!fs.existsSync(fullPath)) {

continue;

}

stats.scanned++;

normalizeFile(fullPath, relPath, dryRun, checkOnly, stats);

}

return stats;

}

// Direct CLI invocation

const args = process.argv.slice(2);

const dryRun = args.includes("--dry-run");

const checkOnly = args.includes("--check");

const filterArg = args.find((a) => !a.startsWith("--")) ?? "";

console.log(

`Starting header normalization (filter: "${filterArg || "ALL"}", dryRun: ${dryRun}, check: ${checkOnly})...`,

);

const results = run(filterArg, dryRun, checkOnly);

console.log(`\nResults:

- Scanned: ${results.scanned}

- Already Normalized: ${results.alreadyNormalized}

- Added Header: ${results.added}

- Repositioned Header: ${results.repositioned}

- Skipped (Excluded): ${results.skippedExcluded}

`);

if (checkOnly && results.violations.length > 0) {

console.error(`\nFound ${results.violations.length} header violation(s):`);

for (const v of results.violations) {

console.error(` - ${v}`);

}

process.exit(1);

}