You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/plugins/i18next/README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,9 @@
1
+
---
2
+
title: i18next Plugin for Inlang - Translation Management
3
+
description: Connect your i18next JSON translation files to your inlang project. Use Fink for translation management, Sherlock for inline previews, and CLI for linting.
This plugin enables your inlang project to read and write [i18next](https://inlang.com/m/kl95463j) translation files.
@@ -258,7 +264,3 @@ Run the following commands in your terminal (node and npm must be installed):
258
264
2. `npmrundev`
259
265
260
266
`npmrundev` will start the development environment which automatically compiles the [src/index.ts](#getting-started) files to JavaScript ([dist/index.js](#getting-started)), runs tests defined in `*.test.ts` files and watches changes.
261
-
262
-
---
263
-
264
-
_Is something unclear or do you have questions? Reach out to us in our [Discord channel](https://discord.gg/gdMPPWy57R) or open a [Discussion](https://github.com/opral/inlang/discussions) or an [Issue](https://github.com/opral/inlang/issues) on [Github](https://github.com/opral/inlang)._
Copy file name to clipboardExpand all lines: packages/plugins/json/README.md
+4-26Lines changed: 4 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,12 @@
1
-
# What does this plugin do?
1
+
# JSON Plugin for Inlang
2
+
3
+
> **Deprecated:** This plugin is deprecated in favor of the [inlang message format plugin](https://inlang.com/m/reootnfj/plugin-inlang-messageFormat), which provides a simpler, more robust solution.
2
4
3
5
This plugin is a general purpose plugin to read and write messages of json files.
4
6
5
7
> The plugin uses the inlang SDK v1 API but can be used in V2 projects.
6
8
>
7
-
> A slight difference is that `languageTag` is called `locale` in v2 projects. Use `languageTag` for this plugin.
9
+
> A slight difference is that `languageTag` is called `locale` in v2 projects. Use `languageTag` for this plugin.
8
10
9
11
## Manual Installation
10
12
@@ -121,18 +123,6 @@ An array of strings that are used to ignore certain files. The strings are match
121
123
122
124
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.
123
125
124
-
# Supercharge your i18n workflow by installing the Inlang Visual Studio Code extension (Sherlock)
125
-
126
-
The plugin can be used with [Sherlock - VS Code extension](https://inlang.com/m/r7kp499g/app-inlang-ideExtension) to extract keys from your code, display inline annotations, have quality checks with [lint rules](https://inlang.com/c/lint-rules) & more. There are only 2 steps to get started:
@@ -143,15 +133,3 @@ Run the following commands in your terminal (node and npm must be installed):
143
133
2. `npmrundev`
144
134
145
135
`npmrundev` will start the development environment which automatically compiles the [src/index.ts](#getting-started) files to JavaScript ([dist/index.js](#getting-started)), runs tests defined in `*.test.ts` files and watches changes.
146
-
147
-
## Publishing
148
-
149
-
Run `npmrunbuild` to generate a build.
150
-
151
-
The [dist](./dist/) directory is used to distribute the plugin directly via CDN like [jsDelivr](https://www.jsdelivr.com/). Using a CDN works because the inlang config uses dynamic imports to import plugins.
152
-
153
-
Read the [jsDelivr documentation](https://www.jsdelivr.com/?docs=gh) on importing from GitHub.
154
-
155
-
---
156
-
157
-
_Is something unclear or do you have questions? Reach out to us in our [Discord channel](https://discord.gg/gdMPPWy57R) or open a [Discussion](https://github.com/opral/inlang/discussions) or an [Issue](https://github.com/opral/inlang/issues) on [Github](https://github.com/opral/inlang)._
This plugin provides the integration for [Paraglide JS](https://inlang.com/m/gerre34r/library-inlang-paraglideJs)` into the inlang Visual Studio Code extension (Sherlock). It allows you to extract messages from your code, view them inline in the text editor, and get lints for your messages.
7
+
# m Function Matcher for Sherlock
4
8
5
-
Match examples:
6
-
```ts
7
-
m.myMessage()
8
-
```
9
-
```ts
10
-
m.another_message()
11
-
```
9
+
This plugin enables [Sherlock](https://inlang.com/m/r7kp499g/app-inlang-ideExtension) (VS Code extension) to recognize `m.message()` function calls used by [Paraglide JS](https://inlang.com/m/gerre34r/library-inlang-paraglideJs).
The plugin will automatically extract messages from your code and show them inline in the editor. You can then click on the message to open the web editor and translate the message.
15
+
-**Inline previews**: See translations directly in your code editor
16
+
-**Message extraction**: Extract hardcoded strings into messages
17
+
-**Linting**: Get warnings for missing or invalid message references
17
18
18
-
1. Install the [Visual Studio Code extension (Sherlock)](https://inlang.com/m/r7kp499g)
19
-
2. Install this plugin
20
-
3. ✨ See your messages appear inline in the editor
19
+
## Supported file types
21
20
22
-
> There might be a delay before the messages appear in the editor. This is because the plugin needs to be downloaded first. If you want to make sure that everything is setup correctly, reload your workspace.
21
+
- TypeScript (`.ts`, `.tsx`)
22
+
- JavaScript (`.js`, `.jsx`)
23
+
- Svelte (`.svelte`)
24
+
- Vue (`.vue`)
25
+
- Astro (`.astro`)
23
26
24
-
### Manual installation
27
+
##Installation
25
28
26
-
```diff
27
-
// project.inlang/settings.json
29
+
Add the plugin to your `project.inlang/settings.json`:
0 commit comments