Unit test

Author: keller-mark

.github/workflows/CI.yml

@@ -152,12 +152,30 @@ jobs:
         with:
           name: wheels-sdist
           path: dist
+  
+  unit-test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ['3.10', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+        env:
+          UV_PYTHON: ${{ matrix.version }}
+      - name: Install vitessce
+        run: uv sync --extra dev
+      - name: Run tests
+        run: uv run pytest
 
   release:
     name: Release
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
-    needs: [linux, musllinux, windows, macos, sdist]
+    needs: [unit-test, linux, musllinux, windows, macos, sdist]
     permissions:
       # Use to sign the release artifacts
       id-token: write

README.md

@@ -1,2 +1,41 @@
 # oxc-py
 
+## Usage
+
+```py
+from oxc_py import transform
+
+jsx = """
+import * as React from 'react'
+import * as ReactDOM from 'react-dom'
+
+ReactDOM.render(
+    <h1>Hello, world!</h1>,
+    document.getElementById('root')
+);
+"""
+
+print(transform(jsx))
+```
+
+## Development
+
+### Setup
+
+```sh
+uv venv
+source .venv/bin/activate
+uv sync --extra dev
+```
+
+### Test
+
+```sh
+uv run pytest
+```
+
+## Resources
+- https://github.com/keller-mark/esbuild-py
+- https://github.com/oxc-project/oxc/blob/71155cf575b6947bb0e85376d18375c2f3c50c73/crates/oxc_transformer/examples/transformer.rs
+- https://docs.rs/oxc_transformer/0.53.0/oxc_transformer/
+- https://www.maturin.rs/tutorial.html

pyproject.toml

@@ -11,8 +11,14 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dynamic = ["version"]
-dependencies = [
-    "maturin>=1.8.2",
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  'pytest>=6.2.4',
+  "maturin>=1.8.2",
 ]
+
+
 [tool.maturin]
 features = ["pyo3/extension-module"]

tests/test_transform.py

@@ -18,9 +18,6 @@ def test_jsx(self):
         expected = """
 import * as React from "react";
 import * as ReactDOM from "react-dom";
-ReactDOM.render(
-  /* @__PURE__ */ React.createElement("h1", null, "Hello, world!"),
-  document.getElementById("root")
-);
+ReactDOM.render(React.createElement("h1", null, "Hello, world!"), document.getElementById("root"));
         """
         assert transform(jsx).strip() == expected.strip()