1.3.0 • Published 5 months ago

@instructure/i18nliner-canvas v1.3.0

Weekly downloads
-
License
AGPL-3.0
Repository
-
Last release
5 months ago

canvas_i18nliner

i18nliner, canvas style

this will replace the i18n_tasks and i18n_extraction gems

.i18nrc files must glob for files to be included through the files property:

{
  "files": [
    {
      "pattern": "**/*.js",
      "processor": "js"
    },
    {
      "pattern": "**/*.{hbs,handlebars}",
      "processor": "hbs"
    }
  ]
}

.i18nrc files can include other directories that may in turn specify more files through their .i18nrc configuration file:

{
  "include": [ "relative/path/to/dir" ]
}

.i18nignore files can exclude files from processing relative to where they are defined (similar to .gitignore):

// file: app/.i18nignore
foo
bar/**/*.js

The above ignore file will exclude app/foo and app/bar/**/*.js.

Where to place ignore lists?

The scanner will always look for an .i18nignore adjacent to .i18nrc, but it will also discover and use any .i18nignore file found between the root and the target file:

app
├── .i18nignore
└── a
    ├── .i18nignore
    └── b
        └── c

A file under app/a/b/c/ is subject to exclusion according to rules found in both app/.i18nignore and app/a/.i18nignore.

Handlebars

Allowed forms:

<!-- inferred keys -->
{{t "Hello"}}
{{#t}}
  Hello
{{/t}}

<!-- explicit keys -->
{{t "hello" "Hello"}}
{{#t "hello"}}
  Hello
{{/t}}

<!-- explicit, external scope key -->
{{#t "#external.hello"}}
  Hello
{{/t}}