----- DEPRECATED -----

Use https://github.com/inlang/inlang/tree/main/source-code/plugins/json instead.

inlang-plugin-json

This plugin reads and writes resources that are stored as JSON. The following features are supported:

key-value pair ("key": "value")
nested key-value pairs ({ "key": { "nested-key": "value" } })

Usage

// filename: inlang.config.js

export async function defineConfig(env) {

  const { default: jsonPlugin } = await env.$import(
    "https://cdn.jsdelivr.net/gh/samuelstroschein/inlang-plugin-json@2/dist/index.js"
  );

  return {
    referenceLanguage: "en",
    plugins: [
      jsonPlugin({
        pathPattern: "./resources/{language}.json",
      })
    ]
  };
}

Take a look at the example inlang.config.js for the plugin config and usage.

PluginSettings

Our plugin offers further configuration options that can be passed as arguments. These options include pathPattern and variableReferencePattern (optional), and can be adjusted to suit your needs.

Here is the syntax for the PluginSettings object in TypeScript:

type PluginSettings = {
  pathPattern: string;
  variableReferencePattern?: [string, string];
};

`pathPattern`

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 {language} to specify the language name. Note that subfile structures are not supported.

Type definition

pathPattern: string;

Example

pathPattern: "./resources/{language}.json"

`variableReferencePattern`

This setting in our plugin allows you to specify the pattern for parsing placeholders for code variables in strings. To define the parsing pattern, add variableReferencePattern to the jsonPlugin in your inlang.config.js file.

The variableReferencePattern should be defined as a tuple that includes a prefix and a suffix pattern. These patterns create a dynamic regex under the hood to catch placeholders out of the string. If your pattern is something like this :name, you can provide only the prefix.

Here is the type definition for variableReferencePattern in TypeScript:

Type definition

 variableReferencePattern?: [string, string];

Example

jsonPlugin({
  pathPattern: "somePath",
  variableReferencePattern: ["{", "}"]
})

Common use cases

Placeholder	Pattern
`{placeholder}`	`["{", "}"]`
`{{placeholder}}`	`["{{", "}}"]`
`${placeholder}`	`["${", "}"]`
`%placeholder`	`["%"]`
`[placeholder]`	`["[", "]"]`
`:placeholder`	`[":"]`

Limitations

If a user creates a message with a nested id i.e. example.nested and example is also a message, the plugin will break.

Contributing

Getting started

Run the following commands in your terminal (node and npm must be installed):

npm install
npm run dev

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.

Publishing

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.

samuelstroschein / inlang-plugin-json