[Explorer] Set up Conductor's explorer module and interface (#113)

geoffxy · Nov 25, 2024 · d3f6ee4 · d3f6ee4
1 parent eaa4ad0
commit d3f6ee4
Show file tree

Hide file tree

Showing 27 changed files with 4,031 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,6 @@ dist
 cond-out
 
 src/conductor/envs/resources/*.whl
+
+explorer/node_modules/
+explorer/dist/
diff --git a/errors/errors.yml b/errors/errors.yml
@@ -230,3 +230,9 @@
   message: >-
     There is no relevant output path for '{task_identifier}'. For most tasks,
     this just means that you need to run the task first.
+
+5012:
+  name: MissingExplorerSupport
+  message: >-
+    This feature requires support for Conductor's explorer. Please install
+    Conductor with the [explore] features.
diff --git a/explorer/.eslintignore b/explorer/.eslintignore
@@ -0,0 +1 @@
+dist/**
diff --git a/explorer/.prettierignore b/explorer/.prettierignore
@@ -0,0 +1,3 @@
+dist
+node_modules
+__pycache__
diff --git a/explorer/.prettierrc.json b/explorer/.prettierrc.json
@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "semi": true
+}
diff --git a/explorer/README.md b/explorer/README.md
@@ -0,0 +1,12 @@
+# Conductor Explorer
+
+This directory contains the code used for Conductor's explorer. To launch the
+explorer, run `cond explorer`. The instructions below are for development.
+
+## Development
+
+- Run `npm install` (only need to do once)
+- Run `npm run watch` inside this directory
+- Run `cond explorer` to launch the explorer backend and web server (required
+  for access to Conductor APIs)
+
diff --git a/explorer/dist/__init__.py b/explorer/dist/__init__.py
diff --git a/explorer/eslint.config.js b/explorer/eslint.config.js
@@ -0,0 +1,38 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import react from 'eslint-plugin-react'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+
+export default [
+  { ignores: ['dist'] },
+  {
+    files: ['**/*.{js,jsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        ecmaFeatures: { jsx: true },
+        sourceType: 'module',
+      },
+    },
+    settings: { react: { version: '18.3' } },
+    plugins: {
+      react,
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      ...react.configs.recommended.rules,
+      ...react.configs['jsx-runtime'].rules,
+      ...reactHooks.configs.recommended.rules,
+      'react/jsx-no-target-blank': 'off',
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+]
diff --git a/explorer/index.html b/explorer/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Conductor Explorer</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>