buggy merge conflicts

Author: reevafaisal

.gitattributes

@@ -11,6 +11,7 @@ src/haz3lweb/exercises/**/*.ml linguist-generated
 
 hazel.opam linguist-generated
 hazel.opam.locked linguist-generated
+package-lock.json linguist-generated
 
 *.md linguist-documentation
 docs/** linguist-documentation

.github/workflows/deploy_branches.yml

@@ -16,6 +16,13 @@ jobs:
           path: source
       - name: Add the name of the current branch to the environment as BRANCH_NAME
         uses: nelonoel/[email protected]
+      - name: Install node/npm
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'latest'
+      - name: Install NPM dependencies
+        run: npm install
+        working-directory: ./source
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
@@ -70,14 +77,20 @@ jobs:
         id: test
         run: |
           eval $(opam env)
-          make test
+          make ci
         working-directory: ./source
       - name: Test Report
         uses: dorny/test-reporter@v1
         with:
           name: Test Report
-          path: junit_tests*.xml
+          path: ./_build/default/test/junit_tests*.xml
           reporter: java-junit
           fail-on-error: true
           fail-on-empty: true # Use an empty test report to detect when something failed with the test runner
-          working-directory: ./source
+          working-directory: ./source
+      - name: Send coverage report to Codecov
+        run: opam exec -- bisect-ppx-report send-to Codecov --verbose
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          PULL_REQUEST_NUMBER: ${{ github.event.number }}
+        working-directory: ./source

.gitignore

@@ -59,3 +59,4 @@ hazel.opam.locked.old
 
 # Code coverage
 _coverage/
+node_modules/** 

Makefile

@@ -9,6 +9,7 @@ all: dev
 deps:
 	opam update
 	opam install ./hazel.opam.locked --deps-only --with-test --with-doc
+	npm install
 
 change-deps:
 	opam update
@@ -64,13 +65,17 @@ test:
 	node $(TEST_DIR)/haz3ltest.bc.js
 
 watch-test:
-	dune build @ocaml-index @fmt @runtest --auto-promote --watch
+	dune build @ocaml-index @fmt @runtest @default --profile dev --auto-promote --watch
 
 coverage:
 	dune build @src/fmt @test/fmt --auto-promote src test --profile dev
 	dune runtest --instrument-with bisect_ppx --force
 	bisect-ppx-report summary
 
+ci:
+	dune build --profile dev
+	dune runtest --instrument-with bisect_ppx --force
+	
 generate-coverage-html:
 	bisect-ppx-report html
 

README.md

@@ -1,4 +1,4 @@
-# Hazel ![Build Status](https://github.com/hazelgrove/hazel/actions/workflows/deploy_branches.yml/badge.svg)
+# Hazel ![Build Status](https://github.com/hazelgrove/hazel/actions/workflows/deploy_branches.yml/badge.svg) [![codecov](https://codecov.io/gh/hazelgrove/hazel/graph/badge.svg?token=lOGAH9Shqe)](https://codecov.io/gh/hazelgrove/hazel)
 
 Hazel is a live functional-programming environment rooted in the principles of
 type theory. You can find the relevant papers and more motivation at [the Hazel
@@ -17,7 +17,7 @@ can also be accessed at:
 
 ### Short version
 
-If you already have `ocaml` version 5.2.0 and at least version 2.0 of `opam`
+If you already have `ocaml` version 5.2.0, at least version 2.0 of `opam`, and `npm`
 installed, you can build Hazel by running the following commands.
 
 - `git clone [email protected]:hazelgrove/hazel.git`
@@ -211,7 +211,7 @@ It usually takes about 2 minutes if the build environment cache hits, or
 20+ minutes if not. You can view the status of the build in the [Actions 
 tab on Github](https://github.com/hazelgrove/hazel/actions).
 
-Builds prior to July 2024 are archived at `https://hazel.org/build/<branch name>`.
+Builds prior to July 2024 are archived at `https://hazel.org/build-pre-july2024/<branch name>`.
 
 Note: If another archive needs to be performed, make sure to redeploy the following
 branches manually since we refer to them in various public material (websites and

codecov.yml

@@ -0,0 +1,21 @@
+codecov:
+  branch: dev
+
+coverage:
+  status:
+    project: # more options at https://docs.codecov.com/docs/commit-status
+      default:
+        target: auto # Monotonically increasing coverage
+        threshold: 2% # Allows coverage to drop by 2%
+        informational: true
+    patch:
+      default:
+        informational: true
+
+comment:
+  layout: " diff, files"
+  behavior: default # update comment, if exists. Otherwise post new
+  require_changes: true
+  require_base: false
+  require_head: true
+  hide_project_coverage: false

docs/Change-JS-Dependencies.md

@@ -0,0 +1,45 @@
+# Adding JavaScript Dependencies
+
+Follow these steps to add and manage JavaScript dependencies in the project:
+
+## 1. Add Dependencies to `package.json`
+- Open the `package.json` file in the project root.
+- Add the required dependencies under the `"dependencies"` section.  
+    Example:
+    ```json
+    "dependencies": {
+        "example-library": "^1.0.0"
+    }
+    ```
+
+## 2. Update the Lock File
+- Run the following command to install the new dependencies and update the `package-lock.json` file:
+    ```bash
+    make deps
+    ```
+    **Note:** This command runs `npm install` under the hood. It installs the dependencies listed in the `package.json` file and updates the `package-lock.json` file to reflect the exact versions of the installed packages. This ensures consistent dependency resolution across environments.
+
+## 3. Reference Dependencies in JavaScript Files
+- Make sure the desired dependency is referenced by `src/haz3lweb/www/prebundle.js`
+    Example:
+    ```javascript
+    import exampleLibrary from 'example-library';
+
+    exampleLibrary.doSomething();
+    ```
+- If you add a new toplevel js file (outside of prebundle.js) you need to ensure it is bundled and included
+    - Ensure the `dune` build step is configured to use `esbuild` for bundling the JavaScript files.
+        - This is the current step in `src/haz3lweb/dune`
+            ```dune
+            (rule
+                (targets bundled.js)
+                (action
+                (run
+                %{project_root}/node_modules/esbuild/bin/esbuild
+                prebundle.js
+                --bundle
+                --outfile=bundled.js)))
+            ```
+        - We need the bundled js for every loaded js file we depend on
+            - This means that dependencies should be added to already bundled files or a new bundle needs to be added. 
+    - The dependencies will be bundled automatically during the build process.

dune-project

@@ -50,6 +50,7 @@
     (>= 2.1.0)
     :with-test))
   ocaml-lsp-server
+  ocaml-index
   qcheck
   qcheck-alcotest
   ppx_deriving_qcheck))