Merge pull request #9 from slune-org/esm

ES module wrapper

.depcheckrc.yaml

@@ -0,0 +1,2 @@
+ignores:
+  - '@types/node'

.gitignore

@@ -1,11 +1,19 @@
+# Distributable
 node_modules/
 dist/
 
 # Coverage
 .nyc_output/
 coverage/
 
-# VS code
+# Package managers
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+pnpm-debug.log
+
+# IDE
+*.code-workspace
 .vscode/
 
 # Examples

.mocharc.yaml

@@ -0,0 +1,3 @@
+require:
+  - 'ts-node/register'
+  - 'source-map-support/register'

.nycrc.yaml

@@ -0,0 +1,10 @@
+extends: '@istanbuljs/nyc-config-typescript'
+include:
+  - 'src/**'
+exclude:
+  - '**/*.spec.ts'
+  - 'src/module.mjs'
+reporter:
+  - lcov
+  - text
+all: true

doc/api.md

@@ -4,7 +4,9 @@ This interface describes how objects containing messages for a given language sh
 
 It is advised not to use keys starting with `$` in messages, to prevent conflict with the `Intl` reserved keywords; but it is mandatory that, for each language, a `$` entry is provided with the name of language. Usually, the name of the language is specified in the language itself.
 
-Do not type your default language with `Message`, because if you do so, `typeof` will return `Message` and you will loose the specific type checking of your messages. Use the function `createMessages` to check the messages type.
+Each message can be either a string or a function returning a string. The `Messages` type also accepts `undefined`, but this is due to _TypeScript_ constraint and will throw an error if used.
+
+Do not type your default language with `Messages`, because if you do so, `typeof` will return `Messages` and you will loose the specific type checking of your messages. Use the function `createMessages` to check the messages type.
 
 # PartialMessages\<T extends Messages>
 

doc/fr/api.md

@@ -4,7 +4,9 @@ Cette interface décrit comment écrire les objets contenant les messages pour u
 
 Il est conseillé de ne pas utiliser de clé commençant par `$` dans les messages, afin d'éviter les conflits avec les mots-clés réservés de `Intl` ; mais il est nécessaire que, pour chaque langue, une entrée `$` soit fournie, avec le nom de la langue. En général, le nom de la langue est spécifiée dans la langue elle-même.
 
-Ne typez pas votre langue par défaut avec `Message`, car dans ce cas, `typeof` retournera `Message` et vous perdrez la vérification spécifique de vos messages. Utilisez la function `createMessages` pour vérifier le type des messages.
+Chaque message peut être une chaine de caractères ou une fonction renvoyant une chaine de caractères. Le type `Messages` accepte également des valeurs `undefined`, mais ceci est lié à une contrainte de _TypeScript_ et provoquera une erreur si utilisé.
+
+Ne typez pas votre langue par défaut avec `Messages`, car dans ce cas, `typeof` retournera `Messages` et vous perdrez la vérification spécifique de vos messages. Utilisez la fonction `createMessages` pour vérifier le type des messages.
 
 # PartialMessages\<T extends Messages>