@ecopages/postcss-processor 0.2.0-alpha.2 → 0.2.0-alpha.20

package/src/plugin.ts

@@ -1,354 +0,0 @@
-/**
- * PostCssProcessorPlugin
- * @module @ecopages/postcss-processor
- */
-
-import path from 'node:path';
-import type { IClientBridge } from '@ecopages/core';
-import { fileSystem } from '@ecopages/file-system';
-import { Processor, type ProcessorConfig } from '@ecopages/core/plugins/processor';
-import type { EcoBuildPlugin } from '@ecopages/core/build/build-types';
-import { Logger } from '@ecopages/logger';
-import type postcss from 'postcss';
-import { PostCssProcessor } from './postcss-processor';
-import { createCssLoaderPlugin } from './runtime/css-loader-plugin';
-import type { CssTransformInput } from './runtime/css-runtime-contract';
-
-const logger = new Logger('[@ecopages/postcss-processor]', {
-	debug: process.env.ECOPAGES_LOGGER_DEBUG === 'true',
-});
-
-/**
- * Record of PostCSS plugins keyed by name
- */
-export type PluginsRecord = Record<string, postcss.AcceptedPlugin>;
-
-/**
- * Configuration for the PostCSS processor
- */
-export interface PostCssProcessorPluginConfig {
-	/**
-	 * Regex filter to match files to process
-	 */
-	filter?: RegExp;
-	/**
-	 * Function to transform the contents of the file.
-	 * It can be handy to add a custom header or footer to the file.
-	 * Useful for injecting Tailwind v4 `@reference` directives.
-	 * @param contents The contents of the file
-	 * @param filePath The absolute path to the CSS file being processed
-	 * @returns The transformed contents
-	 */
-	transformInput?: (contents: string | Buffer, filePath: string) => string | Promise<string>;
-	/**
-	 * Function to transform the output CSS after PostCSS processing.
-	 * It can be handy to add a custom header or footer to the processed CSS.
-	 * @param css The processed CSS
-	 * @returns The transformed CSS
-	 */
-	transformOutput?: (css: string) => Promise<string> | string;
-	/**
-	 * Custom PostCSS plugins to use instead of the default ones
-	 * @default undefined (uses default plugins)
-	 */
-	plugins?: PluginsRecord;
-}
-
-/**
- * PostCssProcessorPlugin
- * A Processor for transforming CSS files.
- */
-export class PostCssProcessorPlugin extends Processor<PostCssProcessorPluginConfig> {
-	static DEFAULT_OPTIONS: Required<Pick<PostCssProcessorPluginConfig, 'filter'>> = {
-		filter: /\.css$/,
-	};
-
-	private postcssPlugins: postcss.AcceptedPlugin[] = [];
-	private readonly runtimeCssCache = new Map<string, string>();
-
-	private getCssFilter(): RegExp {
-		return this.options?.filter ?? PostCssProcessorPlugin.DEFAULT_OPTIONS.filter;
-	}
-
-	private resolveProcessedCssPath(filePath: string): string | null {
-		if (!this.context) {
-			return null;
-		}
-
-		const relativePath = path.relative(this.context.srcDir, filePath);
-		if (relativePath.startsWith('..') || path.isAbsolute(relativePath)) {
-			return null;
-		}
-
-		return path.join(this.context.distDir, 'assets', relativePath);
-	}
-
-	private readProcessedCssFromDist(filePath: string): string | null {
-		const outputPath = this.resolveProcessedCssPath(filePath);
-		if (!outputPath || !fileSystem.exists(outputPath)) {
-			return null;
-		}
-
-		return fileSystem.readFileAsBuffer(outputPath).toString('utf-8');
-	}
-
-	private async persistProcessedCss(filePath: string, css: string): Promise<void> {
-		const outputPath = this.resolveProcessedCssPath(filePath);
-		if (!outputPath) {
-			return;
-		}
-
-		fileSystem.ensureDir(path.dirname(outputPath));
-		fileSystem.write(outputPath, css);
-	}
-
-	private async prewarmRuntimeCssCache(): Promise<void> {
-		if (!this.context) {
-			return;
-		}
-
-		const sourceFiles = await fileSystem.glob(['**/*.{css,scss,sass,less}'], {
-			cwd: this.context.srcDir,
-		});
-
-		for (const relativePath of sourceFiles) {
-			const filePath = path.join(this.context.srcDir, relativePath);
-			if (!this.matchesFileFilter(filePath)) {
-				continue;
-			}
-
-			const rawContents = await fileSystem.readFile(filePath);
-			let transformedInput = rawContents;
-
-			if (this.options?.transformInput) {
-				transformedInput = await this.options.transformInput(rawContents, filePath);
-			}
-
-			const processed = await this.process(transformedInput, filePath);
-			this.runtimeCssCache.set(filePath, processed);
-			await this.persistProcessedCss(filePath, processed);
-		}
-	}
-
-	private transformCssSync(input: CssTransformInput): string {
-		const cached = this.runtimeCssCache.get(input.filePath);
-		if (cached) {
-			return cached;
-		}
-
-		const persisted = this.readProcessedCssFromDist(input.filePath);
-		if (persisted) {
-			this.runtimeCssCache.set(input.filePath, persisted);
-			return persisted;
-		}
-
-		const { contents } = input;
-		return typeof contents === 'string' ? contents : contents.toString('utf-8');
-	}
-
-	private async transformCssAsync(input: CssTransformInput): Promise<string> {
-		const { contents, filePath } = input;
-		let transformed: string = typeof contents === 'string' ? contents : contents.toString('utf-8');
-
-		if (this.options?.transformInput) {
-			const result = this.options.transformInput(contents, filePath);
-			transformed =
-				typeof (result as unknown as Record<string, unknown>).then === 'function'
-					? await (result as Promise<string>)
-					: (result as string);
-		}
-
-		const processed = await this.process(transformed, filePath);
-		this.runtimeCssCache.set(filePath, processed);
-		await this.persistProcessedCss(filePath, processed);
-		return processed;
-	}
-
-	override matchesFileFilter(filepath: string): boolean {
-		const filter = this.options?.filter ?? PostCssProcessorPlugin.DEFAULT_OPTIONS.filter;
-		return filter.test(filepath);
-	}
-
-	constructor(
-		config: Omit<ProcessorConfig<PostCssProcessorPluginConfig>, 'name' | 'description'> = {
-			options: PostCssProcessorPlugin.DEFAULT_OPTIONS,
-		},
-	) {
-		super({
-			name: 'ecopages-postcss-processor',
-			description: 'A Processor for transforming CSS files using PostCSS.',
-			capabilities: [
-				{
-					kind: 'stylesheet',
-					extensions: ['*.css'],
-				},
-			],
-			watch: {
-				paths: [],
-				extensions: ['.css', '.scss', '.sass', '.less'],
-				onChange: async ({ path, bridge }) => {
-					await this.handleCssChange(path, bridge);
-				},
-			},
-			...config,
-		});
-	}
-
-	/**
-	 * Handles CSS file changes during development.
-	 * Processes the file and broadcasts a css-update event for hot reloading.
-	 */
-	private async handleCssChange(filePath: string, bridge: IClientBridge): Promise<void> {
-		if (!this.context) return;
-
-		try {
-			let content = await fileSystem.readFile(filePath);
-
-			if (this.options?.transformInput) {
-				content = await this.options.transformInput(content, filePath);
-			}
-
-			const processed = await this.process(content, filePath);
-			this.runtimeCssCache.set(filePath, processed);
-			await this.persistProcessedCss(filePath, processed);
-
-			bridge.cssUpdate(filePath);
-
-			logger.debug(`Processed CSS: ${filePath}`);
-		} catch (error) {
-			const errorMessage = error instanceof Error ? error.message : String(error);
-			logger.error(`Failed to process CSS: ${filePath}`, errorMessage);
-			bridge.error(errorMessage);
-		}
-	}
-
-	get buildPlugins(): EcoBuildPlugin[] {
-		return [
-			createCssLoaderPlugin({
-				name: 'postcss-processor-build-loader',
-				filter: this.getCssFilter(),
-				transform: this.transformCssAsync.bind(this),
-			}),
-		];
-	}
-
-	get plugins(): EcoBuildPlugin[] {
-		return [
-			createCssLoaderPlugin({
-				name: 'postcss-processor-runtime-loader',
-				filter: this.getCssFilter(),
-				transform: this.transformCssSync.bind(this),
-			}),
-		];
-	}
-
-	/**
-	 * Setup the PostCSS processor.
-	 */
-	async setup(): Promise<void> {
-		await this.collectPostcssPlugins();
-		await this.prewarmRuntimeCssCache();
-	}
-
-	/**
-	 * Get the PostCSS plugins from the options or a config file.
-	 * Searches for postcss.config.{js,cjs,mjs,ts} in the root directory.
-	 */
-	private async collectPostcssPlugins(): Promise<void> {
-		if (!this.context) {
-			throw new Error('Context must be set');
-		}
-
-		const configExtensions = ['js', 'cjs', 'mjs', 'ts'];
-		let foundConfigPath: string | undefined;
-		let loadedPlugins: postcss.AcceptedPlugin[] | undefined;
-
-		for (const ext of configExtensions) {
-			const configPath = path.join(this.context.rootDir, `postcss.config.${ext}`);
-			if (fileSystem.exists(configPath)) {
-				foundConfigPath = configPath;
-				break;
-			}
-		}
-
-		if (foundConfigPath) {
-			try {
-				logger.debug(`Loading PostCSS config from: ${foundConfigPath}`);
-
-				const postcssConfigModule = await import(foundConfigPath);
-				const postcssConfig = postcssConfigModule.default || postcssConfigModule;
-
-				if (postcssConfig && typeof postcssConfig.plugins === 'object' && postcssConfig.plugins !== null) {
-					if (Array.isArray(postcssConfig.plugins)) {
-						loadedPlugins = postcssConfig.plugins;
-					} else {
-						loadedPlugins = Object.values(postcssConfig.plugins as PluginsRecord);
-					}
-					logger.debug(`Successfully loaded ${loadedPlugins?.length ?? 0} plugins from config file.`);
-				} else {
-					logger.warn(
-						`PostCSS config file found (${foundConfigPath}), but no valid 'plugins' export detected.`,
-					);
-				}
-			} catch (error: any) {
-				logger.error(`Error loading PostCSS config from ${foundConfigPath}: ${error.message}`, error);
-				loadedPlugins = undefined;
-			}
-		} else {
-			logger.debug('No PostCSS config file found in root directory.');
-		}
-
-		if (loadedPlugins) {
-			this.postcssPlugins = loadedPlugins;
-		} else if (this.options?.plugins) {
-			logger.debug('Using PostCSS plugins provided in processor options.');
-			this.postcssPlugins = Object.values(this.options.plugins);
-		} else {
-			logger.warn(
-				'No PostCSS plugins configured. Use a preset like tailwindV3Preset() or tailwindV4Preset(), ' +
-					'provide plugins via options, or create a postcss.config file.',
-			);
-			this.postcssPlugins = [];
-		}
-
-		if (!this.postcssPlugins || this.postcssPlugins.length === 0) {
-			logger.warn('No PostCSS plugins configured or loaded. CSS processing might be minimal.');
-			this.postcssPlugins = [];
-		}
-	}
-
-	/**
-	 * Process CSS content
-	 * @param fileAsString CSS content as string
-	 * @param filePath Optional file path for resolving relative imports
-	 * @returns Processed CSS
-	 */
-	async process(fileAsString: string, filePath?: string): Promise<string> {
-		return await PostCssProcessor.processStringOrBuffer(fileAsString, {
-			filePath,
-			plugins: this.postcssPlugins,
-			transformOutput: this.options?.transformOutput,
-		});
-	}
-
-	processSync(fileAsString: string, filePath?: string): string {
-		return PostCssProcessor.processStringOrBufferSync(fileAsString, {
-			filePath,
-			plugins: this.postcssPlugins,
-			transformOutput: this.options?.transformOutput,
-		});
-	}
-
-	/**
-	 * Teardown the PostCSS processor.
-	 */
-	async teardown(): Promise<void> {
-		logger.debug('Tearing down PostCSS processor');
-	}
-}
-
-export const postcssProcessorPlugin = (config?: PostCssProcessorPluginConfig): PostCssProcessorPlugin => {
-	return new PostCssProcessorPlugin({
-		options: config,
-	});
-};

package/src/postcss-processor.ts

@@ -1,157 +0,0 @@
-/**
- * This module contains the PostCSS Processor
- * @module
- */
-
-import { existsSync, readFileSync } from 'node:fs';
-import { Logger } from '@ecopages/logger';
-import postcss from 'postcss';
-
-/**
- * PostCSS Processor Options
- */
-export type PostCssProcessorOptions = {
-	plugins?: postcss.AcceptedPlugin[];
-	/**
-	 * Optional file path for resolving relative imports
-	 */
-	filePath?: string;
-	/**
-	 * Optional callback to transform the output CSS
-	 * @param css The processed CSS
-	 * @returns The transformed CSS
-	 */
-	transformOutput?: (css: string) => string | Promise<string>;
-};
-
-/**
- * ProcessPath
- * @param path string
- * @param options {@link PostCssProcessorOptions}
- * @returns string
- */
-export type ProcessPath = (path: string, options?: PostCssProcessorOptions) => Promise<string>;
-
-/**
- * ProcessStringOrBuffer
- * @param contents string | Buffer
- * @param options {@link PostCssProcessorOptions}
- * @returns string
- */
-export type ProcessStringOrBuffer = (contents: string | Buffer, options?: PostCssProcessorOptions) => Promise<string>;
-
-const appLogger = new Logger('[@ecopages/postcss-processor]');
-
-export function getFileAsBuffer(path: string): Buffer {
-	try {
-		if (!existsSync(path)) {
-			throw new Error(`File: ${path} not found`);
-		}
-		return readFileSync(path);
-	} catch (error) {
-		const errorMessage = error instanceof Error ? error.message : String(error);
-		throw new Error(`[ecopages] Error reading file: ${path}, ${errorMessage}`);
-	}
-}
-
-const getPlugins = (options?: PostCssProcessorOptions): postcss.AcceptedPlugin[] => {
-	if (!options || !options.plugins) return [];
-	return Array.isArray(options.plugins) ? options.plugins : Object.values(options.plugins);
-};
-
-/**
- * It processes the given path using PostCSS
- * @param path string
- * @param options {@link PostCssProcessorOptions}
- * @returns string
- *
- * @example
- * ```ts
- * PostCssProcessor.processPath('path/to/file.css').then((processedCss) => {
- *  console.log(processedCss);
- * });\n */
-const processPath: ProcessPath = async (path, options) => {
-	const contents = getFileAsBuffer(path);
-
-	return postcss(getPlugins(options))
-		.process(contents, { from: path })
-		.then((result) => result.css)
-		.catch((error) => {
-			appLogger.error('Error processing file with PostCssProcessor', error.message);
-			return '';
-		});
-};
-
-/**
- * It processes the given string or buffer using PostCSS
- * @param contents string | Buffer
- * @param options {@link PostCssProcessorOptions}
- * @returns string
- *
- * @example
- * ```ts
- * const css = `body { @apply bg-blue-500; }`;
- *
- * PostCssProcessor.processString(css).then((processedCss) => {
- * console.log(processedCss);
- * });
- * ```
- */
-const processStringOrBuffer: ProcessStringOrBuffer = async (contents, options) => {
-	if (!contents) return '';
-
-	return postcss(getPlugins(options))
-		.process(contents, { from: options?.filePath })
-		.then(async (result) => {
-			let css = result.css;
-			if (options?.transformOutput) {
-				css = await options.transformOutput(css);
-			}
-			return css;
-		})
-		.catch((error) => {
-			appLogger.error('Error processing string or buffer with PostCssProcessor', error.message);
-			return '';
-		});
-};
-
-export type ProcessStringOrBufferSync = (contents: string | Buffer, options?: PostCssProcessorOptions) => string;
-
-const processStringOrBufferSync: ProcessStringOrBufferSync = (contents, options) => {
-	if (!contents) return '';
-
-	try {
-		const result = postcss(getPlugins(options)).process(contents, { from: options?.filePath });
-		let css = result.css;
-		if (options?.transformOutput) {
-			const output = options.transformOutput(css);
-			if (output instanceof Promise) {
-				throw new Error('transformOutput must be synchronous when used with processStringOrBufferSync');
-			}
-			css = output;
-		}
-		return css;
-	} catch (error) {
-		if (error instanceof Error && error.message.includes('transformOutput must be synchronous')) {
-			throw error;
-		}
-		appLogger.error('Error processing string or buffer with PostCssProcessor', (error as Error).message);
-		return '';
-	}
-};
-
-/**
- * PostCSS Processor
- * - {@link processPath} : It processes the given path using PostCSS
- * - {@link processStringOrBuffer}: It processes the given string or buffer using PostCSS
- * - {@link processStringOrBufferSync}: It processes the given string or buffer synchronously using PostCSS (requires all plugins to be sync)
- */
-export const PostCssProcessor: {
-	processPath: ProcessPath;
-	processStringOrBuffer: ProcessStringOrBuffer;
-	processStringOrBufferSync: ProcessStringOrBufferSync;
-} = {
-	processPath,
-	processStringOrBuffer,
-	processStringOrBufferSync,
-};

package/src/presets/index.ts

@@ -1,7 +0,0 @@
-/**
- * PostCSS Processor Presets
- * @module @ecopages/postcss-processor/presets
- */
-
-export { tailwindV3Preset } from './tailwind-v3';
-export { tailwindV4Preset, type TailwindV4PresetOptions } from './tailwind-v4';

package/src/presets/tailwind-v3.ts

@@ -1,61 +0,0 @@
-/**
- * Tailwind CSS v3 Preset for PostCSS Processor
- * @module @ecopages/postcss-processor/presets/tailwind-v3
- *
- * Requires: tailwindcss, postcss-import, autoprefixer, cssnano
- * Install: bun add tailwindcss postcss-import autoprefixer cssnano
- */
-
-import autoprefixer from 'autoprefixer';
-import browserslist from 'browserslist';
-import cssnano from 'cssnano';
-import type postcss from 'postcss';
-import postcssImport from 'postcss-import';
-import tailwindcss from 'tailwindcss';
-import tailwindcssNesting from 'tailwindcss/nesting/index.js';
-import type { PostCssProcessorPluginConfig } from '../plugin.ts';
-
-type PluginsRecord = Record<string, postcss.AcceptedPlugin>;
-
-/**
- * Creates a PostCSS processor config preset for Tailwind CSS v3.
- *
- * Features:
- * - Uses classic Tailwind v3 plugin stack
- * - Includes postcss-import, tailwindcss/nesting, tailwindcss, autoprefixer, cssnano
- *
- * @example
- * ```typescript
- * import { postcssProcessorPlugin } from '@ecopages/postcss-processor';
- * import { tailwindV3Preset } from '@ecopages/postcss-processor/presets';
- *
- * // Basic usage
- * postcssProcessorPlugin(tailwindV3Preset())
- *
- * // Extend with additional plugins
- * const preset = tailwindV3Preset();
- * postcssProcessorPlugin({
- *   ...preset,
- *   plugins: { ...preset.plugins, myPlugin: myPlugin() },
- * })
- * ```
- */
-export function tailwindV3Preset(): PostCssProcessorPluginConfig {
-	// Check if browserslist config exists
-	const browserslistConfig = browserslist.loadConfig({ path: process.cwd() });
-	const autoprefixerOptions = browserslistConfig
-		? {}
-		: {
-				overrideBrowserslist: ['>0.3%', 'not ie 11', 'not dead', 'not op_mini all'],
-			};
-
-	const plugins: PluginsRecord = {
-		'postcss-import': postcssImport(),
-		'tailwindcss/nesting': tailwindcssNesting(),
-		tailwindcss: tailwindcss(),
-		autoprefixer: autoprefixer(autoprefixerOptions),
-		cssnano: cssnano(),
-	};
-
-	return { plugins };
-}

package/src/presets/tailwind-v4.ts

@@ -1,113 +0,0 @@
-/**
- * Tailwind CSS v4 Preset for PostCSS Processor
- * @module @ecopages/postcss-processor/presets/tailwind-v4
- *
- * Requires: @tailwindcss/postcss, cssnano
- * Install: bun add @tailwindcss/postcss cssnano
- */
-
-import tailwindcss from '@tailwindcss/postcss';
-import autoprefixer from 'autoprefixer';
-import browserslist from 'browserslist';
-import cssnano from 'cssnano';
-import path from 'node:path';
-import postcssImport from 'postcss-import';
-import postcssNested from 'postcss-nested';
-import type { PostCssProcessorPluginConfig } from '../plugin.ts';
-
-/**
- * Options for Tailwind v4 preset
- */
-export interface TailwindV4PresetOptions {
-	/**
-	 * Absolute path to the main Tailwind CSS file containing `@import "tailwindcss"`.
-	 * Used to calculate relative @reference paths for CSS files using @apply.
-	 */
-	referencePath: string;
-}
-
-/**
- * Creates a PostCSS processor config preset for Tailwind CSS v4.
- *
- * Features:
- * - Uses `@tailwindcss/postcss` plugin (v4)
- * - Automatically injects `@reference` headers for `@apply` support
- * - Includes cssnano for CSS minification
- *
- * @example
- * ```typescript
- * import { postcssProcessorPlugin } from '@ecopages/postcss-processor';
- * import { tailwindV4Preset } from '@ecopages/postcss-processor/presets';
- *
- * // Basic usage
- * postcssProcessorPlugin(tailwindV4Preset({
- *   referencePath: path.resolve(import.meta.dir, 'src/styles/tailwind.css'),
- * }))
- *
- * // Extend with additional plugins
- * const preset = tailwindV4Preset({ referencePath });
- * postcssProcessorPlugin({
- *   ...preset,
- *   plugins: { ...preset.plugins, myPlugin: myPlugin() },
- * })
- * ```
- */
-export function tailwindV4Preset(options: TailwindV4PresetOptions): PostCssProcessorPluginConfig {
-	const { referencePath } = options;
-
-	// Check if browserslist config exists
-	const browserslistConfig = browserslist.loadConfig({ path: process.cwd() });
-	const autoprefixerOptions = browserslistConfig
-		? {}
-		: {
-				overrideBrowserslist: ['>0.3%', 'not ie 11', 'not dead', 'not op_mini all'],
-			};
-
-	return {
-		plugins: {
-			'postcss-import': postcssImport(),
-			'postcss-nested': postcssNested(),
-			'@tailwindcss/postcss': tailwindcss(),
-			autoprefixer: autoprefixer(autoprefixerOptions),
-			cssnano: cssnano(),
-		},
-		transformInput: async (contents: string | Buffer, filePath: string): Promise<string> => {
-			const css = contents instanceof Buffer ? contents.toString('utf-8') : (contents as string);
-			const normalizedFilePath = path.resolve(filePath);
-			const normalizedReferencePath = path.resolve(referencePath);
-
-			/** Skip transformation for the main tailwind entry file */
-			if (normalizedFilePath === normalizedReferencePath) {
-				return css;
-			}
-
-			/** Skip if file already has an @reference directive */
-			if (/^\s*@reference\s+/m.test(css)) {
-				return css;
-			}
-
-			const relativePath = path.relative(path.dirname(filePath), referencePath);
-
-			/** Skip if file already imports the referencePath */
-			if (css.includes(`@import '${relativePath}'`) || css.includes(`@import "${relativePath}"`)) {
-				return css;
-			}
-
-			/**
-			 * Replace `@import 'tailwindcss'` with an import to the referencePath.
-			 * This ensures custom theme variables are available for @apply directives.
-			 */
-			const tailwindImportPattern = /^@import\s+['"]tailwindcss(?:\/[^'"]*)?['"];?\s*$/m;
-			if (tailwindImportPattern.test(css)) {
-				return css.replace(tailwindImportPattern, `@import '${relativePath}';`);
-			}
-
-			/** If file uses @apply but has no tailwind import, add @reference */
-			if (css.includes('@apply')) {
-				return `@reference "${relativePath}";\n\n${css}`;
-			}
-
-			return css;
-		},
-	};
-}