Project Setup¶

Warning

If you clone the project, Make sure to initialize the git submodules.

You can either add the --recurse-submodules flag when doing git clone or do git submodule update --init --recursive once it is already cloned.

This project uses Bun (for Web) and Deno (for CLI).

Warning

Building the assembler dependency requires installing rustup, Deno, and wasm-pack.

bun install  # install dependencies
bun dev:wasm  # build wasm dependencies

Compile Web and Hot-Reload for Development (with Vite)¶

bun dev:web

Run CLI and Hot-Reload for Development (with Deno)¶

bun dev:cli

Note

Remember to pass the extra arguments, e.g:

bun dev:cli -a ./architecture/RISCV/RV32IMFD.yml -I -c creatorconfig.yml

Building Web version for production¶

bun build:web

The resulting bundle will be saved to dist/web/.

Tip

To test locally the bundle version, as it will be deployed in GitHub Pages:

REPO="creatorV" bun build:web
cd dist/web
python -m http.server 8080

And go to localhost:8080/creatorV/

Building CLI version¶

bun build:cli

Lint with ESLint ¶

bun lint

Format with Prettier ¶

bun format <file/directory>

Run Tests¶

Unit tests (with Deno)

deno test -A --unstable-node-globals --parallel

VS Code Setup¶

The recommended extensions are:

Note

The recommended formatter to use with Vue files is Prettier (esbenp.prettier-vscode):

"[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
},

Debugging¶

We provide some example launch configurations:

Web¶

We'll need to launch the application in DEV mode, and then attach the VS Code debugger to the Chrome instance.

{
    "type": "chrome",
    "request": "launch",
    "name": "Debug Web",
    "url": "http://localhost:5173",
    "webRoot": "${workspaceFolder}"
}

CLI¶

{
    "type": "node",
    "request": "launch",
    "name": "Debug CLI",
    "program": "${workspaceFolder}/src/cli/creator6.mts",
    "runtimeExecutable": "deno",
    "console": "integratedTerminal",
    "runtimeArgs": ["-A", "--unstable-node-globals", "--inspect-brk"],
    "experimentalNetworking": "off",
    "args": [
        "-a",
        "./architecture/RISCV/RV32IMFD.yml",
        "-s",
        "./tests/arch/riscv/correct/examples/test_riscv_example_011.s",
        "-c",
        "creatorconfig.yml",
        "-I"
    ],
    "attachSimplePort": 9229
}

GeezerVison

Project Setup¶

Compile Web and Hot-Reload for Development (with Vite)¶

Run CLI and Hot-Reload for Development (with Deno)¶

Building Web version for production¶

Building CLI version¶

Lint with ESLint ¶

Format with Prettier ¶

Run Tests¶

VS Code Setup¶

Debugging¶

Web¶

CLI¶

General resources¶

GeezerVison

Project Setup¶

Compile Web and Hot-Reload for Development (with Vite)¶

Run CLI and Hot-Reload for Development (with Deno)¶

Building Web version for production¶

Building CLI version¶

Lint with ESLint¶

Format with Prettier¶

Run Tests¶

VS Code Setup¶

Debugging¶

Web¶

CLI¶

General resources¶

Lint with ESLint ¶

Format with Prettier ¶