Merge pull request #9 from Epithumia/v2

v2.0.0

Author: Epithumia

.gitignore

@@ -3,7 +3,7 @@
 /mkdocs_sqlite_console.egg-info/
 /venv/
 /build/
-
+**/.vscode
 **/__pycache__/
 
 .DS_Store

docs/notes-de-version.md

@@ -54,3 +54,7 @@
 
 - Correction d'un oubli dans pyproject.toml (dépendance manquante pour faire la documentation locale)
 - Correction de typos.
+
+### 2.0.0
+
+- Support pour utilisation en tant que macro {{ sqlide(...) }}

docs/usage.md

@@ -3,29 +3,51 @@
 ## Activer le plugin
 
 Ajouter dans votre fichier `mkdocs.yml`:
+
 ```yaml
 plugins:
   - search
   - sqlite-console
 ```
 
-!!! note 
-    Si vous n'avez aucune entrée dans la section `plugins` de votre fichier de configuration, 
-    vous voudrez sans doute ajouter le plugin `search`. MkDocs l'active par défaut s'il n'y a pas 
+!!! note
+    Si vous n'avez aucune entrée dans la section `plugins` de votre fichier de configuration,
+    vous voudrez sans doute ajouter le plugin `search`. MkDocs l'active par défaut s'il n'y a pas
     d'autres `plugins`, et dans le cas contraire, MkDocs demande de l'activer explicitement.
 
+!!! note "Utilisation avec `mkdocs-macros-plugin` ou Pyodide-MkDocs-Theme"
+
+    Noter que le plugin `mkdocs-sqlite-console` doit toujours être référencé après les plugins de PMT ou des macros, dans le fichier `mkdocs.yml` :<!-- markdownlint-disable-line MD046 -->
+
+    ```yaml
+    plugins:
+        - search
+        - macros            # avec mkdocs-macros-plugin
+        - sqlite-console
+    ```
+
+    ```yaml
+    plugins:
+        - search
+        - pyodide_macros    # avec PMT
+        - sqlite-console
+    ```
+
 Si vous voulez déployer votre site (à l'aide de `mkdocs build` ou `mkdocs gh-deploy`), il faut également ajouter à votre
 fichier `mkdocs.yml` une ligne du type
+
 ```yaml
 site_url: https://monsite.url/chemin
 ```
+
 Par exemple, ce site est configuré avec
+
 ```yaml
 site_url: https://epithumia.github.io/mkdocs-sqlite-console
 ```
 
 !!! error "site_url"
-    Si vous n'avez pas défini la variable `site_url` dans votre fichier `mkdocs.yml`, les commandes 
+    Si vous n'avez pas défini la variable `site_url` dans votre fichier `mkdocs.yml`, les commandes
     `mkdocs build` et `mkdocs gh-deploy` ne fonctionneront pas et signaleront la nécessité de le faire.
 
 ## Afficher la console/IDE
@@ -46,13 +68,16 @@ On peut afficher une console/IDE SQLite grâce à la commande `{{ sqlide paramè
     - le titre *doit* être entre guillemets
     - les chemins vers les fichiers sont relatifs à la racine du site
     - les chemins ne peuvent pas contenir d'espace
-    - les options base et init sont mutuellement exclusives ; l'option base est prioritaire. 
+    - les options base et init sont mutuellement exclusives ; l'option base est prioritaire.
+
+    Voir le cas des [utilisations en tant que macro](#as-macros), où les syntaxes diffèrent légèrement.<!-- markdownlint-disable-line MD046 -->
 
 ### Quelques exemples
 
 #### Affichage basique
 
 Pour afficher un IDE avec du code SQL d'initialisation et du code pré-saisi :
+
 ```markdown
 {{ sqlide titre="IDE avec initialisation et code pré-saisi" init="sql/init1.sql" sql="sql/code.sql" }}
 ```
@@ -77,7 +102,7 @@ Si l'on ne veut que le résultat de la requête sans pour autant afficher l'IDE,
 {{sqlide titre="IDE avec une base binaire chargée et code pré-saisi autoexécuté, IDE caché" base="bases/test.db" sql="sql/code.sql" autoexec hide}}
 ```
 
-{{sqlide titre="IDE avec une base binaire chargée et code pré-saisi autoexécuté, IDE caché" base="bases/test.db" sql="sql/code.sql" autoexec hide}}
+{{sqlide(titre="IDE avec une base binaire chargée et code pré-saisi autoexécuté, IDE caché" base="bases/test.db" sql="sql/code.sql" autoexec hide)}}
 
 !!! warning "Titre"
     Attention, le titre n'est plus affiché dans ce cas.
@@ -114,12 +139,12 @@ donne :
 ???+ sql "Bloc accordéon avec initialisation et code pré-saisi"
     {{ sqlide titre="Init + Code" init="sql/init1.sql" sql="sql/code.sql" }}
 ```
-donne
+
+donne :
 
 ???+ sql "Bloc accordéon avec initialisation et code pré-saisi"
     {{ sqlide titre="Init + Code" init="sql/init1.sql" sql="sql/code.sql" }}
 
-
 !!! bug
     Les blocs ne s'affichent pas correctement dans les admonitions qui sont repliées par défaut :
     ```markdown
@@ -130,20 +155,74 @@ donne
     ??? sql "Bloc admonition avec initialisation et code pré-saisi"
         {{ sqlide titre="Init + Code" init="sql/init1.sql" sql="sql/code.sql" }}
 
-### Usage avec le plugin [macros](https://mkdocs-macros-plugin.readthedocs.io/en/latest/)
+## Usage avec le plugin [macros](https://mkdocs-macros-plugin.readthedocs.io/en/latest/) ou [Pyodide-MkDocs-Theme](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/) { #as-macros }
+
+`mkdocs-sqlite-console` est compatible avec l'utilisation du plugin `mkdocs-macros`, ainsi que le thème Pyodide-MkDocs-Theme.
+
+Si l'un des deux est utilisé (avec une manipulation de configuration à faire pour le plugin des macros seul), il est alors possible de déclarer un `sqlide` via un appel de macro :
 
-Le plugin macros utilise les doubles accolades pour définir ses propres blocs de code, ce qui empêche ce plugin de 
-fonctionner normalement. En conséquence, quand le plugin macros est détecté, la syntaxe change et l'IDE SQLite est
-chargée avec la syntaxe suivante :
 ```markdown
-{!{ sqlide paramètres }!}
+{{ sqlide(titre="Init + Code", init="sql/init1.sql", sql="sql/code.sql") }}
 ```
-Par exemple `{!{ sqlide titre="IDE avec initialisation et code pré-saisi" init="sql/init1.sql" sql="sql/code.sql" }!}`
-affichera :
 
-{{ sqlide titre="IDE avec initialisation et code pré-saisi" init="sql/init1.sql" sql="sql/code.sql" }}
+### Syntaxes
+
+Par rapport à l'utilisation normale du plugin, il faut :
+
+- Ajouter les parenthèses autour des arguments,
+- Ajouter des virgules entre les arguments,
+- Les guillemets autour des valeurs des arguments sont alors indispensables.
+
+??? tip "Anciennes syntaxes - versions 1.0.7 et antérieures"
+
+    _Ceci décrit les anciens comportements pour utiliser `mkdocs-sqlite-console` avec le plugin des macros ou PMT activés.<!-- markdownlint-disable-line MD046 -->
+    Ces méthodes restent utilisables._
+    { style="color:#FFAA00" }
+
+    Le plugin `macros` utilise les doubles accolades pour définir ses propres blocs de code, ce qui empêche ce plugin de
+    fonctionner normalement. En conséquence, quand le plugin macros est détecté, la syntaxe change et l'IDE SQLite est
+    chargée avec la syntaxe suivante :
+
+    ```markdown
+    {!{ sqlide paramètres }!}
+    ```
+
+    Par exemple, l'appel :
+
+    ```markdown
+    {{ sqlide titre="..." init="sql/init1.sql" sql="sql/code.sql" }}
+    ```
+
+    ...devait alors s'écrire :
+
+    `{!{ sqlide titre="..." init="sql/init1.sql" sql="sql/code.sql" }!}`
+
+### Activation
+
+#### Pyodide-MkDocs-Theme
+
+Le thème gère tout automatiquement, à partir de sa version 4.4.6.
+
+Les versions antérieures nécessitent d'utiliser les anciennes syntaxes de déclaration des `sqlide`.
+
+#### `mkdocs-macros-plugin`
+
+Dans le cas d'utilisation du plugin des macros seul, il est nécessaire d'enregistrer la macro depuis votre fichier/module de macros personnalisées.
+Par défaut, il s'agit du fichier `main.py` :
+
+```python
+
+def define_env(env):
+
+    # Vos macros personnalisées ici:
+    ...
+
+    # Enregistrement de la macro sqlide:
+    sql_plugin = env._conf.plugins['sqlite-console']
+    env.macro(sql_plugin.sqlide)
+```
 
-### Erreurs
+## Erreurs
 
 Le plugin détectera les fichiers non existants :
 

main.py

@@ -0,0 +1,10 @@
+"""
+Logistique pour tester en local avec l'utilisation de mkdocs-macros-plugin.
+
+Nécessite d'installer le plugin dans le venv et d'ajouter le plugin macros
+dans mkdocs.yml:plugins.
+"""
+
+def define_env(env):
+    sql_plugin = env._conf.plugins['sqlite-console']
+    env.macro(sql_plugin.sqlide)

mkdocs.yml

@@ -11,8 +11,8 @@ theme:
 
 nav:
     - Home: 'index.md'
-    - 'Guide d''utilisation': 'usage.md'
-    - A propos:
+    - Guide d'utilisation: 'usage.md'
+    - À propos:
         - 'License': 'licence.md'
         - 'Historique des versions': 'notes-de-version.md'
 
@@ -22,9 +22,11 @@ edit_uri: edit/main/docs/
 
 plugins:
   - search
+  # - macros          # Activer pour tester en local (Nota: à placer avant sqlite-console)
   - sqlite-console
 
 markdown_extensions:
   - admonition
   - pymdownx.details
   - pymdownx.superfences
+  - attr_list

mkdocs_sqlite_console/__init__.py

@@ -1,3 +1,3 @@
 from .plugin import SQLiteConsole
 
-VERSION = "1.0.7"
+VERSION = "2.0.0"

mkdocs_sqlite_console/js/sql-wasm.wasm

@@ -1,6 +1,6 @@
 // noinspection SqlNoDataSourceInspection
 
-function load(ide, base = '', init = '', run='', espace='') {
+function load(ide, base = '', init = '', run = '', espace = '') {
     var execBtn = ide.querySelector("button.execute");
     var outputElm = ide.querySelector('pre.sqloutput');
     var errorElm = ide.querySelector('div.sqlerror');
@@ -10,7 +10,7 @@ function load(ide, base = '', init = '', run='', espace='') {
     var worker = espace;
     var neww;
     if (espace === '') {
-        worker = new Worker(path + "/js/worker.sql-wasm.js");
+        worker = new Worker(sqljs_base_path + "/js/worker.sql-wasm.js");
         worker.onerror = error;
         neww = true;
     } else {
@@ -22,24 +22,24 @@ function load(ide, base = '', init = '', run='', espace='') {
         }
 
     }
-// Open a database
-    if (neww) worker.postMessage({action: 'open'});
+    // Open a database
+    if (neww) worker.postMessage({ action: 'open' });
     if (base !== '/') {
         const u = new URL(base)
         fetch(u).then(res => {
             return res.arrayBuffer()
         }).then(buf => {
             try {
-                worker.postMessage({action: 'open', buffer: buf}, [buf]);
+                worker.postMessage({ action: 'open', buffer: buf }, [buf]);
             } catch (exception) {
-                worker.postMessage({action: 'open', buffer: buf});
+                worker.postMessage({ action: 'open', buffer: buf });
             }
-            if (run !== '') {execute(run, false);}
+            if (run !== '') { execute(run, false); }
         });
     }
     else if (init !== '') {
         execute(init, true);
-        if (run !=='') execute(run, false);
+        if (run !== '') execute(run, false);
     }
 
     function error(e) {
@@ -53,14 +53,14 @@ function load(ide, base = '', init = '', run='', espace='') {
         errorElm.textContent = ''
     }
 
-// Run a command in the database
+    // Run a command in the database
     function execute(commands, silent = false) {
         tic();
         worker.onmessage = function (event) {
             var results = event.data.results;
             toc("Executing SQL");
             if (!results) {
-                error({message: event.data.error});
+                error({ message: event.data.error });
                 return;
             }
 
@@ -72,11 +72,11 @@ function load(ide, base = '', init = '', run='', espace='') {
             if (outputElm.childElementCount === 0 && !silent) outputElm.innerHTML = "<p>Requête exécutée correctement, pas de résultat à afficher.</p>";
             toc("Displaying results");
         }
-        worker.postMessage({action: 'exec', sql: commands});
+        worker.postMessage({ action: 'exec', sql: commands });
         outputElm.textContent = "Fetching results...";
     }
 
-// Create an HTML table
+    // Create an HTML table
     var tableCreate = function () {
         function valconcat(vals, tagName) {
             if (vals.length === 0) return '';
@@ -97,18 +97,18 @@ function load(ide, base = '', init = '', run='', espace='') {
         }
     }();
 
-// Execute the commands when the button is clicked
+    // Execute the commands when the button is clicked
     function execEditorContents() {
         noerror()
         execute(editor.getValue() + ';');
     }
 
     execBtn.addEventListener("click", execEditorContents, true);
 
-// Performance measurement functions
+    // Performance measurement functions
     var tictime;
     if (!window.performance || !performance.now) {
-        window.performance = {now: Date.now}
+        window.performance = { now: Date.now }
     }
 
     function tic() {
@@ -120,7 +120,7 @@ function load(ide, base = '', init = '', run='', espace='') {
         console.log((msg || 'toc') + ": " + dt + "ms");
     }
 
-// Add syntax highlihjting to the textarea
+    // Add syntax highlihjting to the textarea
     var editor = CodeMirror.fromTextArea(commandsElm, {
         mode: 'text/x-mysql',
         viewportMargin: Infinity,