IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-21 16:38:03 -06:00
Code Issues Packages Projects Releases Wiki Activity

Frontend: Improve barrel file detection in codemod (#87389)

Browse Source
This commit is contained in:
Jack Westbrook 2024-05-09 10:49:47 +02:00 committed by GitHub
parent acf17c7fb1
commit 6380a01543
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
scripts/codemods/explicit-barrel-imports.cjs
View File

@ -1,39 +1,39 @@
const fs = require('fs');
const path = require('path');
const isBareSpecifier = (importPath) => !importPath.startsWith('app/') && /^[^./]/.test(importPath);
const barrelFileNames = ['index.ts', 'index.tsx', 'index.js', 'index.jsx'];
const resolvePath = (fileDir, importPath) =>
importPath.startsWith('app/')
? require.resolve(path.join(__dirname, '..', '..', 'public', importPath))
: require.resolve(path.resolve(fileDir, importPath));
module.exports = function (fileInfo, api) {
const j = api.jscodeshift;
const root = j.withParser('tsx')(fileInfo.source);
const fileDir = path.dirname(fileInfo.path);
// Function to check if the path potentially points to a barrel file
const mightBeBarrelFileImport = (importPath) => {
const fullPath = path.join(fileDir, importPath);
if (fs.existsSync(fullPath) && fs.lstatSync(fullPath).isDirectory()) {
if (fs.existsSync(path.join(fullPath, 'index.ts')) || fs.existsSync(path.join(fullPath, 'index.js'))) {
return true;
}
}
return false;
};
// Udpate import declarations that import from barrel files
// Update import declarations that import from barrel files
root
.find(j.ImportDeclaration)
.filter((path) => mightBeBarrelFileImport(path.node.source.value))
.filter((path) => !isBareSpecifier(path.node.source.value))
.forEach((path) => {
// Create a comment node
const comment = j.commentLine(' @todo: replace barrel import path');
const resolvedPath = resolvePath(fileDir, path.node.source.value);
if (barrelFileNames.some((barrelFileName) => resolvedPath.endsWith(barrelFileName))) {
// Create a comment node
const comment = j.commentLine(' @todo: replace barrel import path');
// Attach the comment as a leading comment to the import declaration
if (!path.node.comments) {
path.node.comments = [];
// Attach the comment as a leading comment to the import declaration
if (!path.node.comments) {
path.node.comments = [];
}
path.node.comments.push(comment);
// Update the import path appending '/index'
path.node.source.value = path.node.source.value + '/index';
}
path.node.comments.push(comment);
// Update the import path appending '/index'
path.node.source.value = path.node.source.value + '/index';
});
return root.toSource();
return root.toSource({
quote: 'single',
});
};