fix: Restore Grid visualizer to operation

.github/pull_request_template.md

@@ -1,4 +1,10 @@
-By submitting this PR, I am indicating to the Numberscope maintainers that I have read and understood the [contributing guidelines](https://numberscope.colorado.edu/doc/CONTRIBUTING/) and that this PR follows those guidelines to the best of my knowledge. I have also read the [pull request checklist](https://numberscope.colorado.edu/doc/doc/pull-request-checklist/) and followed the instructions therein.
+By submitting this PR, I am indicating to the Numberscope maintainers that I
+have read and understood the
+[contributing guidelines](https://numberscope.colorado.edu/doc/CONTRIBUTING/)
+and that this PR follows those guidelines to the best of my knowledge. I have
+also read the
+[pull request checklist](https://numberscope.colorado.edu/doc/doc/pull-request-checklist/)
+and followed the instructions therein.
 
 <hr/>
 

.github/workflows/ci.yaml

@@ -1,5 +1,10 @@
 name: 'CI'
-on: pull_request
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
 jobs:
     lint:
         runs-on: ubuntu-22.04
@@ -12,13 +17,15 @@ jobs:
             - name: Set up Node.js
               uses: actions/setup-node@v3
               with:
-                  node-version: '18.x'
+                  node-version: '20.x'
             - name: Install dependencies
               run: npm install
             - name: Lint
               run: npm run lint:check
+            - name: Type check
+              run: npm run typecheck
     test:
-        runs-on: ubuntu-22.04
+        runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v3
             - name: Set up Python
@@ -28,8 +35,23 @@ jobs:
             - name: Set up Node.js
               uses: actions/setup-node@v3
               with:
-                  node-version: '18.x'
+                  node-version: '20.x'
+            - name: Install d2 document generator
+              run: curl -fsSL https://d2lang.com/install.sh | sh -s --
             - name: Install dependencies
               run: npm install
-            - name: Test
+            - name: Unit test
               run: npm run test:unit
+            - name: Build production site
+              run: npm run build
+            - name: Install Playwright browsers
+              run: npx playwright install --with-deps
+            - name: End-to-end test
+              run: npx playwright test -c e2e/playci.config.ts
+### Uncomment when you need to re-extract snapshots
+#            - name: Extract snapshots
+#              if: always()
+#              uses: actions/upload-artifact@v4
+#              with:
+#                  name: ci_actual_snapshots
+#                  path: e2e/results/manual/output

.gitignore

@@ -4,14 +4,25 @@ logs
 npm-debug.log*
 
 # Subdirectories generated by various tools
+.cache
 .venv
 coverage
-dist
 node_modules
-site
 
 # File for storing your local configuration
 *.local
 
 # Emacs backup files
 *~
+
+# Build files
+dist
+etc/npm_install_ran_at
+etc/typechecked_at
+site
+
+# End-to-end testing
+e2e/.last_cl_args
+e2e/certificate
+e2e/docker_image_built
+e2e/results

.husky/pre-commit

@@ -1,8 +1,8 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run lint:list || echo 'Files listed above will be reformatted and staged.'
-npm run lint:staged
+node tools/cleancommit.js
 npm run lint:check
-npm run typecheck
 npm run test:unit
+npm run test:e2e
+

.prettierignore

@@ -2,20 +2,24 @@
 *.ico
 *.jpg
 *.png
+*.svg
 *.ttf
 *.txt
 *.generator
 *.local
 *~
+.env
+.env.*
+.github/workflows
 .gitignore
 .husky
 .prettierignore
 .vscode
 coverage
 dist
+index.html
 node_modules
 package-lock.json
-index.html
+e2e/*-snapshots
+e2e/results
 site
-.env
-.env.*

CONTRIBUTING.md

@@ -1,45 +1,40 @@
 # Contributing to Numberscope
 
-## If you are new to software development and like written guides...
+## If you are new to software development...
 
 Read our [onboarding doc](./doc/onboarding.md).
 
-## If you are new to software development and like videos...
-
-Watch the video series on contributing to Numberscope
-[here](https://www.youtube.com/playlist?list=PLA4KIQBQQRb5ccOdr9v0iLw_fKHup1PkU).
-This video series will introduce you to Numberscope, GitHub, the software we
-use in the Numberscope project, and the workflow for contributing to
-Numberscope.
-
 ## If you are experienced, follow these steps...
 
 (This assumes you're working on the numberscope/frontscope repository, but it
-applies to other repos as well.)
-
-1. [Create a fork of the numberscope/frontscope repo](./doc/working-with-git-and-github.md#create-a-fork).
-2. [Clone your fork of numberscope/frontscope](./doc/working-with-git-and-github.md#clone-a-repo).
-3. [Create a branch for your contribution](./doc/working-with-git-and-github.md#create-a-branch).
-4. If you are unfamiliar with them or would like a refresher,
-   [read about basic Git operations](./doc/working-with-git-and-github.md#basic-operations).
-5. [Push your branch to GitHub](./doc/working-with-git-and-github.md#push-a-branch).
-6. [Read Numberscope's coding principles guide](./doc/code-principles.md).
-7. [Read Numberscope's style guide](./doc/code-style.md). You should also
-   familiarize yourself with frontscope's internal code structure and APIs.
-   Documentation on these topics is generally incorporated into the relevant
-   source files (see [this example](src/shared/math.ts)). However, it is all
-   gathered in the "Internal code and APIs" section of the navigation bar in
-   the [online docs](https://numberscope.colorado.edu/doc).
-8. If you are working on a visualizer, read
-   [the doc on making a visualizer](./doc/making-a-visualizer.md).
-9. [Work through Numberscope's pull request checklist](./doc/pull-request-checklist.md).
-10. [Submit a pull request](./doc/working-with-git-and-github.md#submit-a-pull-request).
+applies to other repos as well. If you are unfamiliear with basic git
+operations or would like a refresher, we
+[have a guide](doc/working-with-git-and-github.md#basic-operations).)
+
+1. [Clone the numberscope/frontscope repository](doc/working-with-git-and-github.md#clone-a-repo).
+2. [Create a branch for your contribution](doc/working-with-git-and-github.md#create-a-branch).
+3. [Read Numberscope's coding principles guide](doc/code-principles.md).
+4. Familiarize yourself with frontscope's
+   [code organization](doc/code-organization.md) and internal APIs. Some
+   information on the latter topic may only be found in comments in the
+   relevant sources files, as the documentation project is ongoing. However,
+   all such formal documentation currently being generated is gathered in the
+   "Internal code and APIs" section of the navigation bar in the
+   [online docs](https://numberscope.colorado.edu/doc).
+5. If you are working on a visualizer, read the documentation section on
+   [making a visualizer](doc/visualizer-overview.md).
+6. Implement your changes.
+7. [Create a fork of the numberscope/frontscope repo](doc/working-with-git-and-github.md#create-a-fork).
+8. [Add your fork as a remote](doc/working-with-git-and-github.md#add-a-remote).
+9. [Push your branch to GitHub](doc/working-with-git-and-github.md#push-a-branch).
+10. [Work through Numberscope's pull request checklist](doc/pull-request-checklist.md).
+11. [Submit a pull request](doc/working-with-git-and-github.md#submit-a-pull-request).
 
 ## If you need help with Git and contributing...
 
 If you have a Git setup that isn't what Numberscope requires (i.e. do your
 work in your own fork on a feature branch) check out our doc on
-[Gitting it right](./doc/gitting-it-right.md).
+[Gitting it right](doc/gitting-it-right.md).
 
 ## A note on code organization
 
@@ -64,24 +59,25 @@ their factorizations, see `backscope`
 applies to other repos as well.)
 
 If you've read the
-[Numberscope code principles guide](./doc/code-principles.md) and the
-[Numberscope code style guide](./doc/code-style.md), and you think your code
-is ready to be reviewed by someone at Numberscope, follow these steps:
+[Numberscope code principles guide](./doc/code-principles.md) and have adhered
+to the [code organization](./doc/code-organization.md), and you think your
+code is ready to be reviewed by someone at Numberscope, follow these steps:
 
 1. Work through
    [Numberscope's pull request checklist](./doc/pull-request-checklist.md).
-2. Sync your fork with the main numberscope/frontscope repository. The easiest
-   way to do this is to navigate to the page of your fork of
-   numberscope/frontscope and click "Sync fork" (see the picture below).
-   ![A screenshot of the Sync fork option](./doc/img/sync-fork.png) Another
-   way to do this is to
-   [add numberscope/frontscope as a remote](./doc/working-with-git-and-github.md#add-a-remote)
-   and
-   [sync your fork with the remote original](./doc/working-with-git-and-github.md#sync-local-fork-with-remote-original).
+2. Make sure your branch is based on the latest version of the `main` branch
+   from the official repository. The simplest way to do this is to
+   [sync your local clone](doc/working-with-git-and-github.md#sync-a-local-clone)
+   and if your copy of `main` pulled additional new commits in that process
+   (as opposed to being reported as "already up to date"), then go ahead and
+   [rebase your branch](doc/working-with-git-and-github.md#rebase-your-branch).
 3. Navigate to the numberscope/frontscope repository. If your fork is synced
    up with the main numberscope/frontscope repository correctly, you should
    see a button (see the image below) that says "Compare & pull request".
    ![A screenshot of the Compare & pull request
-button](./doc/img/compare-and-pull-request.png)
+button](doc/img/compare-and-pull-request.png)
    Click that button, write up some notes for your pull request, and click the
-   "Create pull request button".
+   "Create pull request button". Our
+   [Working with Git guide](doc/working-with-git-and-github.md) has more
+   details about
+   [submitting a pull request](doc/working-with-git-and-github.md#submit-a-pull-request).

doc/about.md

@@ -18,23 +18,28 @@ You can find [Numberscope on GitHub](https://github.com/numberscope) or
 
 ## Contributors
 
--   Abdullatif Khalid Abduljaleel
--   Tobias Aldape
--   Khaled Allen
--   Isabel Anaya
--   Sebastian Bozlee
--   Olivia Brobin
--   Devlin Costello
--   Aaron Fenyes
--   Brendan Heaney
--   Steven Hristopoulos
--   Clyde Kertzer
--   Jennifer Leong
--   Ang Li
--   Theodore Lincke
--   Josiah Martinez
--   Willem Mirkovich
--   Liam Mulhall
--   Daniel H. Taylor
+<!-- prettier-ignore -->
++---------------------------------+-------------------------------+
+| • Abdullatif Khalid Abduljaleel | • Steven Hristopoulos         |
++---------------------------------+-------------------------------+
+| • Tobias Aldape                 | • Clyde Kertzer               |
++---------------------------------+-------------------------------+
+| • Khaled Allen                  | • Jennifer Leong              |
++---------------------------------+-------------------------------+
+| • Isabel Anaya                  | • Ang Li                      |
++---------------------------------+-------------------------------+
+| • Sebastian Bozlee              | • Theodore Lincke             |
++---------------------------------+-------------------------------+
+| • Olivia Brobin                 | • Josiah Martinez             |
++---------------------------------+-------------------------------+
+| • Devlin Costello               | • Willem Mirkovich            |
++---------------------------------+-------------------------------+
+| • Aaron Fenyes                  | • Liam Mulhall                |
++---------------------------------+-------------------------------+
+| • Brendan Heaney                | • Daniel H. Taylor            |
++---------------------------------+-------------------------------+
+| • Delft CSE2000 Spring '24 Team: Matej Bavec, Ziggy Beijer,<br> |
+| &nbsp; &nbsp;Kaldis Bērziņš, Max Derbenwick, and Gido Vitner    |
++-----------------------------------------------------------------+
 
 [Acknowledgments](acknowledgments.md)