Improvements for eslint-i18n-package

[CoenWarmer]

Summary

Screen.Recording.2023-11-20.at.23.01.33.mov

This PR adds the following improvements to the ESLint i18n Translation package:

@kbn/i18n/i18n_translate_should_start_with_the_right_id

This rule checks every instance of i18n.translate() if the first parameter that is passed:

1. is truthy and is a string value,
2. starts with the correct i18n app identifier for the file that is being checked.

It checks the repo for the i18nrc.json and /x-pack/i18nrc.json files and determines what the right i18n identifier should be.

If the parameter is missing or does not start with the right i18n identifier, it can autofix the parameter.

This rule is useful when defining translated values in plain functions (non-JSX), but it works in JSX as well.

Example

This code:

// Filename: /x-pack/plugins/observability/public/my_function.ts

function myFunction() {
    const translations = [
        {
            id: 'copy';
            label: i18n.translate()
        }
    ]
}

will be autofixed with:

import { i18n } from '@kbn/i18n';

function myFunction() {
    const translations = [
        {
            id: 'copy';
            label: i18n.translate('xpack.observability.myFunction.', { defaultMessage: '' })
        }
    ]
}

If i18n has not been imported yet, the autofix will automatically add the import statement as well.

Bug fixes:

• The rule strings_should_be_translated_with_formatted_message rule has been removed for Obs plugins for now, as the autofix conflicts with the strings_should_be_translated_with_i18n_translate and ESLint does not provide a mechanism at present to prefer one autofix suggestion over the other.
• All the rules in the package now support nested plugins, i.e. /x-pack/parent_folder/plugin_folder/public)
• All the rules in the package now also support files in the server and common folders, i.e. /x-pack/parent_folder/plugin_folder/server)
• i18n import lines are added correctly in files that don't have a React import yet.
• Updated tests

[apmmachine]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
• run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

[CoenWarmer]

@elasticmachine merge upstream

[CoenWarmer]

@elasticmachine merge upstream

[CoenWarmer]

@elasticmachine merge upstream

[CoenWarmer]

@elasticmachine merge upstream

[miltonhultgren]

Overall this looks good, some questions and small readability suggestions 👍🏼

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 540b962

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
serverlessSearch	369.1KB	369.2KB	+147.0B

History

• 💔 Build #177888 failed 190c1c4
• 💔 Build #177845 failed 1406864
• 💔 Build #177744 failed bc512b3
• 💔 Build #177315 failed dd2cd0c
• 💔 Build #177279 failed e4c8149

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream