Summary

Introducing babel-plugin-django-gettext.

Review Request #10993 — Created April 8, 2020 and submitted April 11, 2020, 6:25 p.m.

Information

Owner

chipx86

Repository

babel-plugin-django-gettext

Branch

master

Bugs

Depends On

Commit

4d3926e...

Reviewers

Groups

beanbag-misc

People

Description

This is a plugin for Babel designed to make it easier to perform
localization in a Django-backed JavaScript codebase.

When working with localization, Django provides a handful of
gettext-compatible functions and a version of the current message
dictionary for the locale, which JavaScript can use to perform
on-the-fly translation of strings. While fantastic to have, it suffers
from a lot of noise, caused by long strings that can't easily be
word-wrapped and wordy interpolate() calls for format strings.

This plugin fixes all this by introducing the following:

Automatic whitespace condensing/trimming (by default -- callers can
also opt to preserve all whitespace by calling _raw() versions of
the functions).
Automatic interpolation for template literals that reference variables
or expressions, avoiding all the interpolate() calls.
Support for either calling gettext functions or using them as a
tagged template literal.
A _ alias that maps to gettext when used as a tagged template
literal (but not a function call, to avoid breaking usage of
underscore.js).
A N_ aliases that maps to ngettext.

These calls/template literals will be transpiled cleanly to code
compatible with the xgettext message scanner, resulting in cleaner
codebases, more readable strings, and fewer errors.

Testing Done

Unit tests passed.

Tested this with Djblets and Review Board, and verified the resulting
output.

Issues

Description	From	Last Updated
Col: 27 Missing semicolon.	reviewbot	April 8, 2020, 1:47 a.m.
Col: 21 Missing semicolon.	reviewbot	April 8, 2020, 1:48 a.m.
Col: 14 'transformTextNode' was used before it was defined.	reviewbot	April 8, 2020, 1:48 a.m.
Col: 14 'transformGettextCall' was used before it was defined.	reviewbot	April 8, 2020, 1:54 a.m.
Col: 14 'transformPGettextCall' was used before it was defined.	reviewbot	April 8, 2020, 1:54 a.m.
Col: 14 'transformNGettextCall' was used before it was defined.	reviewbot	April 8, 2020, 1:54 a.m.
Col: 14 'transformNPGettextCall' was used before it was defined.	reviewbot	April 8, 2020, 1:54 a.m.
Col: 14 'transformGettextTemplate' was used before it was defined.	reviewbot	April 8, 2020, 1:54 a.m.
Col: 2 Unnecessary semicolon.	reviewbot	April 8, 2020, 1:54 a.m.
Col: 11 'allGettextOptions' was used before it was defined.	reviewbot	April 8, 2020, 1:55 a.m.

flake8 passed.

JSHint failed.

JSHint

bin/build.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 27
 Missing semicolon.
```
bin/build.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 21
 Missing semicolon.
```
src/index.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 14
 'transformTextNode' was used before it was defined.
```
src/index.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 14
 'transformGettextCall' was used before it was defined.
```

src/index.js (Diff revision 1)

The issue has been resolved. Show all issues

Col: 14
 'transformPGettextCall' was used before it was defined.

src/index.js (Diff revision 1)

The issue has been resolved. Show all issues

Col: 14
 'transformNGettextCall' was used before it was defined.

src/index.js (Diff revision 1)

The issue has been resolved. Show all issues

Col: 14
 'transformNPGettextCall' was used before it was defined.

src/index.js (Diff revision 1)

The issue has been resolved. Show all issues

Col: 14
 'transformGettextTemplate' was used before it was defined.

test/tests.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 2
 Unnecessary semicolon.
```

Change Summary:


Fixed Review Bot warnings.
Fixed some bad documentation.
Added eslint as a development dependency.

Commit:

549c310da09a01a64c55c835ed6a77f55df6d0cf

4d3926e16c4a81476347da76396af853009c89ad

Diff:

Revision 2 (+1801)

Show changes

	.gitignore
	AUTHORS
	LICENSE
	README.md
	package.json
	bin/build.js
	bin/test.js
	src/index.js
	1 more

Checks run (1 failed, 1 succeeded)

flake8 passed.

JSHint failed.

JSHint

src/index.js (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 11
 'allGettextOptions' was used before it was defined.
```

Summary:: Introducing babel-plugin-django-gettet.
Introducing babel-plugin-django-gettext.

Ship it!

```
So cool.
```

Status:: Completed