feat: First frontend library with environment

- Use esbuild for bundle.
- Use biome for linting/formatting.
- Chechk biome on pre-commit.
- Bundle generated file into python-package.

.github/workflows/main.yml

@@ -35,6 +35,11 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      - uses: volta-cli/action@v4
+      - name: Build static files
+        run: |
+          npm i
+          npm run build
       - name: Configure venv
         run: |
           pip install uv
@@ -69,8 +74,11 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version-file: '.python-version'
+      - uses: volta-cli/action@v4
       - name: Build package
         run: |
+          npm i
+          npm run build
           pip install hatch
           hatch build
           ls -l dist

.pre-commit-config.yaml

@@ -13,3 +13,10 @@ repos:
       - id: doc8
         args:
           - --max-line-length=119
+  - repo: local
+    hooks:
+      - id: local-biome-check
+        name: biome
+        entry: npx biome check --apply --files-ignore-unknown=true --no-errors-on-unmatched
+        language: system
+        types: [text]

biome.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "formatter": {
+    "indentStyle": "space"
+  }
+}

esbuild.mjs

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import * as esbuild from "esbuild";
+
+await esbuild.build({
+  entryPoints: ["main.js"],
+  bundle: true,
+  minify: true,
+  sourcemap: true,
+  outfile: "src/atsphinx/mini18n/_static/atsphinx-mini18n.min.js",
+  target: ["chrome58", "firefox57", "safari11", "edge16"],
+});

main.js

@@ -0,0 +1,4 @@
+/**
+ * Entrypoint for browser works library of atsphinx-mini18n.
+ */
+

package.json

@@ -7,11 +7,17 @@
     "doc": "doc",
     "test": "tests"
   },
-  "scripts": {},
+  "scripts": {
+    "build": "node ./esbuild.mjs"
+  },
   "keywords": [],
   "author": "Kazuya Takei",
   "license": "Apache-2.0",
-  "dependencies": {
-    "typescript": "^5.4.5"
+  "devDependencies": {
+    "@biomejs/biome": "1.7.3",
+    "esbuild": "0.21.2"
+  },
+  "volta": {
+    "node": "20.13.1"
   }
 }

pyproject.toml

@@ -53,10 +53,11 @@ dev-dependencies = [
 ]
 
 [tool.rye.scripts]
-setup = {chain = ["setup:sync", "setup:pre-commit", "setup:playwright"]}
+setup = {chain = ["setup:sync", "setup:pre-commit", "setup:playwright", "setup:frontend"]}
 "setup:sync" = "rye sync --no-lock --all-features"
 "setup:pre-commit" = "pre-commit install"
 "setup:playwright" = "rye run playwright install firefox"
+"setup:frontend" = "npm i"
 doc = "make -C doc"
 age = "python tools/run_age.py"
 

src/atsphinx/mini18n/__init__.py

@@ -108,12 +108,23 @@ def get_template_dir() -> str:  # noqa: D103
     return str(package_root / "templates")
 
 
+def register_extra_static_files(app: Sphinx):
+    """Append JavaScript file for package."""
+    if app.builder.format != "html":
+        return
+    _static_path = getattr(app.config, "html_static_path", [])
+    _static_path.append(str(package_root / "_static"))
+    _js_files = getattr(app.config, "html_js_files", [])
+    _js_files.append("atsphinx-mini18n.min.js")
+
+
 def setup(app: Sphinx):  # noqa: D103
     app.add_config_value("mini18n_default_language", None, "env")
     app.add_config_value("mini18n_support_languages", [], "env")
     app.add_config_value("mini18n_basepath", "/", "env")
     app.add_config_value("mini18n_select_lang_label", "Language:", "env")
     app.connect("config-inited", autocomplete_config)
+    app.connect("builder-inited", register_extra_static_files)
 
     # IMPORTANT!!
     # This is verty dirty hack to work it for any builders of third-party extensions.

src/atsphinx/mini18n/_static/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

tests/test_it.py

@@ -11,6 +11,7 @@
 def test__it(app: SphinxTestApp):
     """Test to pass."""
     app.build()
+    assert (app.outdir / "_static/atsphinx-mini18n.min.js").exists()
 
 
 @pytest.mark.sphinx("mini18n-html")