svelte-django-gettext 0.0.1 → 1.0.0

package/.babelrc

@@ -0,0 +1,11 @@
+{
+    "presets": [
+      [
+        "@babel/preset-env",
+        {
+          "useBuiltIns": "entry",
+          "corejs": {"version": "3"}
+        }
+      ]
+    ]
+  }

package/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: CI
+on: [push]
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.4.0
+      - run: npm install
+      - run: npm run eslint
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.4.0
+      - run: npm install
+      - run: npm run test

package/README.md

@@ -20,7 +20,7 @@ export default {
         }),
         ...
 
-        writeGettextExtracts('js/_),
+        writeGettextExtracts('js/_svelte_django_extracted_messages.js'),
     ]
 }
 ```
@@ -37,8 +37,7 @@ import gettext from 'svelte-django-gettext';
 <h1>{gettext('hello')}</h1>
 ```
 
-
-Make sure the page loads the generated catalog, from a django template: `<script src="{% url 'javascript-catalog' %}"></script>`
+Make sure the page loads the generated catalog, from a django template: `<script src="{% url 'javascript-catalog' %}"></script>`. If this is not the case, all functions will just return their message id.
 
 # How it works:
 

package/build.js

@@ -21,7 +21,7 @@ export function writeGettextExtracts(extractsFile = '_svelte_django_extracted_me
     };
 }
 
-export async function gettextStringExtractor({ content, attributes, filename }) {
+export async function gettextStringExtractor({ content, filename }) {
     if (content.indexOf('gettext') === -1) {
         return;
     }

package/index.js

@@ -1,20 +1,33 @@
-export * from './build.js'
+export * from './build';
 
-
-function capfirst(s) {
-    return s.charAt(0).toUpperCase() + s.slice(1);
+/* Proxy to globally defined django.*gettext functions if it is available.
+ */
+function capfirst(str, condition) {
+    return condition ? (str.charAt(0).toUpperCase() + str.slice(1)) : str;
 }
 
 export function gettext(msgid, doCapfirst) {
     const django = window.django;
     const msgstr = django ? django.gettext(msgid) : msgid;
-    return doCapfirst ? capfirst(msgstr) : msgstr;
-};
+    return capfirst(msgstr, doCapfirst);
+}
 
 export function pgettext(context, msgid, doCapfirst) {
     const django = window.django;
     const msgstr = django ? django.pgettext(context, msgid) : msgid;
-    return doCapfirst ? capfirst(msgstr) : msgstr;
+    return capfirst(msgstr, doCapfirst);
+}
+
+export function ngettext(singular, plural, count, doCapfirst) {
+    const django = window.django;
+    const msgstr = django ? django.ngettext(singular, plural, count) : (count === 1 ? singular : plural);
+    return capfirst(msgstr, doCapfirst);
+}
+
+export function npgettext(context, singular, plural, count, doCapfirst) {
+    const django = window.django;
+    const msgstr = django ? django.npgettext(context, singular, plural, count) : (count === 1 ? singular : plural);
+    return capfirst(msgstr, doCapfirst);
 }
 
 export default gettext;

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "svelte-django-gettext",
-    "version": "0.0.1",
+    "version": "1.0.0",
     "description": "Use django gettext in Svelte",
     "main": "index.js",
     "type": "module",
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
+        "test": "jest test",
+        "eslint": "eslint -c package.json --fix *.js test/"
     },
     "keywords": [
         "Svelte",
@@ -14,5 +15,60 @@
         "i18n"
     ],
     "author": "Jan Pieter Waagmeester",
-    "license": "ISC"
-}
+    "license": "ISC",
+    "devDependencies": {
+        "@babel/preset-env": "^7.16.0",
+        "eslint": "^8.3.0",
+        "eslint-plugin-import": "^2.25.3",
+        "jest": "^27.3.1"
+    },
+    "jest": {
+        "testEnvironment": "jsdom"
+    },
+    "eslintConfig": {
+        "env": {
+            "browser": true,
+            "es2021": true
+        },
+        "extends": "eslint:recommended",
+        "parserOptions": {
+            "ecmaVersion": 13,
+            "sourceType": "module"
+        },
+        "plugins": [
+            "import"
+        ],
+        "rules": {
+            "indent": [
+                "error",
+                4,
+                {
+                    "SwitchCase": 1
+                }
+            ],
+            "quotes": [
+                "error",
+                "single"
+            ],
+            "import/order": [
+                "error",
+                {
+                    "groups": [
+                        "builtin",
+                        "external",
+                        "internal",
+                        [
+                            "parent",
+                            "sibling"
+                        ]
+                    ],
+                    "newlines-between": "always",
+                    "alphabetize": {
+                        "order": "asc",
+                        "caseInsensitive": true
+                    }
+                }
+            ]
+        }
+    }
+}

package/test/index.test.js

@@ -0,0 +1,65 @@
+/* globals describe, expect, test */
+import { gettext, ngettext, npgettext, pgettext } from '../index.js';
+
+
+describe('gettext', function() {
+    test('Is identity function if django is not defined', function() {
+        window.django = undefined;
+        expect(gettext('house')).toBe('house');
+        expect(gettext('house', true)).toBe('House');
+    });
+
+    test('Proxies to django.gettext', function() {
+        window.django = {
+            gettext: function() {
+                return 'huis';
+            }
+        };
+        expect(gettext('house')).toBe('huis');
+        expect(gettext('house', true)).toBe('Huis');
+    });
+});
+
+describe('ngettext', function() {
+    test('Is identity function if django is not defined', function() {
+        window.django = undefined;
+        expect(ngettext('house', 'houses', 1)).toBe('house');
+        expect(ngettext('house', 'houses', 2)).toBe('houses');
+        expect(ngettext('house', 'houses', 1, true)).toBe('House');
+        expect(ngettext('house', 'houses', 2, true)).toBe('Houses');
+    });
+    test('Proxies to django.ngettext', function() {
+        window.django = {
+            ngettext: function(singular, plural, count) {
+                return count == 1 ? 'huis' : 'huizen';
+            }
+        };
+        expect(ngettext('house', 'houses', 1)).toBe('huis');
+        expect(ngettext('house', 'houses', 2)).toBe('huizen');
+    });
+});
+
+describe('npgettext', function() {
+    test('Is identity function if django is not defined', function() {
+        window.django = undefined;
+        expect(npgettext('search results', '1 result', '%d results', 1)).toBe('1 result');
+    });
+});
+
+
+describe('pgettext', function() {
+    test('Is identity function if django is not defined', function() {
+        window.django = undefined;
+        expect(pgettext('date', 'may')).toBe('may');
+        expect(pgettext('date', 'may', true)).toBe('May');
+    });
+    test('Proxies to django.pgettext', function() {
+        window.django = {
+            pgettext: function() {
+                return 'mei'
+            }
+        };
+        expect(pgettext('date', 'may')).toBe('mei');
+        expect(pgettext('date', 'may', true)).toBe('Mei');
+    });
+});