formipay/node_modules/@wordpress/eslint-plugin/rules/i18n-text-domain.js

/**
 * Internal dependencies
 */
const {
	TRANSLATION_FUNCTIONS,
	getTranslateFunctionName,
} = require( '../utils' );

/**
 * Returns the text domain passed to the given translation function.
 *
 * @param {string} functionName Translation function name.
 * @param {Array}  args         Function arguments.
 * @return {undefined|*} Text domain argument.
 */
function getTextDomain( functionName, args ) {
	switch ( functionName ) {
		case '__':
			return args[ 1 ];
		case '_x':
			return args[ 2 ];
		case '_n':
			return args[ 3 ];
		case '_nx':
			return args[ 4 ];
		default:
			return undefined;
	}
}

module.exports = {
	meta: {
		type: 'problem',
		schema: [
			{
				type: 'object',
				properties: {
					// Supports a single string as the majority use case,
					// but also an array of text domains.
					allowedTextDomain: {
						anyOf: [
							{
								type: 'array',
								items: {
									type: 'string',
								},
								uniqueItems: true,
							},
							{
								type: 'string',
							},
						],
					},
				},
				additionalProperties: false,
			},
		],
		messages: {
			invalidValue: "Invalid text domain '{{ textDomain }}'",
			invalidType: 'Text domain is not a string literal',
			unnecessaryDefault: 'Unnecessary default text domain',
			missing: 'Missing text domain',
			useAllowedValue:
				'Use one of the allowed text domains: {{ textDomains }}',
		},
		fixable: 'code',
	},
	create( context ) {
		const options = context.options[ 0 ] || {};
		const { allowedTextDomain } = options;
		const allowedTextDomains = Array.isArray( allowedTextDomain )
			? allowedTextDomain
			: [ allowedTextDomain ].filter( ( value ) => value );
		const canFixTextDomain = allowedTextDomains.length === 1;
		const allowDefault =
			allowedTextDomains.length === 0 ||
			allowedTextDomains.includes( 'default' );

		return {
			CallExpression( node ) {
				const { callee, arguments: args } = node;

				const functionName = getTranslateFunctionName( callee );

				if ( ! TRANSLATION_FUNCTIONS.has( functionName ) ) {
					return;
				}

				const textDomain = getTextDomain( functionName, args );

				if ( textDomain === undefined ) {
					if ( ! allowDefault ) {
						const addMissingTextDomain = ( fixer ) => {
							const lastArg = args[ args.length - 1 ];
							return fixer.insertTextAfter(
								lastArg,
								`, '${ allowedTextDomains[ 0 ] }'`
							);
						};

						context.report( {
							node,
							messageId: 'missing',
							fix: canFixTextDomain ? addMissingTextDomain : null,
						} );
					}
					return;
				}

				const { type, value, range } = textDomain;

				if ( type !== 'Literal' ) {
					context.report( {
						node,
						messageId: 'invalidType',
					} );
					return;
				}

				if ( 'default' === value && allowDefault ) {
					const removeDefaultTextDomain = ( fixer ) => {
						const previousArgIndex = args.indexOf( textDomain ) - 1;
						const previousArg = args[ previousArgIndex ];
						return fixer.removeRange( [
							previousArg.range[ 1 ],
							range[ 1 ],
						] );
					};

					context.report( {
						node,
						messageId: 'unnecessaryDefault',
						fix: removeDefaultTextDomain,
					} );
					return;
				}

				if (
					allowedTextDomains.length &&
					! allowedTextDomains.includes( value )
				) {
					const replaceTextDomain = ( fixer ) => {
						return fixer.replaceTextRange(
							// Account for quotes.
							[ range[ 0 ] + 1, range[ 1 ] - 1 ],
							allowedTextDomains[ 0 ]
						);
					};

					context.report( {
						node,
						messageId: 'invalidValue',
						data: {
							textDomain: value,
						},
						fix: canFixTextDomain ? replaceTextDomain : null,
					} );
				}
			},
		};
	},
};