wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-23 14:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add script to find files which exist in lib/ve's modules.json, but not extension.json

Browse source 
Change-Id: Ib5b3aa773961c622cdaf7f4420f720cb86297916
This commit is contained in:
Ed Sanders 2023-12-08 16:28:37 +00:00 committed by James D. Forrester
parent b19883e8d8
commit fa307229d2
1 changed files with 108 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

108
build/tasks/checkModules.js Normal file
View file

@ -0,0 +1,108 @@
'use strict';
const fs = require( 'fs' );
const path = require( 'path' );
const extensionJsonPath = '../../extension.json';
const modulesJsonPath = '../../lib/ve/build/modules.json';
const ignored = [
'node_modules/',
'lib/',
'dist/',
'src/ve.track.js', // Re-implemented in MW
'src/ce/ve.ce.debug.js',
'tests/ve.qunit.local.js',
// Standalone / Demos
'demos/',
'src/init/sa/',
'tests/init/ve.init.sa.Platform.test.js',
'src/ui/dialogs/ve.ui.DiffDialog.js',
// Rebaser
'rebaser/',
'collab/',
'src/ve.FakePeer.js',
// TODO: Put these is a folder
'tests/ve.FakePeer.test.js',
'tests/dm/ve.dm.TransactionSquasher.test.js',
'tests/dm/ve.dm.RebaseServer.test.js',
'tests/dm/ve.dm.FakeMongo.js',
'tests/dm/ve.dm.FakeSocket.js',
'tests/dm/ve.dm.DocumentStore.test.js',
'tests/dm/ve.dm.TransportServer.test.js'
];
function readJson( filePath ) {
try {
// eslint-disable-next-line security/detect-non-literal-fs-filename
const rawData = fs.readFileSync( filePath );
return JSON.parse( rawData );
} catch ( error ) {
console.error( `Error reading file ${ filePath }:`, error );
return null;
}
}
function addFilesToSet( files, set, basePath = '' ) {
if ( Array.isArray( files ) ) {
files.forEach( ( file ) => set.add( path.join( basePath, file.file || file ) ) );
} else if ( typeof files === 'string' ) {
set.add( path.join( basePath, files ) );
}
}
function isIgnored( filePath ) {
return ignored.some( ( ignorePath ) => {
const fullIgnorePath = path.join( 'lib/ve', ignorePath );
return filePath === fullIgnorePath || filePath.startsWith( fullIgnorePath );
} );
}
function addModulesToSet( modules, set, basePath = '' ) {
Object.values( modules ).forEach( ( module ) => {
[
'scripts',
'debugScripts',
'styles'
].forEach( ( property ) => {
if ( module[ property ] ) {
addFilesToSet( module[ property ], set, basePath );
}
} );
if ( module.skinStyles ) {
Object.values( module.skinStyles ).forEach( ( files ) => {
addFilesToSet( files, set, basePath );
} );
}
} );
}
function checkFiles() {
const extensionJson = readJson( extensionJsonPath );
const modulesJson = readJson( modulesJsonPath );
if ( !extensionJson || !modulesJson ) {
return;
}
const extensionFiles = new Set();
addModulesToSet( extensionJson.ResourceModules, extensionFiles );
addModulesToSet( { QUnitTestModule: extensionJson.QUnitTestModule }, extensionFiles );
const modulesFiles = new Set();
addModulesToSet( modulesJson, modulesFiles, 'lib/ve' );
const missingFiles = Array.from( modulesFiles ).filter( ( file ) => {
return !extensionFiles.has( file ) && !isIgnored( file );
} );
if ( missingFiles.length ) {
console.log( missingFiles.length + ' missing file(s):' );
console.log( missingFiles.join( '\n' ) );
} else {
console.log( 'No missing files.' );
}
}
checkFiles();