Skip to content

Commit 12fde00

Browse files
authored
chore: Add dev instructions for JavaScript code (#180)
1 parent b9f4447 commit 12fde00

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,20 @@ and understanding are greatly appreciated.
7070

7171
## Development
7272

73-
**higlass-python** uses uses [uv](https://astral.sh/uv) for development.
73+
**higlass-python** is primarily a Python project, but it includes JavaScript for
74+
the anywidget-based front-end code (`src/higlass/widget.js`). We use
75+
[uv](https://github.com/astral-sh/uv) for Python development and
76+
[deno](https://github.com/denoland/deno) for linting and type-checking
77+
JavaScript.
78+
79+
All formatting, linting, and tests are enforced in CI.
7480

7581
### Commands Cheatsheet
7682

7783
All commands are run from the root of the project, from a terminal:
7884

85+
#### Python
86+
7987
| Command | Action |
8088
| ----------------------------------------------- | --------------------------------------------- |
8189
| `uv run ruff check --fix && uv run ruff format` | Lint and apply formatting |
@@ -84,11 +92,13 @@ All commands are run from the root of the project, from a terminal:
8492
| `uv run pytest` | Run unit tests |
8593
| `uv run docs/build.py` | Build the documentation in `docs/_build/html` |
8694

87-
This table now includes only the UV-related commands, with each command in the
88-
left column and its corresponding action in the right column. The formatting is
89-
clean and easy to read.
95+
#### JavaScript
9096

91-
Our CI enforces formatting, linting, and tests.
97+
| Command | Action |
98+
| ---------------------------------- | ----------------------------- |
99+
| `deno fmt` | Format code |
100+
| `deno lint --fix` | Lint and auto-fix issues |
101+
| `deno check src/higlass/widget.js` | Typecheck .js with TypeScript |
92102

93103
## Changelog
94104

0 commit comments

Comments
 (0)