ec0lint-style/lib/rules/lighter-image-files/index.js

CSS linter for reducing digital footprint with ec0lint.

'use strict';

const functionArgumentsSearch = require('../../utils/functionArgumentsSearch');
const report = require('../../utils/report');
const ruleMessages = require('../../utils/ruleMessages');
const validateOptions = require('../../utils/validateOptions');
const calculateCO2ImageFilesReduction = require('../../../scripts/co2-module');

const ruleName = 'lighter-image-files';

const messages = ruleMessages(ruleName, {
	rejected:
		'Format of image files can be changed to WebP or SVG. Your image can be converted online at https://cloudconvert.com/\n' +
		'Estimated CO2 reduction that you can achieve by converting your file is: ',
});

const meta = {
	url: 'http://ec0lint.com/features/lighter-image-files',
};

/** @type {import('ec0lint-style').Rule} */
const rule = (primary) => {
	return (root, result) => {
		const validOptions = validateOptions(result, ruleName, { actual: primary });

		if (!validOptions) {
			return;
		}

		root.walkDecls((decl) => {
			functionArgumentsSearch(decl.toString(), 'url', (args, index) => {
				const url = args.trim().replace(/^['"]+|['"]+$/g, '');

				if (
					!url.includes('.tiff') &&
					!url.includes('.ps') &&
					!url.includes('.tif') &&
					!url.includes('.png') &&
					!url.includes('.psd') &&
					!url.includes('.ppm') &&
					!url.includes('.rgb')
				) {
					return;
				}

				const co2Reduction = calculateCO2ImageFilesReduction(url).toFixed(2);

				const message = ruleMessages(ruleName, {
					rejected:
						'Format of image files can be changed to WebP or SVG. Your image can be converted online at https://cloudconvert.com/\n' +
						`Estimated CO2 reduction that you can achieve by converting your file is: ${co2Reduction}g`,
				});

				report({
					message: message.rejected,
					node: decl,
					index,
					result,
					ruleName,
				});
			});
		});
	};
};

rule.ruleName = ruleName;
rule.messages = messages;
rule.meta = meta;
module.exports = rule;