@erskingardner/inlang-plugin-json v2.0.2

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 plugin = await env.$import(
    "https://cdn.jsdelivr.net/gh/samuelstroschein/inlang-plugin-json@1/dist/index.js"
  );

  const pluginConfig = {
    pathPattern: "./{language}.json"
  };

  return {
    referenceLanguage: "en",
    languages: await plugin.getLanguages({
      ...env,
      pluginConfig
    }),
    readResources: (args) => plugin.readResources({ ...args, ...env, pluginConfig }),
    writeResources: (args) => plugin.writeResources({ ...args, ...env, pluginConfig })
  };
}

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

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):

1. npm install
2. 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.