Configuration File

The .gleef/config.json file controls how Gleef CLI processes your localization files. This file is created automatically by gleef init but can be customized for complex project setups.

Configuration Location

The configuration file is always located at:

your-project/
└── .gleef/
    └── config.json

This file should be committed to version control so your team shares the same configuration.

Basic Configuration Structure

{
  "localeFilePatterns": [
    "src/locales/{locale}.json",
    "public/i18n/{locale}/{feature}.json"
  ],
  "formatOptions": {
    "json": {
      "nested": true
    },
    "xml": {
      "nested": false
    }
  },
  "customLocaleNames": {
    "en-US": "english",
    "fr-FR": "french"
  },
  "prependNamespaceToKeys": false
}

Configuration Properties

localeFilePatterns

Type: string[]
Required: Yes Defines placeholder patterns that match your localization files. Each pattern must include the {locale} placeholder.

{
  "localeFilePatterns": [
    "src/locales/{locale}.json",              // Simple locale files
    "public/i18n/{locale}/{feature}.json",    // Namespaced by feature
    "assets/strings/{locale}.strings",        // iOS strings files
    "config/locales/{feature}.{locale}.yml"   // Feature-first naming
  ]
}

Placeholder Syntax:

Placeholder	Description	Example
`{locale}`	Required - Locale identifier	`en`, `fr-FR`, `es-ES`
`{feature}`	Optional - Feature/namespace name	`common`, `auth`, `dashboard`
`{namespace}`	Optional - Alternative to feature	`header`, `footer`, `modal`

Pattern Examples:

Pattern	Matches	Structure
`src/{locale}.json`	`src/en.json`, `src/fr.json`	Simple structure
`locales/{locale}/{feature}.json`	`locales/en/common.json`, `locales/fr/auth.json`	Locale-first namespacing
`i18n/{feature}.{locale}.json`	`i18n/common.en.json`, `i18n/auth.fr.json`	Feature-first namespacing
`assets/{locale}/strings.xml`	`assets/en/strings.xml`, `assets/fr/strings.xml`	Folder-based locales

formatOptions

Type: object
Required: No Controls how different file formats are processed and generated.

{
  "formatOptions": {
    "json": {
      "nested": true
    },
    "xml": {
      "nested": false
    },
    "yaml": {
      "nested": true
    }
  }
}

Format-Specific Options:

JSON Options

nested (boolean): Use nested object structure vs flat keys

XML Options

nested (boolean): Use nested elements vs flat structure

YAML Options

nested (boolean): Use nested structure vs flat keys

Strings Options

None

customLocaleNames

Type: object Required: No Maps your company’s locale codes to the actual file or folder names in your project when they don’t match.

{
  "customLocaleNames": {
    "en-US": "english",
    "fr-FR": "french",
    "es-ES": "spanish",
    "zh-CN": "chinese-simplified"
  }
}

Use Cases:

Legacy naming conventions that can’t be changed
Simplified locale names (fr instead of fr-FR)
Descriptive filenames in existing projects
Platform-specific naming requirements (iOS: en.lproj)

How it works:

Company locale "fr-FR" maps to file/folder name "french"
Pattern src/{locale}.json resolves to src/french.json
Gleef treats this file as containing fr-FR translations

prependNamespaceToKeys

Type: boolean Required: No Default: false Automatically prepends the namespace/file name to translation keys when pushing to Gleef’s remote storage. This is useful when you have multiple namespace files per locale and want to keep keys unique across files remotely while maintaining simple keys locally.

{
  "prependNamespaceToKeys": true
}

How it works: When enabled, translation keys are transformed before being sent to Gleef: Local file structure:

locales/
  en/
    auth.json    → { "loginButton": "Log In" }
    common.json  → { "loginButton": "Sign In" }

Without prependNamespaceToKeys (default):

Both files have key loginButton
Conflict: Remote storage can’t distinguish between them

With prependNamespaceToKeys: true:

auth.json → Remote key: auth.loginButton
common.json → Remote key: common.loginButton
No conflict: Keys are unique remotely

Use Cases:

Projects with multiple namespace files per locale
Preventing key naming conflicts across different feature files
Maintaining simple local key names while having unique remote keys
Working with modular translation architectures

Important:

Keys are only transformed for remote storage - local files remain unchanged
When pulling translations, namespace prefixes are automatically stripped
Works seamlessly with the --namespace flag for filtering

Advanced Configuration Examples

Multi-Module Project

{
  "localeFilePatterns": [
    "apps/web/src/locales/{locale}.json",
    "apps/mobile/assets/i18n/{locale}.json", 
    "packages/shared/locales/{locale}/{feature}.json"
  ],
  "formatOptions": {
    "json": {
      "nested": true
    }
  }
}

Cross-Platform Project

{
  "localeFilePatterns": [
    "src/web/{locale}.json",
    "ios/MyApp/{locale}.lproj/Localizable.strings",
    "android/app/src/main/res/values-{locale}/strings.xml"
  ],
  "formatOptions": {
    "json": {
      "nested": true
    },
    "xml": {
      "nested": false
    }
  },
  "customLocaleNames": {
    "en-US": "en",
    "fr-FR": "fr",
    "es-ES": "es"
  }
}

Namespace-Organized Project

{
  "localeFilePatterns": [
    "i18n/{feature}.{locale}.yml",
    "locales/{locale}/{feature}.json"
  ],
  "formatOptions": {
    "json": {
      "nested": true
    },
    "yaml": {
      "nested": true
    }
  }
}

Namespace Project with Key Prepending

{
  "localeFilePatterns": [
    "locales/{locale}/{feature}.json"
  ],
  "formatOptions": {
    "json": {
      "nested": true
    }
  },
  "prependNamespaceToKeys": true
}

This configuration solves the duplicate key problem where loginButton appears in both auth.json and common.json. With prependNamespaceToKeys: true, they become unique remote keys: auth.loginButton and common.loginButton.

File Structure Examples

Nested JSON (Default)

Configuration:

{
  "formatOptions": {
    "json": {
      "nested": true
    }
  }
}

Output:

{
  "auth": {
    "login": {
      "title": "Sign In",
      "email": "Email Address",
      "password": "Password"
    }
  },
  "navigation": {
    "home": "Home",
    "about": "About"
  }
}

Flat JSON

Configuration:

{
  "formatOptions": {
    "json": {
      "nested": false
    }
  }
}

Output:

{
  "auth.login.title": "Sign In",
  "auth.login.email": "Email Address", 
  "auth.login.password": "Password",
  "navigation.home": "Home",
  "navigation.about": "About"
}

XML Structure

Configuration:

{
  "formatOptions": {
    "xml": {
      "nested": false
    }
  }
}

Output:

<?xml version="1.0" encoding="UTF-8"?>
<resources>
  <string name="auth_login_title">Sign In</string>
  <string name="auth_login_email">Email Address</string>
  <string name="navigation_home">Home</string>
</resources>

Configuration Validation

Common Validation Errors

Missing Locale Placeholder:

Error: No {locale} placeholder found in pattern: src/translations/*.json

No Files Matched:

Warning: Pattern 'locales/{locale}.json' matched no files. Check your file structure.

Invalid Pattern Syntax:

Error: File path structure doesn't match pattern: src/en/common.json vs src/{locale}.json

Locale Mapping Issues:

Warning: Some translations for locale 'fr' have been generated but not written locally.
Check your customLocaleNames configuration.

Troubleshooting

Configuration Issues

No files detected:

Check pattern syntax
Verify file paths are correct
Test patterns with file system tools

Wrong files included:

Add exclusion patterns
Make patterns more specific
Check for conflicting patterns

Format errors:

Validate JSON syntax
Check property names and values
Review format-specific options

Recovery

Reset configuration:

rm -rf .gleef/
gleef init

Gleef CLI

Configuration Location

Basic Configuration Structure

Configuration Properties

localeFilePatterns

formatOptions

JSON Options

XML Options

YAML Options

Strings Options

customLocaleNames

prependNamespaceToKeys

Advanced Configuration Examples

Multi-Module Project

Cross-Platform Project

Namespace-Organized Project

Namespace Project with Key Prepending

File Structure Examples

Nested JSON (Default)

Flat JSON

XML Structure

Configuration Validation

Common Validation Errors

Troubleshooting

Configuration Issues

Recovery

Next Steps

File Patterns

Format Options

Gleef CLI

​Configuration Location

​Basic Configuration Structure

​Configuration Properties

​localeFilePatterns

​formatOptions

​JSON Options

​XML Options

​YAML Options

​Strings Options

​customLocaleNames

​prependNamespaceToKeys

​Advanced Configuration Examples

​Multi-Module Project

​Cross-Platform Project

​Namespace-Organized Project

​Namespace Project with Key Prepending

​File Structure Examples

​Nested JSON (Default)

​Flat JSON

​XML Structure

​Configuration Validation

​Common Validation Errors

​Troubleshooting

​Configuration Issues

​Recovery

​Next Steps

File Patterns

Format Options

Configuration Location

Basic Configuration Structure

Configuration Properties

localeFilePatterns

formatOptions

JSON Options

XML Options

YAML Options

Strings Options

customLocaleNames

prependNamespaceToKeys

Advanced Configuration Examples

Multi-Module Project

Cross-Platform Project

Namespace-Organized Project

Namespace Project with Key Prepending

File Structure Examples

Nested JSON (Default)

Flat JSON

XML Structure

Configuration Validation

Common Validation Errors

Troubleshooting

Configuration Issues

Recovery

Next Steps