Skip to content

Commit 4fbb85d

Browse files
HaydenOrzHaydenOrz
authored
chore: clean comment (#220)
* build: add clean comment script * chore: clean comment to hide sensitive information
1 parent 31a811d commit 4fbb85d

37 files changed

Lines changed: 173 additions & 34 deletions

‎package.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
"test": "NODE_OPTIONS=--max_old_space_size=4096 && jest",
2727
"release": "node ./scripts/release.js",
2828
"lint": "prettier --check '**/*.ts' --config ./.prettierrc",
29-
"lint-fix": "prettier --write '**/*.ts' --config ./.prettierrc"
29+
"lint-fix": "prettier --write '**/*.ts' --config ./.prettierrc",
30+
"cleanComment": "node ./scripts/cleanCommentCli.js"
3031
},
3132
"author": "dt-insight-front",
3233
"license": "MIT",
@@ -41,6 +42,7 @@
4142
"antlr4ts-cli": "^0.5.0-alpha.4",
4243
"chalk": "4.1.2",
4344
"commitizen": "^4.3.0",
45+
"glob": "^10.3.10",
4446
"husky": "^8.0.3",
4547
"inquirer": "^8.2.2",
4648
"jest": "^29.5.0",

‎pnpm-lock.yaml‎

Lines changed: 95 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎scripts/antlr4.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ const fs = require('fs');
44
const argv = require('yargs-parser')(process.argv.slice(2));
55
const inquirer = require('inquirer');
66
const chalk = require('chalk');
7+
const { cleanComment } = require('./cleanComment');
78

89
const grammarsPath = path.resolve(__dirname, '../src/grammar');
910
const outputPath = path.resolve(__dirname, '../src/lib');
@@ -29,7 +30,8 @@ function compile(language) {
2930
chalk.gray(err)
3031
);
3132
} else {
32-
console.log(chalk.greenBright(`\nCompile ${language} succeeded!`));
33+
cleanComment(language);
34+
console.log(chalk.greenBright(`Compile ${language} succeeded!`));
3335
}
3436
});
3537
}

‎scripts/cleanComment.js‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
const fs = require('fs');
2+
const path = require('path');
3+
const { globSync } = require('glob');
4+
const chalk = require('chalk');
5+
6+
const basePath = path.resolve(__dirname, '../src/lib');
7+
8+
function processFile(filePath) {
9+
try {
10+
const content = fs.readFileSync(filePath, 'utf-8');
11+
const firstLineIdx =
12+
content.indexOf('\r\n') === -1 ? content.indexOf('\n') : content.indexOf('\r\n');
13+
if (firstLineIdx === -1) return;
14+
15+
let firstLineContent = content.slice(0, firstLineIdx);
16+
const restContent = content.slice(firstLineIdx);
17+
18+
const slices = firstLineContent.split('/src/grammar/');
19+
if (slices.length !== 2) return;
20+
firstLineContent = `// Generated from dt-sql-parser/src/grammar/` + slices[1];
21+
22+
fs.writeFileSync(filePath, firstLineContent + restContent, 'utf-8');
23+
} catch (error) {
24+
console.error(error);
25+
}
26+
}
27+
28+
function main(language) {
29+
const base = basePath + (language ? `/${language}` : '');
30+
console.info(chalk.green(`\nCleaning comment in:`, chalk.gray(`${base}/**/*.ts`)));
31+
const filePaths = globSync(`${base}/**/*.ts`, { absolute: true, nodir: true });
32+
filePaths.forEach(processFile);
33+
}
34+
35+
module.exports = {
36+
cleanComment: main,
37+
};

‎scripts/cleanCommentCli.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
const { cleanComment } = require('./cleanComment');
2+
3+
cleanComment();

‎src/lib/flinksql/FlinkSqlLexer.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Generated from /Users/hayden/Desktop/dt-works/dt-sql-parser/src/grammar/flinksql/FlinkSqlLexer.g4 by ANTLR 4.9.0-SNAPSHOT
1+
// Generated from dt-sql-parser/src/grammar/flinksql/FlinkSqlLexer.g4 by ANTLR 4.9.0-SNAPSHOT
22

33

44
import { ATN } from "antlr4ts/atn/ATN";

‎src/lib/flinksql/FlinkSqlParser.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Generated from /Users/hayden/Desktop/dt-works/dt-sql-parser/src/grammar/flinksql/FlinkSqlParser.g4 by ANTLR 4.9.0-SNAPSHOT
1+
// Generated from dt-sql-parser/src/grammar/flinksql/FlinkSqlParser.g4 by ANTLR 4.9.0-SNAPSHOT
22

33

44
import { ATN } from "antlr4ts/atn/ATN";

‎src/lib/flinksql/FlinkSqlParserListener.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Generated from /Users/hayden/Desktop/dt-works/dt-sql-parser/src/grammar/flinksql/FlinkSqlParser.g4 by ANTLR 4.9.0-SNAPSHOT
1+
// Generated from dt-sql-parser/src/grammar/flinksql/FlinkSqlParser.g4 by ANTLR 4.9.0-SNAPSHOT
22

33

44
import { ParseTreeListener } from "antlr4ts/tree/ParseTreeListener";

‎src/lib/flinksql/FlinkSqlParserVisitor.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Generated from /Users/hayden/Desktop/dt-works/dt-sql-parser/src/grammar/flinksql/FlinkSqlParser.g4 by ANTLR 4.9.0-SNAPSHOT
1+
// Generated from dt-sql-parser/src/grammar/flinksql/FlinkSqlParser.g4 by ANTLR 4.9.0-SNAPSHOT
22

33

44
import { ParseTreeVisitor } from "antlr4ts/tree/ParseTreeVisitor";

‎src/lib/hive/HiveSqlLexer.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Generated from /Users/hayden/Desktop/dt-works/dt-sql-parser/src/grammar/hive/HiveSqlLexer.g4 by ANTLR 4.9.0-SNAPSHOT
1+
// Generated from dt-sql-parser/src/grammar/hive/HiveSqlLexer.g4 by ANTLR 4.9.0-SNAPSHOT
22

33

44
import { ATN } from "antlr4ts/atn/ATN";

0 commit comments

Comments
 (0)