Files
api/web/scripts/validate-custom-elements-css.js
Eli Bosley 86b6c4f85b fix: inject Tailwind CSS into client entry point (#1537)
Added a Vite plugin to automatically inject the Tailwind CSS import into
the `unraid-components.client.js` entry file, enhancing the integration
of Tailwind CSS within the application. This change improves the setup
for styling components consistently across the project.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added automated validation to ensure Tailwind CSS styles are correctly
included in the custom elements build output.

* **Chores**
* Updated the build process to include a CSS validation step after
manifest generation.
* Enhanced development build configuration to enable CSS source maps and
optimize Tailwind CSS injection into web components.
  * Extended CSS theme with new responsive breakpoint variables.
* Improved CSS class specificity in user profile, server state, and
update modal components for consistent styling.
* Removed redundant style blocks and global CSS imports from multiple
components to streamline styling and reduce duplication.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-07-23 15:30:57 -04:00

159 lines
4.8 KiB
JavaScript

#!/usr/bin/env node
const fs = require('fs');
const path = require('path');
/**
* Recursively find JS files in a directory
*/
function findJSFiles(dir, jsFiles = []) {
if (!fs.existsSync(dir)) {
return jsFiles;
}
const items = fs.readdirSync(dir);
for (const item of items) {
const fullPath = path.join(dir, item);
const stat = fs.statSync(fullPath);
if (stat.isDirectory()) {
findJSFiles(fullPath, jsFiles);
} else if (item.endsWith('.js')) {
jsFiles.push(fullPath);
}
}
return jsFiles;
}
/**
* Validates that Tailwind CSS styles are properly inlined in the JavaScript bundle
*/
function validateCustomElementsCSS() {
console.log('🔍 Validating custom elements JS bundle includes inlined Tailwind styles...');
try {
// Find the custom elements JS files
const customElementsDir = '.nuxt/nuxt-custom-elements/dist';
const jsFiles = findJSFiles(customElementsDir);
if (jsFiles.length === 0) {
throw new Error('No custom elements JS files found in ' + customElementsDir);
}
// Find the largest JS file (likely the main bundle with inlined CSS)
const jsFile = jsFiles.reduce((largest, current) => {
const currentSize = fs.statSync(current).size;
const largestSize = fs.statSync(largest).size;
return currentSize > largestSize ? current : largest;
});
console.log(`📁 Checking JS bundle: ${jsFile}`);
// Read the JS content
const jsContent = fs.readFileSync(jsFile, 'utf8');
// Define required Tailwind indicators (looking for inlined CSS in JS)
const requiredIndicators = [
{
name: 'Tailwind utility classes (inline)',
pattern: /\.flex\s*\{[^}]*display:\s*flex/,
description: 'Basic Tailwind utility classes inlined'
},
{
name: 'Tailwind margin utilities (inline)',
pattern: /\.m-\d+\s*\{[^}]*margin:/,
description: 'Tailwind margin utilities inlined'
},
{
name: 'Tailwind padding utilities (inline)',
pattern: /\.p-\d+\s*\{[^}]*padding:/,
description: 'Tailwind padding utilities inlined'
},
{
name: 'Tailwind color utilities (inline)',
pattern: /\.text-\w+\s*\{[^}]*color:/,
description: 'Tailwind text color utilities inlined'
},
{
name: 'Tailwind background utilities (inline)',
pattern: /\.bg-\w+\s*\{[^}]*background/,
description: 'Tailwind background utilities inlined'
},
{
name: 'CSS custom properties',
pattern: /--[\w-]+:\s*[^;]+;/,
description: 'CSS custom properties (variables)'
},
{
name: 'Responsive breakpoints',
pattern: /@media\s*\([^)]*min-width/,
description: 'Responsive media queries'
},
{
name: 'CSS reset styles',
pattern: /\*[^}]*box-sizing|box-sizing[^}]*border-box/,
description: 'Tailwind CSS reset/normalize styles'
}
];
// Validate each indicator
const results = [];
let allPassed = true;
for (const indicator of requiredIndicators) {
const found = indicator.pattern.test(jsContent);
results.push({
name: indicator.name,
description: indicator.description,
passed: found
});
if (!found) {
allPassed = false;
}
}
// Report results
console.log('\n📊 Validation Results:');
console.log('====================');
for (const result of results) {
const status = result.passed ? '✅' : '❌';
console.log(`${status} ${result.name}`);
if (!result.passed) {
console.log(` └─ Missing: ${result.description}`);
}
}
// File size check
const fileSizeKB = Math.round(fs.statSync(jsFile).size / 1024);
console.log(`\n📏 JS bundle size: ${fileSizeKB} KB`);
if (fileSizeKB < 1000) {
console.log('⚠️ WARNING: JS bundle seems too small, inlined Tailwind styles might not be included');
allPassed = false;
} else {
console.log('✅ JS bundle size looks good');
}
// Final result
if (allPassed) {
console.log('\n🎉 SUCCESS: All Tailwind styles are properly inlined in the JS bundle!');
process.exit(0);
} else {
console.log('\n❌ FAILURE: Some Tailwind styles are missing from the JS bundle!');
console.log('\n💡 This might indicate:');
console.log(' - The CSS inline import in viteExtend is not working properly');
console.log(' - Tailwind configuration is not being processed');
console.log(' - CSS is not being injected into shadow DOM components');
process.exit(1);
}
} catch (error) {
console.error('\n❌ ERROR during validation:', error.message);
process.exit(1);
}
}
// Run the validation
validateCustomElementsCSS();