wp-calypso/packages/eslint-plugin-wpcalypso/lib/rules/i18n-unlocalized-url.js

/**
 * @file Disallow using unlocalized URL strings
 * @author Automattic
 * @copyright 2023 Automattic. All rights reserved.
 * See LICENSE.md file in root directory for full license.
 */

//------------------------------------------------------------------------------
// Constants
//------------------------------------------------------------------------------

const LOCALIZABLE_URLS = [
	// apps.wordpress.com/**
	/^(https?:)?\/\/apps\.wordpress\.com/i,

	// automattic.com/cookies/
	/^(https?:)?\/\/automattic\.com\/cookies\/?((#|\?).*)?$/i,

	// automattic.com/privacy/
	/^(https?:)?\/\/automattic\.com\/privacy\/?((#|\?).*)?$/i,

	// wordpress.com/tos/
	/^(https?:)?\/\/wordpress\.com\/tos\/?((#|\?).*)?$/i,

	// wordpress.com/blog/
	/^(https?:)?\/\/wordpress\.com\/blog\/?((#|\?).*)?$/i,

	// wordpress.com/forums/
	/^(https?:)?\/\/wordpress\.com\/forums\/?((#|\?).*)?$/i,

	// wordpress.com/go/**
	/^(https?:)?\/\/wordpress\.com\/go($|(\/|\?|#).*)/i,

	// wordpress.com/support/**
	/^(https?:)?\/\/wordpress\.com\/support($|(\/|\?|#).*)/i,
];

//------------------------------------------------------------------------------
// Helper Functions
//------------------------------------------------------------------------------

const getCallee = require( '../util/get-callee' );

/**
 * A helper funciton that would return the parent node which is relevant to the specific rule checks.
 * @param   {Object} node
 * @returns {Object}
 */
function getRelevantNodeParent( node ) {
	// In case the node is operand in ternary or logical operator, return the grand parent.
	if ( [ 'ConditionalExpression', 'LogicalExpression' ].includes( node.parent.type ) ) {
		return getRelevantNodeParent( node.parent );
	}

	return node.parent;
}

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

const rule = ( module.exports = function ( context ) {
	const variableDeclarationValues = [];
	const urlVariables = new Set();

	/**
	 * Check whether the node is an unlocalized URL.
	 * @param   {Object} node
	 * @param   {string} nodeValueString
	 * @returns {void}
	 */
	function handleUnlocalizedUrls( node, nodeValueString ) {
		// Node is wrapped in localizeUrl, therefore we can assume it's localized and we don't need to do any further checks.
		if ( getCallee( getRelevantNodeParent( node ) ).name === 'localizeUrl' ) {
			return;
		}

		// Check whether the string value of the node is localizable string.
		if ( ! LOCALIZABLE_URLS.some( ( url ) => url.test( nodeValueString ) ) ) {
			return;
		}

		// URL string is assigned to a variable and variable is possibly later used in a localizeUrl call;
		if ( getRelevantNodeParent( node ).type === 'VariableDeclarator' ) {
			variableDeclarationValues.push( node );
		} else {
			// Report unlocalized url.
			context.report( {
				node,
				message: rule.ERROR_MESSAGE,
			} );
		}
	}

	return {
		'Program:exit': function () {
			for ( const node of variableDeclarationValues ) {
				if ( ! urlVariables.has( getRelevantNodeParent( node )?.id?.name ) ) {
					// Report unlocalized url.
					context.report( {
						node,
						message: rule.ERROR_MESSAGE,
					} );
				}
			}
		},
		CallExpression: function ( node ) {
			const callee = getCallee( node );
			if (
				callee !== node &&
				callee.name === 'localizeUrl' &&
				node.arguments?.[ 0 ]?.type === 'Identifier'
			) {
				urlVariables.add( node.arguments[ 0 ]?.name );
			}
		},
		Literal: function ( node ) {
			handleUnlocalizedUrls( node, node.value );
		},
		TemplateElement: function ( node ) {
			const templateLiteralNode = node.parent;
			handleUnlocalizedUrls( templateLiteralNode, node.value.raw );
		},
	};
} );

rule.ERROR_MESSAGE = "URL string should be wrapped in a 'localizeUrl' function call";

rule.schema = [];