This plugin is a general purpose plugin to read and write messages of json files.
npm install @inlang/plugin-jsonThis plugin is a general purpose plugin to read and write messages of json files.
> We recommend using the install button, but if you want to do it manually:
- Add this to the modules in your project.inlang/settings.json
- Change the sourceLanguageTag if needed
- Include existing languagetags in the languageTags array
``json`
{
"sourceLanguageTag": "en",
"languageTags": ["en", "de"],
"modules": ["https://cdn.jsdelivr.net/npm/@inlang/plugin-json@latest/dist/index.js"],
"plugin.inlang.json": {
"pathPattern": "./resources/{languageTag}.json"
}
}
_messages/en.json_
`json`
{
"hello": "Hello {name}!",
"loginButton": "Login"
}
_messages/de.json_
`json`
{
"hello": "Hallo {name}!",
"loginButton": "Anmelden"
}
The plugin offers further configuration options that can be passed as arguments. The following settings exist:
Here is the syntax for the PluginSettings object in TypeScript:
`typescript`
type PluginSettings = {
pathPattern: string | { [key: string]: string }
variableReferencePattern?: [string] | [string, string]
ignore?: string[]
}
To use our plugin, you need to provide a path to the directory where your language-specific files are stored. Use the dynamic path syntax {languageTag} to specify the language name.
`json`
"plugin.inlang.json": {
"pathPattern": "./resources/{languageTag}.json"
}
> Does not get created by 'npx @inlang/cli config init'
`json`
"plugin.inlang.json": {
"pathPattern": {
"website": "./resources/{languageTag}/website.json",
"app": "./resources/{languageTag}/app.json"
}
}
Defines the pattern for variable references. The default is how i18next suggests the usage of placeholders.
default:
`json`
"plugin.inlang.json": {
"variableReferencePattern": ["{", "}"]
}
Common use cases
| Placeholder | Pattern |
| ----------------- | -------------- |
| {placeholder} | ["{", "}"] |{{placeholder}}
| | ["{{", "}}"] |${placeholder}
| | ["${", "}"] |%placeholder
| | ["%"] |[placeholder]
| | ["[", "]"] |:placeholder
| | [":"] |
An array of strings that are used to ignore certain files. The strings are matched against the file path. If the file path contains the string, the file is ignored.
`json`
"plugin.inlang.json": {
"ignore": ["node_modules", "dist"]
}
The message IDs are sorted in the order in which they appear in the sourceLanguage file. The nesting or flattening of IDs is detected on a file-by-file basis. If the sourceLanguage file contains nested IDs, the plugin will also create nested IDs in the targetLanguage files. If the sourceLanguage file contains flattened IDs, the plugin will also create flattened IDs in the targetLanguage files.
The plugin can be used with Sherlock - VS Code extension to extract keys from your code, display inline annotations, have quality checks with lint rules & more. There are only 2 steps to get started:
1. Install: VS Code Marketplace.
2. Add the correct syntax matcher:
- m function matcher or
- t function matcher
3. Optional: Add lint rules: https://inlang.com/c/lint-rules
4. 🎉 Done!
Run the following commands in your terminal (node and npm must be installed):
1. npm install
2.
npm run dev will start the development environment which automatically compiles the src/index.ts files to JavaScript (dist/index.js), runs tests defined in *.test.ts files and watches changes.
Run npm run build` to generate a build.
The dist directory is used to distribute the plugin directly via CDN like jsDelivr. Using a CDN works because the inlang config uses dynamic imports to import plugins.
Read the jsDelivr documentation on importing from GitHub.
---
_Is something unclear or do you have questions? Reach out to us in our Discord channel or open a Discussion or an Issue on Github._