glot baseline

Establish a baseline for existing projects

The baseline command inserts glot-disable-next-line comments to suppress existing hardcoded text and untranslated value issues. This is useful when adopting glot in an existing project.

Usage

npm

npx glot baseline [OPTIONS]

Options

--apply · boolean · default: "false"

Actually insert comments. Without this flag, glot runs in dry-run mode and only shows what would be changed.

--rules · string[] · default: "all"

Rules to add disable comments for. Can be specified multiple times. If not specified, all rules are applied.

Possible values:

• hardcoded - Suppress hardcoded text issues
• untranslated - Suppress untranslated value issues that have source usages

--source-root · string

Override the source code root directory. Defaults to the value from configuration file.

--messages-root · string

Override the messages directory path. Defaults to the value from configuration file.

--primary-locale · string

Override the primary locale. Defaults to the value from configuration file.

-v, --verbose · boolean · default: "false"

Enable verbose output for debugging.

Why Use Baseline?

When adding glot to an existing project, you might have hundreds of hardcoded strings. Fixing them all at once isn’t practical. The baseline command lets you:

1. Suppress existing source-level issues
2. Start with a clean slate
3. Prevent new hardcoded text from being added
4. Gradually fix existing issues over time

baseline --rules untranslated inserts source comments only for untranslated values that have source usages. Untranslated catalog values with no usage cannot be suppressed with source comments; translate them, remove unused keys, or configure severities.untranslated for a project-wide policy.

Dry-Run Mode (Default)

Preview what comments would be inserted:

npm

npx glot baseline

Output:

Dry-run mode: showing comments that would be inserted

./src/components/Button.tsx:5
  Would add: // glot-disable-next-line
  Before: return <button>Submit</button>;

./src/components/Form.tsx:12
  Would add: // glot-disable-next-line
  Before: <input placeholder="Enter your email" />

2 comments would be inserted. Run with --apply to insert.

Apply Changes

Insert the suppression comments:

npm

npx glot baseline --apply

Output:

./src/components/Button.tsx:5
  Inserted: // glot-disable-next-line

./src/components/Form.tsx:12
  Inserted: // glot-disable-next-line

✓ 2 comments inserted

Result

Before:

export function Button() {
  return <button>Submit</button>;
}

After:

export function Button() {
  // glot-disable-next-line
  return <button>Submit</button>;
}

Workflow

1. Run Baseline

   Insert suppression comments for all existing hardcoded text:

   npm

   npx glot baseline --apply
   
2. Commit Changes

   Commit the baseline to your repository: bash git add -A git commit -m "chore: add glot baseline comments"

3. Add to CI

   Add glot check to your CI pipeline. New hardcoded text will be caught.

4. Gradually Fix

   Over time, remove the suppression comments and add proper translations.

Smart Behavior

The baseline command is smart about where it inserts comments:

• Skips lines that already have translation function calls
• Places comments on the correct line for multiline JSX
• Handles JSX attributes correctly

Related

Directives

Learn about inline suppression directives

Check Command

Run i18n checks