IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -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

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

@ -1,27 +1,24 @@
const fs = require('fs');
const path = require('path'); 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) { module.exports = function (fileInfo, api) {
const j = api.jscodeshift; const j = api.jscodeshift;
const root = j.withParser('tsx')(fileInfo.source); const root = j.withParser('tsx')(fileInfo.source);
const fileDir = path.dirname(fileInfo.path); const fileDir = path.dirname(fileInfo.path);
// Update import declarations that import from barrel files
// 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
root root
.find(j.ImportDeclaration) .find(j.ImportDeclaration)
.filter((path) => mightBeBarrelFileImport(path.node.source.value)) .filter((path) => !isBareSpecifier(path.node.source.value))
.forEach((path) => { .forEach((path) => {
const resolvedPath = resolvePath(fileDir, path.node.source.value);
if (barrelFileNames.some((barrelFileName) => resolvedPath.endsWith(barrelFileName))) {
// Create a comment node // Create a comment node
const comment = j.commentLine(' @todo: replace barrel import path'); const comment = j.commentLine(' @todo: replace barrel import path');
@ -33,7 +30,10 @@ module.exports = function (fileInfo, api) {
// Update the import path appending '/index' // Update the import path appending '/index'
path.node.source.value = path.node.source.value + '/index'; path.node.source.value = path.node.source.value + '/index';
}
}); });
return root.toSource(); return root.toSource({
quote: 'single',
});
}; };