eslint-plugin-ember/lib/rules/template-no-whitespace-within-word.js

ESLint plugin for Ember.js apps

const WHITESPACE_ENTITY_LIST = [
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  ' ',
  '  ',
  '​',
  '​',
  '​',
  '​',
  '​',
  '​',
  '‌',
  '‌',
  '‍',
  '‍',
  '‎',
  '‎',
  '‏',
  '‏',
  ' ',
  ' ',
  '  ',
  '⁠',
  '⁠',
  '⁡',
  '⁡',
  '⁡',
  '⁢',
  '⁢',
  '⁢',
  '⁣',
  '⁣',
  '⁣',
];

const CHARACTER_REGEX = '[a-zA-Z]';

// Build a regex that catches alternating non-whitespace/whitespace characters,
// for example, 'W e l c o m e'. The pattern requires 5 alternations to avoid
// false positives: (whitespace)(char)(whitespace)(char)(whitespace)
const whitespaceOrEntityRegex = `(?:\\s|${WHITESPACE_ENTITY_LIST.map(
  (entity) => `\\${entity}`
).join('|')})+`;
const WHITESPACE_WITHIN_WORD_REGEX = new RegExp(
  `${whitespaceOrEntityRegex}${CHARACTER_REGEX}${whitespaceOrEntityRegex}${CHARACTER_REGEX}${whitespaceOrEntityRegex}`
);

/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
  meta: {
    type: 'layout',
    docs: {
      description: 'disallow excess whitespace within words (e.g. "W e l c o m e")',
      category: 'Accessibility',
      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-whitespace-within-word.md',
      templateMode: 'both',
    },
    schema: [],
    messages: {
      excessWhitespace: 'Excess whitespace in layout detected.',
    },
    originallyFrom: {
      name: 'ember-template-lint',
      rule: 'lib/rules/no-whitespace-within-word.js',
      docs: 'docs/rule/no-whitespace-within-word.md',
      tests: 'test/unit/rules/no-whitespace-within-word-test.js',
    },
  },

  create(context) {
    const sourceCode = context.sourceCode;

    return {
      GlimmerTextNode(node) {
        // Skip text inside attributes
        let parent = node.parent;
        while (parent) {
          if (parent.type === 'GlimmerAttrNode') {
            return;
          }
          // Skip text inside <style> elements
          if (parent.type === 'GlimmerElementNode' && parent.tag === 'style') {
            return;
          }
          parent = parent.parent;
        }

        const text = sourceCode.getText(node);
        if (WHITESPACE_WITHIN_WORD_REGEX.test(text)) {
          context.report({
            node,
            messageId: 'excessWhitespace',
          });
        }
      },
    };
  },
};