4 |
5 | Set of eslint rules for [Lingui](https://lingui.dev) projects
6 |
7 | [](https://www.npmjs.com/package/eslint-plugin-lingui)
8 | [](https://www.npmjs.com/package/eslint-plugin-lingui)
9 | [](https://github.com/lingui/eslint-plugin/actions/workflows/ci.yml)
10 | [](https://codecov.io/gh/lingui/eslint-plugin)
11 | [](https://github.com/lingui/eslint-plugin/blob/main/LICENSE)
12 |
13 |
',
474 | errors: defaultError,
475 | },
476 | {
477 | name: 'detects unlocalized ARIA label',
478 | code: '',
479 | errors: defaultError,
480 | },
481 | {
482 | name: 'handles JSX identifier attribute correctly',
483 | code: '',
484 | errors: defaultError,
485 | },
486 |
487 | // ==================== Acceptable Expression Violations ====================
488 | {
489 | name: 'detects LogicalExpression in lowercase',
490 | code: 'const myLowerCase = shouldGreet && "Hello"',
491 | options: [ignoreUpperCaseName],
492 | errors: defaultError,
493 | },
494 | {
495 | name: 'detects ConditionalExpression in camelCase',
496 | code: 'const camelCase = isGreeting ? "Hello" : count',
497 | options: [ignoreUpperCaseName],
498 | errors: defaultError,
499 | },
500 | {
501 | name: 'detects BinaryExpression in lowercase',
502 | code: 'let myVar; myVar = "Hello" + count;',
503 | options: [ignoreUpperCaseName],
504 | errors: defaultError,
505 | },
506 | {
507 | name: 'detects expression in lowercase property',
508 | code: 'const obj = { lowerProp: !("Hello" as string) };',
509 | options: [ignoreUpperCaseName],
510 | errors: defaultError,
511 | },
512 | {
513 | name: 'handles type assertions with string literals',
514 | code: "const test = ('hello' as unknown as string);",
515 | options: [ignoreUpperCaseName],
516 | errors: [{ messageId: 'default' }],
517 | },
518 | {
519 | name: 'reports constants when missing TSASExpression in object',
520 | code: 'const paramsByDropSide = { top: "above", bottom: "below" };',
521 | errors: [{ messageId: 'default' }, { messageId: 'default' }],
522 | },
523 |
524 | // ==================== TypeScript Function Parameters ====================
525 | {
526 | name: 'handles function call with no parameters',
527 | code: `
528 | function noParams() {}
529 | noParams("this should error");
530 | `,
531 | options: [{ useTsTypes: true }],
532 | errors: [{ messageId: 'default' }],
533 | },
534 | {
535 | name: 'handles function call with wrong number of arguments',
536 | code: `
537 | function oneParam(p: "a" | "b") {}
538 | oneParam("a", "this should error");
539 | `,
540 | options: [{ useTsTypes: true }],
541 | errors: [{ messageId: 'default' }],
542 | },
543 | {
544 | name: 'handles function call where parameter is not a string literal type',
545 | code: `
546 | function stringParam(param: string) {}
547 | stringParam("should report error");
548 | `,
549 | options: [{ useTsTypes: true }],
550 | errors: defaultError,
551 | },
552 | {
553 | name: 'handles method call where signature cannot be resolved',
554 | code: `
555 | const obj = { method: (x: any) => {} };
556 | obj["method"]("should report error");
557 | `,
558 | options: [{ useTsTypes: true }],
559 | errors: defaultError,
560 | },
561 | {
562 | name: 'requires translation for non-union string parameters',
563 | code: `
564 | function test(first: string, second: "yes" | "no") {
565 | test("needs translation", "yes");
566 | }
567 | `,
568 | options: [{ useTsTypes: true }],
569 | errors: [{ messageId: 'default' }],
570 | },
571 | {
572 | name: 'handles type system error gracefully',
573 | code: `
574 | // This should cause type system issues but not crash
575 | const x = (unknown as any).nonexistent("test");
576 | `,
577 | options: [{ useTsTypes: true }],
578 | errors: [{ messageId: 'default' }],
579 | },
580 | ],
581 | })
582 |
583 | // ==================== Default Ignore Regex Tests ====================
584 | describe('Default ignore regex', () => {
585 | const regex = '^(?![A-Z])\\S+$'
586 |
587 | test.each([
588 | ['hello', true, 'allows lowercase word'],
589 | ['helloMyVar', true, 'allows camelCase'],
590 | ['package.json', true, 'allows filenames'],
591 | ['./src/**/*.test*', true, 'allows paths'],
592 | ['camel_case', true, 'allows snake_case'],
593 | ['Hello', false, 'blocks capitalized words'],
594 | ['hello world', false, 'blocks strings with spaces'],
595 | ['Hello World', false, 'blocks title case with spaces'],
596 | ])('%s => %s (%s)', (input, expected, description) => {
597 | expect(new RegExp(regex).test(input)).toBe(expected)
598 | })
599 | })
600 |
--------------------------------------------------------------------------------
/tests/src/rules/t-call-in-function.test.ts:
--------------------------------------------------------------------------------
1 | import { rule, name } from '../../../src/rules/t-call-in-function'
2 | import { RuleTester } from '@typescript-eslint/rule-tester'
3 |
4 | describe('', () => {})
5 |
6 | const ruleTester = new RuleTester()
7 |
8 | const errors = [{ messageId: 'default' }] as const
9 |
10 | ruleTester.run(name, rule, {
11 | valid: [
12 | {
13 | code: 'function hello() { return t`Hello`}',
14 | },
15 |
16 | { code: 'class React { render() { return t`Hello` } }' },
17 | { code: 'class React { render = () => { return t`Hello` } }' },
18 | { code: 'class React { static state = t`Hello` }' },
19 | {
20 | code: 'const a = () => {t`Hello`}',
21 | },
22 | {
23 | code: 'const StyledAMLQuestionsContainer = styled(AMLQuestionsContainer)` \
24 | text-align: center; \
25 | padding: ${tokens.spacing20};\
26 | `',
27 | },
28 | {
29 | code: 'const a = () => {t("Hello")}',
30 | },
31 | {
32 | code: 'msg`Hello`',
33 | },
34 | {
35 | code: 'defineMessage`Hello`',
36 | },
37 | ],
38 |
39 | invalid: [
40 | { code: 'for (const item of items) { t`Hello` }', errors },
41 | { code: '{ t`Hello` }', errors },
42 | { code: 'for (const item of items) { t("Hello") }', errors },
43 | { code: '{ t("Hello") }', errors },
44 | { code: 't`Hello`', errors },
45 | { code: 't("Hello")', errors },
46 | { code: 'const hello = [t({id:"hello", message:"hello"})]', errors },
47 | ],
48 | })
49 |
--------------------------------------------------------------------------------
/tests/src/rules/text-restrictions.test.ts:
--------------------------------------------------------------------------------
1 | import { rule, Option, RestrictionRule } from '../../../src/rules/text-restrictions'
2 |
3 | import { RuleTester } from '@typescript-eslint/rule-tester'
4 |
5 | describe('', () => {})
6 |
7 | const quotesRule: RestrictionRule = {
8 | patterns: ["''", '’', '“'],
9 | message: `Quotes should be ' or "`,
10 | }
11 |
12 | const bracketRule: RestrictionRule = {
13 | patterns: ['<', '>', '<', '>'],
14 | message: 'Exclude <,> symbols from translations',
15 | }
16 |
17 | const wordRule: RestrictionRule = {
18 | patterns: ['e-mail'],
19 | message: `Use email instead of e-mail`,
20 | flags: 'i',
21 | }
22 |
23 | const lineBreakRule: RestrictionRule = {
24 | patterns: ['^\n', '\n$', '^\r\n', '\r\n$'],
25 | message: `No line breaks`,
26 | }
27 |
28 | const ruleTester = new RuleTester({
29 | languageOptions: {
30 | parserOptions: {
31 | ecmaFeatures: {
32 | jsx: true,
33 | },
34 | },
35 | },
36 | })
37 |
38 | ruleTester.run