svelte-django-gettext 1.0.0 → 1.0.2

package/README.md

@@ -5,9 +5,9 @@ Wrapper around django's JavaScript i18n features in Svelte.
 Django docs: [Using the JavaScript translation catalog](https://docs.djangoproject.com/en/stable/topics/i18n/translation/#using-the-javascript-translation-catalog)
 
 In your rollup configuration:
-```
+```JavaScript
 import svelte from 'rollup-plugin-svelte';
-import { writeGettextExtracts, gettextStringExtractor } from 'svelte-django-gettext';
+import { writeGettextExtracts, gettextStringExtractor } from 'svelte-django-gettext/build';
 
 export default {
     input: 'app.js',
@@ -18,13 +18,32 @@ export default {
                 markup: gettextStringExtractor
             }
         }),
-        ...
-
         writeGettextExtracts('js/_svelte_django_extracted_messages.js'),
     ]
 }
 ```
 
+Or with vite:
+
+```JavaScript
+import { defineConfig } from 'vite';
+import { svelte } from '@sveltejs/vite-plugin-svelte';
+
+import { gettextStringExtractor, writeGettextExtracts } from 'svelte-django-gettext/build';
+
+export default defineConfig({
+    base: '',
+    plugins: [
+        svelte({
+            preprocess: {
+                markup: gettextStringExtractor
+            },
+        }),
+        writeGettextExtracts('js/_svelte_django_extracted_messages.js'),
+    ],
+});
+```
+
 
 In your application:
 
@@ -37,11 +56,12 @@ 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>`. If this is not the case, all functions will just return their message id.
+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:
 
 Django's `./manage.py makemessages` cannot parse `.svelte` files to extract `gettext()` calls.
-A rollup plugin extracts all `gettext()` calls and outputs `_svelte_django_extracted_messages.js`, containh contains `gettext` calls extracted from your `.svelte` files.
+A preprocessor extracts `gettext()` calls and outputs `_svelte_django_extracted_messages.js`, which then contains `gettext` calls extracted from your `.svelte` files.
 
-This file should be added to `.gitignore`, but is readable by django's [`magemessages` management command](https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-makemessages).
+This file should be added to `.gitignore`, but Django's [`makemessages` management command](https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-makemessages) can read translations strings from it.

package/index.js

@@ -1,6 +1,4 @@
-export * from './build';
-
-/* Proxy to globally defined django.*gettext functions if it is available.
+/* Proxies to globally defined django.*gettext functions if it is available.
  */
 function capfirst(str, condition) {
     return condition ? (str.charAt(0).toUpperCase() + str.slice(1)) : str;

package/package.json

@@ -1,11 +1,13 @@
 {
     "name": "svelte-django-gettext",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Use django gettext in Svelte",
+    "author": "Jan Pieter Waagmeester",
+    "license": "ISC",
     "main": "index.js",
     "type": "module",
     "scripts": {
-        "test": "jest test",
+        "test": "vitest",
         "eslint": "eslint -c package.json --fix *.js test/"
     },
     "keywords": [
@@ -14,13 +16,15 @@
         "gettext",
         "i18n"
     ],
-    "author": "Jan Pieter Waagmeester",
-    "license": "ISC",
+    "exports": {
+        ".": "./index.js",
+        "./build": "./build.js"
+    },
     "devDependencies": {
-        "@babel/preset-env": "^7.16.0",
         "eslint": "^8.3.0",
         "eslint-plugin-import": "^2.25.3",
-        "jest": "^27.3.1"
+        "jsdom": "^23.2.0",
+        "vitest": "^1.2.1"
     },
     "jest": {
         "testEnvironment": "jsdom"

package/vite.config.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'jsdom',
+    }
+});

package/.babelrc

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

package/.github/workflows/ci.yml

@@ -1,15 +0,0 @@
-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/test/index.test.js

@@ -1,65 +0,0 @@
-/* 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');
-    });
-});