Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add tool to copy method signatures from base classes
- Loading branch information
Showing
5 changed files
with
165 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,144 @@ | ||
const path = require("path"); | ||
const fs = require("fs"); | ||
const ts = require("typescript"); | ||
const program = require("./typescript-program"); | ||
|
||
// When --override is set, base jsdoc will override sub class jsdoc | ||
// Elsewise on a conflict it will create a merge conflict in the file | ||
const override = process.argv.includes("--override"); | ||
|
||
// When --write is set, files will be written in place | ||
// Elsewise it only prints outdated files | ||
const doWrite = process.argv.includes("--write"); | ||
|
||
const typeChecker = program.getTypeChecker(); | ||
|
||
/** | ||
* @param {ts.ClassDeclaration} node the class declaration | ||
* @returns {Set<ts.ClassDeclaration>} the base class declarations | ||
*/ | ||
const getBaseClasses = node => { | ||
/** @type {Set<ts.ClassDeclaration>} */ | ||
const decls = new Set(); | ||
if (node.heritageClauses) { | ||
for (const clause of node.heritageClauses) { | ||
for (const clauseType of clause.types) { | ||
const type = typeChecker.getTypeAtLocation(clauseType); | ||
if (ts.isClassDeclaration(type.symbol.valueDeclaration)) | ||
decls.add(type.symbol.valueDeclaration); | ||
} | ||
} | ||
} | ||
return decls; | ||
}; | ||
|
||
/** | ||
* @param {ts.ClassDeclaration} classNode the class declaration | ||
* @param {string} memberName name of the member | ||
* @returns {ts.MethodDeclaration | null} base class member declaration when found | ||
*/ | ||
const findDeclarationInBaseClass = (classNode, memberName) => { | ||
for (const baseClass of getBaseClasses(classNode)) { | ||
for (const node of baseClass.members) { | ||
if (ts.isMethodDeclaration(node)) { | ||
if (node.name.getText() === memberName) { | ||
return node; | ||
} | ||
} | ||
} | ||
const result = findDeclarationInBaseClass(baseClass, memberName); | ||
if (result) return result; | ||
} | ||
return null; | ||
}; | ||
|
||
const libPath = path.resolve(__dirname, "../lib"); | ||
|
||
for (const sourceFile of program.getSourceFiles()) { | ||
let file = sourceFile.fileName; | ||
if ( | ||
file.toLowerCase().startsWith(libPath.replace(/\\/g, "/").toLowerCase()) | ||
) { | ||
const updates = []; | ||
sourceFile.forEachChild(node => { | ||
if (ts.isClassDeclaration(node)) { | ||
for (const member of node.members) { | ||
if (ts.isMethodDeclaration(member)) { | ||
const baseDecl = findDeclarationInBaseClass( | ||
node, | ||
member.name.getText() | ||
); | ||
if (baseDecl) { | ||
const memberAsAny = /** @type {any} */ (member); | ||
const baseDeclAsAny = /** @type {any} */ (baseDecl); | ||
const currentJsDoc = memberAsAny.jsDoc && memberAsAny.jsDoc[0]; | ||
const baseJsDoc = baseDeclAsAny.jsDoc && baseDeclAsAny.jsDoc[0]; | ||
const currentJsDocText = currentJsDoc && currentJsDoc.getText(); | ||
let baseJsDocText = baseJsDoc && baseJsDoc.getText(); | ||
if (baseJsDocText) { | ||
baseJsDocText = baseJsDocText.replace( | ||
/\t \* @abstract\r?\n/g, | ||
"" | ||
); | ||
if (!currentJsDocText) { | ||
// add js doc | ||
updates.push({ | ||
member: member.name.getText(), | ||
start: member.getStart(), | ||
end: member.getStart(), | ||
content: baseJsDocText + "\n\t" | ||
}); | ||
} else if ( | ||
baseJsDocText && | ||
currentJsDocText !== baseJsDocText | ||
) { | ||
// update js doc | ||
if (override || !doWrite) { | ||
updates.push({ | ||
member: member.name.getText(), | ||
start: currentJsDoc.getStart(), | ||
end: currentJsDoc.getEnd(), | ||
content: baseJsDocText | ||
}); | ||
} else { | ||
updates.push({ | ||
member: member.name.getText(), | ||
start: currentJsDoc.getStart() - 1, | ||
end: currentJsDoc.getEnd(), | ||
content: `<<<<<<< original comment\n\t${currentJsDocText}\n=======\n\t${baseJsDocText}\n>>>>>>> comment from base class` | ||
}); | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}); | ||
if (updates.length > 0) { | ||
if (doWrite) { | ||
let fileContent = fs.readFileSync(file, "utf-8"); | ||
updates.sort((a, b) => { | ||
return b.start - a.start; | ||
}); | ||
for (const update of updates) { | ||
fileContent = | ||
fileContent.substr(0, update.start) + | ||
update.content + | ||
fileContent.substr(update.end); | ||
} | ||
console.log(`${file} ${updates.length} JSDoc comments added/updated`); | ||
fs.writeFileSync(file, fileContent, "utf-8"); | ||
} else { | ||
console.log(file); | ||
for (const update of updates) { | ||
console.log( | ||
`* ${update.member} should have this JSDoc:\n\t${update.content}` | ||
); | ||
} | ||
console.log(); | ||
} | ||
process.exitCode = 1; | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
const path = require("path"); | ||
const fs = require("fs"); | ||
const ts = require("typescript"); | ||
|
||
const rootPath = path.resolve(__dirname, ".."); | ||
const configPath = path.resolve(__dirname, "../tsconfig.json"); | ||
const configContent = fs.readFileSync(configPath, "utf-8"); | ||
const configJsonFile = ts.parseJsonText(configPath, configContent); | ||
const parsedConfig = ts.parseJsonSourceFileConfigFileContent( | ||
configJsonFile, | ||
ts.sys, | ||
rootPath, | ||
{ noEmit: true } | ||
); | ||
const { fileNames, options } = parsedConfig; | ||
|
||
module.exports = ts.createProgram(fileNames, options); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters