Merge pull request #847 from c-bata/change-repository-structure

Move config files to under the `optuna_dashboard` directory.

.github/workflows/e2e-dashboard-tests.yml

@@ -8,9 +8,9 @@ on:
       - '**.py'
       - '**.ts'
       - '**.tsx'
-      - 'package.json'
-      - 'package-lock.json'
-      - 'tsconfig.json'
+      - 'optuna_dashboard/package.json'
+      - 'optuna_dashboard/package-lock.json'
+      - 'optuna_dashboard/tsconfig.json'
 jobs:
   test:
     runs-on: ubuntu-20.04
@@ -24,8 +24,12 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - run: npm install
-      - run: npm run build:dev
+
+      - name: Build bundle.js
+        working-directory: optuna_dashboard
+        run: |
+          npm install
+          npm run build:dev
 
       - name: Set up Python
         uses: actions/setup-python@v2

.github/workflows/pypi-publish.yml

@@ -18,8 +18,12 @@ jobs:
       uses: actions/setup-node@v2
       with:
         node-version: '16'
-    - run: npm install
-    - run: npm run build:prd
+    
+    - name: Build bundle.js
+      working-directory: optuna_dashboard
+      run: |
+        npm install
+        npm run build:prd
 
     - name: Set up Python
       uses: actions/setup-python@v4

.github/workflows/typescript-tests.yml

@@ -6,9 +6,10 @@ on:
       - '.eslintrc.js'
       - '**.ts'
       - '**.tsx'
-      - 'package.json'
-      - 'package-lock.json'
-      - 'tsconfig.json'
+      - 'optuna_dashboard/package.json'
+      - 'optuna_dashboard/package-lock.json'
+      - 'optuna_dashboard/tsconfig.json'
+      - 'optuna_dashboard/webpack.config.js'
 jobs:
   lint:
     name: Lint checking on Ubuntu
@@ -37,7 +38,9 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - run: |
+      - name: Build bundle.js
+        working-directory: optuna_dashboard
+        run: |
           npm install
           npm run build:dev
           npm run build:prd
@@ -54,6 +57,8 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - run: |
+      - name: Run jest
+        working-directory: optuna_dashboard
+        run: |
           npm install
           npm run test

CONTRIBUTING.md

@@ -26,6 +26,7 @@ The repository is organized as follows:
 Node.js v16 is required to compile TypeScript files.
 
 ```
+$ cd optuna_dashboard/
 $ npm install
 $ npm run build:dev
 ```
@@ -34,6 +35,7 @@ $ npm run build:dev
 <summary>Watch for files changes</summary>
 
 ```
+$ cd optuna_dashboard/
 $ npm run watch
 ```
 
@@ -43,6 +45,7 @@ $ npm run watch
 <summary>Production builds</summary>
 
 ```
+$ cd optuna_dashboard/
 $ npm run build:prd
 ```
 

Dockerfile

@@ -1,12 +1,12 @@
 FROM node:20 AS front-builder
-WORKDIR /usr/src
+WORKDIR /usr/src/optuna_dashboard
 
-ADD ./package.json /usr/src/package.json
-ADD ./package-lock.json /usr/src/package-lock.json
+ADD ./optuna_dashboard/package.json /usr/src/optuna_dashboard/package.json
+ADD ./optuna_dashboard/package-lock.json /usr/src/optuna_dashboard/package-lock.json
 RUN npm install
 
-ADD ./tsconfig.json /usr/src/tsconfig.json
-ADD ./webpack.config.js /usr/src/webpack.config.js
+ADD ./optuna_dashboard/tsconfig.json /usr/src/optuna_dashboard/tsconfig.json
+ADD ./optuna_dashboard/webpack.config.js /usr/src/optuna_dashboard/webpack.config.js
 ADD ./optuna_dashboard/ts/ /usr/src/optuna_dashboard/ts
 RUN mkdir -p /usr/src/optuna_dashboard/public
 RUN npm run build:prd

Makefile

@@ -16,7 +16,7 @@ vscode/assets/bundle.js: $(RUSTLIB_OUT) $(STANDALONE_SRC)
 	cd standalone_app && npm install && npm run build:vscode
 
 $(DASHBOARD_TS_OUT): $(DASHBOARD_TS_SRC)
-	npm install && npm run build:$(MODE)
+	cd optuna_dashboard && npm install && npm run build:$(MODE)
 
 .PHONY: serve-browser-app
 serve-browser-app: $(RUSTLIB_OUT)

biome.json

@@ -4,8 +4,6 @@
 		"include": [
 			"optuna_dashboard/ts/**/*.ts",
 			"optuna_dashboard/ts/**/*.tsx",
-			"typescript_tests/**/*.ts",
-			"typescript_tests/**/*.tsx",
 			"standalone_app/src/**/*.ts",
 			"standalone_app/src/**/*.tsx",
 			"vscode/src/**/*.ts",

optuna_dashboard/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "optuna-dashboard",
+  "private": true,
+  "version": "0.0.1",
+  "description": "Dashboard for Optuna",
+  "main": "index.js",
+  "scripts": {
+    "watch": "NODE_ENV=development TYPESCRIPT_LOADER=esbuild-loader webpack --watch",
+    "build": "webpack",
+    "build:dev": "NODE_ENV=development TYPESCRIPT_LOADER=esbuild-loader webpack",
+    "build:prd": "NODE_ENV=production webpack",
+    "test": "jest ts/tests"
+  },
+  "author": "Masashi Shibata",
+  "license": "MIT",
+  "dependencies": {
+    "@emotion/react": "^11.11.3",
+    "@emotion/styled": "^11.11.0",
+    "@mui/icons-material": "^5.15.6",
+    "@mui/lab": "^5.0.0-alpha.162",
+    "@mui/material": "^5.15.6",
+    "@react-three/drei": "^9.96.4",
+    "@react-three/fiber": "^8.15.15",
+    "@tanstack/react-virtual": "^3.1.2",
+    "@tanstack/react-query": "^5.18.1",
+    "@types/three": "^0.160.0",
+    "axios": "^1.6.7",
+    "elkjs": "^0.9.1",
+    "notistack": "^3.0.1",
+    "plotly.js-dist-min": "^2.28.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-markdown": "^9.0.1",
+    "react-router-dom": "^6.21.3",
+    "react-syntax-highlighter": "^15.5.0",
+    "reactflow": "^11.10.3",
+    "recoil": "^0.7.7",
+    "rehype-mathjax": "^6.0.0",
+    "rehype-raw": "^7.0.0",
+    "remark-gfm": "^4.0.0",
+    "remark-math": "^6.0.0",
+    "three": "^0.160.1",
+    "wavesurfer.js": "^7.7.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "@testing-library/react": "^14.1.2",
+    "@types/jest": "^29.5.11",
+    "@types/plotly.js": "^2.12.32",
+    "@types/react": "^18.2.48",
+    "@types/react-dom": "^18.2.18",
+    "@types/react-syntax-highlighter": "^15.5.11",
+    "compression-webpack-plugin": "^11.0.0",
+    "css-loader": "^6.9.1",
+    "esbuild-loader": "^4.0.3",
+    "jest": "^29.7.0",
+    "jest-canvas-mock": "^2.5.2",
+    "jest-environment-jsdom": "^29.7.0",
+    "style-loader": "^3.3.4",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.1",
+    "typescript": "^5.3.3",
+    "webpack": "^5.90.0",
+    "webpack-cli": "^5.1.4"
+  }
+}

optuna_dashboard/ts/hooks/useParamImportance.ts

@@ -1,6 +1,6 @@
 import { useEffect } from "react"
 import { useSnackbar } from "notistack"
-import { getParamImportances } from "../../ts/apiClient"
+import { getParamImportances } from "../apiClient"
 import { useQuery } from "@tanstack/react-query"
 import { AxiosError } from "axios"
 

optuna_dashboard/ts/tests/DataGrid.test.tsx

@@ -2,10 +2,7 @@ import React from "react"
 global.URL.createObjectURL = jest.fn()
 
 import { cleanup, render } from "@testing-library/react"
-import {
-  DataGrid,
-  DataGridColumn,
-} from "../optuna_dashboard/ts/components/DataGrid"
+import { DataGrid, DataGridColumn } from "../components/DataGrid"
 
 afterEach(cleanup)
 

optuna_dashboard/ts/tests/searchSpace.test.ts

@@ -1,4 +1,4 @@
-import { mergeUnionSearchSpace } from "../optuna_dashboard/ts/searchSpace"
+import { mergeUnionSearchSpace } from "../searchSpace"
 
 global.URL.createObjectURL = jest.fn()
 

optuna_dashboard/tsconfig.json

@@ -6,7 +6,7 @@
     "noUnusedLocals": true,
     "noImplicitThis": true,
     "alwaysStrict": true,
-    "outDir": "./optuna_dashboard/public/",
+    "outDir": "./public/",
     "paths": {
       "plotly.js-dist-min": ["node_modules/@types/plotly.js"]
     },
@@ -21,11 +21,11 @@
     "strict": true
   },
   "files": [
-    "./optuna_dashboard/ts/index.tsx"
+    "./ts/index.tsx"
   ],
   "include": [
-    "./optuna_dashboard/ts/types/**/*",
-    "./typescript_tests/**/*"
+    "./ts/types/**/*",
+    "./ts/tests/**/*"
   ],
   "types": ["node"]
 }

optuna_dashboard/webpack.config.js

@@ -28,9 +28,9 @@ const typeScriptLoader =
 
 var config = {
   mode,
-  entry: [__dirname + "/optuna_dashboard/ts/index.tsx"],
+  entry: [__dirname + "/ts/index.tsx"],
   output: {
-    path: __dirname + "/optuna_dashboard/public/",
+    path: __dirname + "/public/",
     filename: "bundle.js",
     publicPath: "/public/",
   },

package.json

@@ -1,75 +1,14 @@
 {
-  "name": "optuna-dashboard",
-  "private": true,
-  "version": "0.0.1",
-  "description": "Dashboard for Optuna",
-  "main": "index.js",
   "scripts": {
     "fmt": "biome format --write . && biome check standalone_app vscode --apply",
     "lint": "npm run lint:eslint && npm run lint:biome",
     "lint:eslint": "eslint . --ext .ts,.tsx --max-warnings 0",
-    "lint:biome": "biome format . && biome ci standalone_app vscode",
-    "watch": "NODE_ENV=development TYPESCRIPT_LOADER=esbuild-loader webpack --watch",
-    "build": "webpack",
-    "build:dev": "NODE_ENV=development TYPESCRIPT_LOADER=esbuild-loader webpack",
-    "build:prd": "NODE_ENV=production webpack",
-    "test": "jest typescript_tests"
-  },
-  "author": "Masashi Shibata",
-  "license": "MIT",
-  "dependencies": {
-    "@emotion/react": "^11.11.3",
-    "@emotion/styled": "^11.11.0",
-    "@mui/icons-material": "^5.15.6",
-    "@mui/lab": "^5.0.0-alpha.162",
-    "@mui/material": "^5.15.6",
-    "@react-three/drei": "^9.96.4",
-    "@react-three/fiber": "^8.15.15",
-    "@tanstack/react-virtual": "^3.1.2",
-    "@tanstack/react-query": "^5.18.1",
-    "@types/three": "^0.160.0",
-    "axios": "^1.6.7",
-    "elkjs": "^0.9.1",
-    "notistack": "^3.0.1",
-    "plotly.js-dist-min": "^2.28.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-markdown": "^9.0.1",
-    "react-router-dom": "^6.21.3",
-    "react-syntax-highlighter": "^15.5.0",
-    "reactflow": "^11.10.3",
-    "recoil": "^0.7.7",
-    "rehype-mathjax": "^6.0.0",
-    "rehype-raw": "^7.0.0",
-    "remark-gfm": "^4.0.0",
-    "remark-math": "^6.0.0",
-    "three": "^0.160.1",
-    "wavesurfer.js": "^7.7.0"
+    "lint:biome": "biome format . && biome ci standalone_app vscode"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.9",
-    "@babel/preset-env": "^7.23.9",
     "@biomejs/biome": "1.5.3",
-    "@testing-library/react": "^14.1.2",
-    "@types/jest": "^29.5.11",
-    "@types/plotly.js": "^2.12.32",
-    "@types/react": "^18.2.48",
-    "@types/react-dom": "^18.2.18",
-    "@types/react-syntax-highlighter": "^15.5.11",
     "@typescript-eslint/eslint-plugin": "^6.19.1",
     "@typescript-eslint/parser": "^6.19.1",
-    "compression-webpack-plugin": "^11.0.0",
-    "css-loader": "^6.9.1",
-    "esbuild-loader": "^4.0.3",
-    "eslint": "^8.56.0",
-    "jest": "^29.7.0",
-    "jest-canvas-mock": "^2.5.2",
-    "jest-environment-jsdom": "^29.7.0",
-    "style-loader": "^3.3.4",
-    "ts-jest": "^29.1.2",
-    "ts-loader": "^9.5.1",
-    "typescript": "^5.3.3",
-    "webpack": "^5.90.0",
-    "webpack-cli": "^5.1.4"
+    "eslint": "^8.56.0"
   }
 }

pyproject.toml

@@ -75,6 +75,7 @@ package-data = { "optuna_dashboard" = ["public/*", "img/*", "index.html"] }
 
 [tool.setuptools.packages.find]
 include = ["optuna_dashboard*"]
+exclude = ["optuna_dashboard.node_modules*", "optuna_dashboard.ts*"]
 
 [project.urls]
 "Homepage" = "https://github.com/optuna/optuna-dashboard"