• Issue Type: Performance
• Extension Name: arb-editor
• Extension Version: 0.0.8
• OS Version: Linux x64 5.17.5-76051705-generic
• VS Code version: 1.79.0

The extension becomes unresponsive went I add a placeholder with plural or select in an arb file and completely freeze till i close and reopen the vs code window.

Google.arb-editor-unresponsive.cpuprofile.txt

There should be an option to:

1. Create a new blank arb file, with some basic structure which only needs to be filled in;
2. Create an arb based on an existing file, choosing a locale, and copying all keys with empty messages to allow translators to add a new translation.

Expected Behavior

I would like to request the addition of a feature that allows developers to ignore 'specific linter rules' during arb analysis like "placeholder".

Actual Behavior

Currently, there is no way to ignore rules like 'Placeholder X not defined in the message metadata'. My 'template-arb-file' is set to my EN file and I should not need to duplicate my placeholder.

Specifications

• Version of the linter or code analysis tool: v0.0.11
• Platform: macOS

We should likely have a CI for this repo (linting the typescript code, running tests, ...).

Expected Behavior

Escaping syntax as described in the docs should be supported.

• Verbatim contexts within ' should not give error.
• ' character, represented as '' within a verbatim context should be allowed.

Steps to Reproduce the Problem

{
  "helloWorld": "Hello! '{Isn''t}' this a wonderful day?"
}

Gives: Error: Unbalanced right delimiter found in string

Or:

{
  "helloWorld": "Hello!' {Isn''t}' this a wonderful day?"
}

Gives "{Isn''t}" is not a valid placeholder name.

I am wondering what this repo is about and whether or not overlaps with my project https://github.com/inlang/inlang exists. A vs code extension is in the works as well.

Can someone enlighten me?

The Github action runs seem to be flaky, either failing or taking a long time. This should be investigated.

To ease translation, it would be nice to show the descriptions (and maybe the message string?) from the reference arb file as a decoration on the corresponding keys in other arb files in the same folder.

Add a nice icon and some text/screenshot GIFs/examples.

Expected Behavior

When using a template and the message translation is present in the file, there should be no warnings that the message is not provided.

Actual Behavior

A warning is issued about a missing template.

Steps to Reproduce the Problem

1. Create files below
2. Observe the error

en.arb

{
    "@@locale": "en",
    "hello": "Hello",
    "@hello": {
        "description": "Say hello"
    }
}

en_UK.arb

{
    "@@locale": "en_UK",
    "@@x-template": "en.arb",
    "hello": "Hello"
}

There is a warning at en_UK.arb that translation for hello isn't provided even though it is.

Specifications

• Version: 0.0.12
• Platform: macOS, 14.3.1

Some errors might have quick-fixes associated to them, for example if a placeholder is not declared in the metadata. It would be nice to include such quick-fixes.

We may want to add a url link in the 'about' section of the github repo's UI; perhaps https://marketplace.visualstudio.com/items?itemName=Google.arb-editor?

@mosuem I had a quick scan through the code and had some feedback:

1. Snippets are defined against the JSON language, so they show up for all JSON files (inc. non-ARB).
   I don't think there's an easy way to define a new language (ARB) in VS Code and have it inherit the functionality from another language. It would be nice to define "ARB" but inherit everything from "JSON" and then use ARB to target snippets etc., however you can supply snippets via a completion provider which would allow you to check the file extension before providing them. I did something similar in Dart-Code so we could conditionally include Flutter snippets only if the current project is a Flutter project (see Dart-Code/Dart-Code#350).
2. I was a little surprised that the extension modified my user settings file (to add an association) without any prompt or action (I cam to add something and saw an unfamiliar entry at the end of the file). I think it could be done instead by using contributes/configurationDefaults in package.json to avoid modifying the settings (example of similar in Dart-Code).
3. It probably doesn't matter too much for such a small extension, but currently in activationEvents is onStartupFinished which means the extension always activates. Generally it's better to only activate when it's certain the user needs the extension (for example onLanguage, or onCommand).. although, since we can't create an ARB language (without losing basic JSON support), onLanguage:json might be the best you can do.
4. Repository/bugs field in package.json point to https://github.com/mosum/arb-editor (I presume these should be google, but if not, is the username still a typo?)
5. I noticed in #1 you're using jsonc-parser.. Is the intention to support comments in these files? (I ask because VS Code has a separate "JSON with comments" language, but I'm not sure if it's safe to have comments here if other tools might be reading the files that might not accept them).
   FWIW, I noticed the visitor in that parser is already providing offsets which deals with one thing discussed earlier.

We currently only do a very rough validation of messages; it would be preferable to have the messages checked according to the ICU MessageFormat specs.

Recent commit #40 changes default behaviour of ARB string parser to no longer accept

"zzTestString":"Testing a string's apostrophe capability",

The above test string fail with Error: Unbalanced escape quotes. To escape a single quote ', prefix it with another single quote. however, adding a two-quote like "zzTestStringDouble":"Testing a string''s apostrophe capability", generates incorrect Dart string if a single-apostrophe is desired as flutters gen-l10n setting use-escape defaults to false. With a use-escape: false there now is no way to have arb-editor plugin accept the above zzTestString. The gen-l10n tool works fine and outputs correct single-apostrophe string for the zzTestString string.

To fix this, I have a few options:

• Add use-escaping: true setting and two-quote everywhere in my ARB file
• Switch all strings to begin with single-quote, then escape apostrophe where found.

Neither is ideal imho. I believe out-of-box should not mark this test string as erroneous.

Expected Behavior

Have a way for a user to define specific errors/warnings/infos that they want to ignore and not show in the Problems section of vscode. May be via a plugin setting to list IDs of the messages user wants to disable, for example:

{
...
"arbeditor.supressedWarnings": [3, 7] // Disable no metadata for key and placeholder metadata errors
}

Actual Behavior

There is no way for a user to ignore a specific warning that the plugin generates while it validates the ARB file. For example, not defining metadata for key/placeholder.

Specifications

• Version: 0.0.12
• Platform: macOS