interface_sdk-js/build-tools/delete_systemapi_plugin.js
wangqing cc81c23dc8 add global modules whitelist
Signed-off-by: wangqing <wangqing136@huawei.com>
2022-12-06 09:48:02 +08:00

318 lines
12 KiB
JavaScript

/*
* Copyright (c) 2021-2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const path = require('path');
const fs = require('fs');
const ts = require('typescript');
let sourceFile = null;
let lastNoteStr = '';
let lastNodeName = '';
function collectDeclaration(url) {
try {
const utPath = path.resolve(__dirname, url);
const utFiles = [];
readFile(utPath, utFiles);
tsTransform(utFiles, deleteSystemApi);
} catch (error) {
console.error("DELETE_SYSTEM_PLUGIN ERROR: ", error)
}
}
function tsTransform(utFiles, callback) {
utFiles.forEach((url) => {
if (/\.json/.test(url) || /index\-full\.d\.ts/.test(url) || /common\.d\.ts/.test(url)) {
const content = fs.readFileSync(url, 'utf-8');
writeFile(url, content);
} else if (/\.d\.ts/.test(url)) {
const content = fs.readFileSync(url, 'utf-8');
const fileName = path.basename(url).replace(/.d.ts/g, '.ts');
ts.transpileModule(content, {
compilerOptions: {
"target": ts.ScriptTarget.ES2017
},
fileName: fileName,
transformers: { before: [callback(url)] }
});
}
});
}
function readFile(dir, utFiles) {
try {
const files = fs.readdirSync(dir);
files.forEach((element) => {
const filePath = path.join(dir, element);
const status = fs.statSync(filePath);
if (status.isDirectory()) {
readFile(filePath, utFiles);
} else {
utFiles.push(filePath);
}
})
} catch (e) {
console.log('ETS ERROR: ' + e);
}
}
function writeFile(url, data, option) {
if (fs.existsSync(outputPath)) {
fs.rmdirSync(outputPath, { recursive: true });
}
const newFilePath = path.resolve(outputPath, path.relative(__dirname, url));
fs.mkdir(path.relative(__dirname, path.dirname(newFilePath)), { recursive: true }, (err) => {
if (err) {
console.log(`ERROR FOR CREATE PATH ${err}`);
} else {
fs.writeFile(newFilePath, data, option, (err) => {
if (err) {
console.log(`ERROR FOR CREATE FILE ${err}`);
}
})
}
})
}
const globalModules = new Set(['GlobalResource', 'StateManagement', 'SpecialEvent']);
function formatImportDeclaration(url) {
return (context) => {
const allIdentifierSet = new Set([]);
let copyrightMessage = '';
let isCopyrightDeleted = false;
return (node) => {
sourceFile = node;
collectAllIdentifier(node);
node = formatAllNodes(node);
if (!isEmptyFile(node)) {
const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
let result = printer.printNode(ts.EmitHint.Unspecified, node, sourceFile);
if (isCopyrightDeleted) {
result = copyrightMessage + '\n' + result;
}
writeFile(url, result);
}
return node;
}
function collectAllIdentifier(node) {
if (ts.isSourceFile(node) && node.statements) {
node.statements.forEach(stat => {
if (!ts.isImportDeclaration(stat)) {
ts.visitEachChild(stat, collectAllNodes, context);
}
});
}
}
function collectAllNodes(node) {
if (ts.isIdentifier(node)) {
allIdentifierSet.add(node.escapedText.toString());
}
return ts.visitEachChild(node, collectAllNodes, context);
}
function formatAllNodes(node) {
if (ts.isSourceFile(node) && node.statements) {
const newStatements = [];
node.statements.forEach(statement => {
if (ts.isImportDeclaration(statement)) {
const clauseSet = new Set([]);
if (statement.importClause && ts.isImportClause(statement.importClause)) {
const clauseNode = statement.importClause;
if (!clauseNode.namedBindings && clauseNode.name && ts.isIdentifier(clauseNode.name)) {
clauseSet.add(clauseNode.name.escapedText.toString());
} else if (clauseNode.namedBindings && clauseNode.namedBindings.name &&
ts.isIdentifier(clauseNode.namedBindings.name)) {
clauseSet.add(clauseNode.namedBindings.name.escapedText.toString());
} else if (clauseNode.namedBindings && clauseNode.namedBindings.elements) {
clauseNode.namedBindings.elements.forEach(ele => {
if (ele.name && ts.isIdentifier(ele.name)) {
clauseSet.add(ele.name.escapedText.toString());
}
});
}
}
const importSpecifier = statement.moduleSpecifier.getText().replace(/[\'\"]/g, '');
const importSpecifierRealPath = path.resolve(url, `../${importSpecifier}.d.ts`);
if ((fs.existsSync(importSpecifierRealPath) || globalModules.has(importSpecifier)) && clauseSet.size > 0) {
const clasueCheckList = [];
let exsitClauseSet = new Set([]);
for (const clause of clauseSet) {
if (allIdentifierSet.has(clause)) {
exsitClauseSet.add(clause);
clasueCheckList.push('exist');
} else {
clasueCheckList.push('non-exist');
}
}
let hasExsitStatus = false;
let hasNonExsitStatus = false;
clasueCheckList.forEach(ele => {
if (ele === 'exist') {
hasExsitStatus = true;
} else {
hasNonExsitStatus = true;
}
});
if (hasExsitStatus) {
if (hasNonExsitStatus) {
const newSpecifiers = [];
statement.importClause.namedBindings.elements.forEach(element => {
if (exsitClauseSet.has(element.name.escapedText.toString())) {
newSpecifiers.push(element);
}
});
statement.importClause.namedBindings = ts.factory.updateNamedImports(
statement.importClause.namedBindings, newSpecifiers);
}
newStatements.push(statement);
} else if (hasCopyright(statement)) {
copyrightMessage = node.getFullText().replace(node.getText(), '');
isCopyrightDeleted = true;
}
} else if (hasCopyright(statement)) {
copyrightMessage = node.getFullText().replace(node.getText(), '');
isCopyrightDeleted = true;
}
} else {
newStatements.push(statement);
}
});
node = ts.factory.updateSourceFile(node, newStatements);
}
return node;
}
function hasCopyright(node) {
return /http\:\/\/www\.apache\.org\/licenses\/LICENSE\-2\.0/g.test(node.getFullText().replace(node.getText(), ''));
}
}
}
function deleteSystemApi(url) {
return (context) => {
return (node) => {
sourceFile = node;
node = processSourceFile(node);
node = ts.visitEachChild(node, processAllNodes, context);
if (!isEmptyFile(node)) {
const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
const result = printer.printNode(ts.EmitHint.Unspecified, node, sourceFile);
const fileName = path.basename(url).replace(/.d.ts/g, '.ts');
ts.transpileModule(result, {
compilerOptions: {
"target": ts.ScriptTarget.ES2017
},
fileName: fileName,
transformers: { before: [formatImportDeclaration(url)] }
});
}
return node;
}
function processAllNodes(node) {
if (ts.isInterfaceDeclaration(node)) {
const newMembers = [];
node.members.forEach(member => {
if (!isSystemapi(member)) {
newMembers.push(member);
}
});
node = ts.factory.updateInterfaceDeclaration(node, node.modifiers, node.name,
node.typeParameters, node.heritageClauses, newMembers);
} else if (ts.isClassDeclaration(node)) {
const newMembers = [];
node.members.forEach(member => {
if (!isSystemapi(member)) {
newMembers.push(member);
}
});
node = ts.factory.updateClassDeclaration(node, node.modifiers, node.name,
node.typeParameters, node.heritageClauses, newMembers);
} else if (ts.isModuleDeclaration(node) && node.body && ts.isModuleBlock(node.body)) {
const newStatements = [];
node.body.statements.forEach(statement => {
if (!isSystemapi(statement)) {
newStatements.push(statement);
}
});
const newModuleBody = ts.factory.updateModuleBlock(node.body, newStatements);
node = ts.factory.updateModuleDeclaration(node, node.modifiers, node.name, newModuleBody);
} else if (ts.isEnumDeclaration(node)) {
const newMembers = [];
node.members.forEach(member => {
if (!isSystemapi(member)) {
newMembers.push(member);
}
});
node = ts.factory.updateEnumDeclaration(node, node.modifiers, node.name, newMembers);
}
return ts.visitEachChild(node, processAllNodes, context);
}
function processSourceFile(node) {
const stateNamesSet = new Set([]);
const newStatements = [];
const newStatementsWithoutExport = [];
node.statements.forEach(statement => {
if (!isSystemapi(statement)) {
newStatements.push(statement);
} else if (ts.isModuleDeclaration(statement) && statement.name && ts.isIdentifier(statement.name)) {
stateNamesSet.add(statement.name.escapedText.toString());
}
});
newStatements.forEach(statement => {
if (!(ts.isExportAssignment(statement) && statement.expression && ts.isIdentifier(statement.expression) &&
stateNamesSet.has(statement.expression.escapedText.toString()))) {
newStatementsWithoutExport.push(statement);
}
});
return ts.factory.updateSourceFile(node, newStatementsWithoutExport, node.isDeclarationFile,
node.referencedFiles);
}
}
}
exports.deleteSystemApi = deleteSystemApi;
function isSystemapi(node) {
const notesContent = node.getFullText().replace(node.getText(), "").replace(/[\s]/g, "");
const notesArr = notesContent.split(/\/\*\*/);
const notesStr = notesArr[notesArr.length - 1];
if (notesStr.length !== 0) {
if (ts.isFunctionDeclaration(node) || ts.isMethodSignature(node) || ts.isMethodDeclaration(node)) {
lastNodeName = node.name && node.name.escapedText ? node.name.escapedText.toString() : "";
lastNoteStr = notesStr;
}
return /\@systemapi/g.test(notesStr);
} else {
if ((ts.isFunctionDeclaration(node) || ts.isMethodSignature(node) || ts.isMethodDeclaration(node)) && node.name &&
node.name.escapedText.toString() !== "" && node.name.escapedText.toString() === lastNodeName) {
return /\@systemapi/g.test(lastNoteStr);
} else {
return false;
}
}
}
function isEmptyFile(node) {
if (ts.isSourceFile(node) && node.statements) {
for (let i = 0; i < node.statements.length; i++) {
const statement = node.statements[i];
if (!ts.isImportDeclaration(statement)) {
return false
}
}
}
return true;
}
const apiSourcePath = '../api';
const outputPath = path.resolve(__dirname, 'output');
collectDeclaration(apiSourcePath);