Add 'check' command for deno and for python

Author: zph

poetry.lock

@@ -27,6 +27,7 @@ pre-commit = "^3.6.0"
 python-ulid = "^2.2.0"
 slack-sdk = "^3.26.2"
 jupyterlab = "^4.1.5"
+nbdime = "^4.0.1"
 
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -2,7 +2,7 @@
 
 import click
 
-from runbook.cli.commands import create, edit, export, convert, init, plan, review, run, version
+from runbook.cli.commands import create, edit, export, convert, check, init, plan, review, run, version
 
 # TODO: not working, needs a custom underlying class to handle the auto-env
 CONTEXT_SETTINGS = dict(auto_envvar_prefix="RUNBOOK")
@@ -28,6 +28,7 @@ def cli(ctx, cwd):
 cli.add_command(edit)
 cli.add_command(create)
 cli.add_command(convert)
+cli.add_command(check)
 cli.add_command(run)
 cli.add_command(review)
 cli.add_command(version)

runbook/cli/__init__.py

@@ -6,3 +6,4 @@
 from runbook.cli.commands.run import run
 from runbook.cli.commands.version import version
 from runbook.cli.commands.convert import convert
+from runbook.cli.commands.check import check

runbook/cli/commands/__init__.py

@@ -0,0 +1,47 @@
+# metadata.kernelspec.name = deno || python3
+
+from os import path
+
+import click
+import json
+
+from runbook.cli.completions import EditableNotebook
+from runbook.cli.validators import validate_runbook_file_path
+
+@click.command()
+@click.argument(
+    "filename",
+    type=EditableNotebook(file_okay=True),
+    callback=validate_runbook_file_path,
+)
+
+@click.option(
+    "-c",
+    "--command",
+    default=None,
+    help="Run a notebook through this custom command, ie 'deno check {}' where the {} is the temporary filename.",
+)
+@click.pass_context
+def check(ctx, filename, command):
+    """Check language validity and formatting of a notebook."""
+    # jupytext --check 'deno check {}' notebook.ipynb
+    full_path = path.abspath(filename)
+    content = None
+    with open(full_path, "r") as f:
+        txt = f.read()
+        content = json.loads(txt)
+
+    # Default
+    language_specific_tool = "black --diff {}"
+    if command:
+       language_specific_tool = command
+    else:
+      kernel_name = content["metadata"]["kernelspec"]["name"]
+      if kernel_name == "deno":
+        language_specific_tool = "deno check {}"
+
+    argv = ["--check", language_specific_tool, full_path]
+    # Lazily loaded for performance
+    from jupytext.cli import jupytext as jupytext_main
+
+    jupytext_main(args=argv)

runbook/cli/commands/check.py

@@ -12,6 +12,7 @@
    },
    "source": [
     "# TITLE\n",
+    "\n",
     "## DESCRIPTION"
    ]
   },
@@ -45,10 +46,10 @@
    "outputs": [],
    "source": [
     "// Default Params\n",
-    "let server: string = \"main.xargs.io\"\n",
-    "let arg: number = 1\n",
-    "let anArray: string[] = ['a', 'b']\n",
-    "let __RUNBOOK_METADATA__ = {}"
+    "let server: string = \"main.xargs.io\";\n",
+    "let arg: number = 1;\n",
+    "let anArray: string[] = [\"a\", \"b\"];\n",
+    "let __RUNBOOK_METADATA__ = {};"
    ]
   },
   {
@@ -64,7 +65,7 @@
    },
    "outputs": [],
    "source": [
-    "import {sh, $} from 'https://raw.githubusercontent.com/zph/runbook/main/ext/deno/runbook/mod.ts'"
+    "import { $, sh } from \"https://raw.githubusercontent.com/zph/runbook/main/ext/deno/runbook/mod.ts\";"
    ]
   },
   {
@@ -80,7 +81,7 @@
    },
    "outputs": [],
    "source": [
-    "await sh(\"git log\")"
+    "await sh(\"git log\");"
    ]
   },
   {
@@ -124,7 +125,7 @@
    },
    "outputs": [],
    "source": [
-    "await $`echo '{\"a\": 1}'`.json()"
+    "await $`echo '{\"a\": 1}'`.json();"
    ]
   },
   {
@@ -154,7 +155,7 @@
    },
    "outputs": [],
    "source": [
-    "await $`git log`.text()"
+    "await $`git log`.text();"
    ]
   },
   {

runbooks/binder/_template-deno.ipynb

@@ -12,6 +12,7 @@
    },
    "source": [
     "# TITLE\n",
+    "\n",
     "## Description"
    ]
   },
@@ -168,7 +169,7 @@
    "id": "f0e9eade",
    "metadata": {},
    "source": [
-    "<span style='color: red;'><bold>DANGER</bold></span> <span style='color: red;'><bold>DANGER</bold></span> <span style='color: red;'><bold>DANGER</bold></span>  The following code is going to be risky. Be prepared with rollback procedures."
+    "<span style='color: red;'><bold>DANGER</bold></span> <span style='color: red;'><bold>DANGER</bold></span> <span style='color: red;'><bold>DANGER</bold></span> The following code is going to be risky. Be prepared with rollback procedures."
    ]
   },
   {