remove npm workspaces + use published utils package (#53)

severo · web-flow · commit 8cd859a3a36f · 2024-11-20T22:06:49.000+01:00
* remove npm workspaces + use published utils package

* fix CI

* fix CI

* transform to a commonjs module

* fix

* fix ci

* add missing dev dependency (it was installed globally when using workspaces)

* install react + depend on published package, not relative one
diff --git a/.github/workflows/ci_apps_cli.yml b/.github/workflows/ci_apps_cli.yml
@@ -3,9 +3,9 @@ on:
   push:
     paths:
       - 'packages/components/**'
-      - 'packages/utils/**'
       - 'apps/cli/**'
       - '.github/workflows/ci_apps_cli.yml'
+      - 'shared.eslint.config.js'
 
 defaults:
   run:
@@ -17,49 +17,41 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
-      - run: npm run build
+      - run: |
+          npm i
+          npm run build
         working-directory: ./packages/components
       - run: npm run lint
 
   typecheck:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
-      - run: npm run build
+      - run: |
+          npm i
+          npm run build
         working-directory: ./packages/components
       - run: tsc
-        working-directory: ./apps/cli
 
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
-      - run: npm run build
+      - run: |
+          npm i
+          npm run build
         working-directory: ./packages/components
       - run: npm run coverage
 
   buildcheck:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
-      - run: npm run build
+      - run: |
+          npm i
+          npm run build
         working-directory: ./packages/components
       - run: npm run build
-        working-directory: ./apps/cli
diff --git a/.github/workflows/ci_apps_hightable_demo.yml b/.github/workflows/ci_apps_hightable_demo.yml
@@ -4,6 +4,7 @@ on:
     paths:
       - 'apps/hightable-demo/**'
       - '.github/workflows/ci_apps_hightable_demo.yml'
+      - 'shared.eslint.config.js'
 
 defaults:
   run:
diff --git a/.github/workflows/ci_apps_hyparquet_demo.yml b/.github/workflows/ci_apps_hyparquet_demo.yml
@@ -2,9 +2,9 @@ name: apps/hyparquet-demo
 on:
   push:
     paths:
-      - 'packages/utils/**'
       - 'apps/hyparquet-demo/**'
       - '.github/workflows/ci_apps_hyparquet_demo.yml'
+      - 'shared.eslint.config.js'
 
 defaults:
   run:
@@ -16,33 +16,25 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: npm run lint
 
   typecheck:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: tsc
 
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: npm run coverage
 
   buildcheck:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: npm run build
diff --git a/.github/workflows/ci_packages_components.yml b/.github/workflows/ci_packages_components.yml
@@ -3,8 +3,8 @@ on:
   push:
     paths:
       - 'packages/components/**'
-      - 'packages/utils/**'
       - '.github/workflows/ci_packages_components.yml'
+      - 'shared.eslint.config.js'
 
 defaults:
   run:
@@ -16,26 +16,20 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: npm run lint
 
   typecheck:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: tsc
 
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - run: npm i
-      - run: npm run build
-        working-directory: ./packages/utils
       - run: npm run coverage
 
   buildcheck:
@@ -44,5 +38,3 @@ jobs:
       - uses: actions/checkout@v4
       - run: npm i
       - run: npm run build
-        working-directory: ./packages/utils
-      - run: npm run build
diff --git a/.github/workflows/ci_packages_utils.yml b/.github/workflows/ci_packages_utils.yml
@@ -4,6 +4,7 @@ on:
     paths:
       - 'packages/utils/**'
       - '.github/workflows/ci_packages_utils.yml'
+      - 'shared.eslint.config.js'
 
 defaults:
   run:
diff --git a/.github/workflows/deploy_pages.yml b/.github/workflows/deploy_pages.yml
@@ -17,21 +17,16 @@ jobs:
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v4
-      - name: Install dependencies
-        run: npm i
-      - name: Build @hyparam/utils package
-        run: npm run build
-        working-directory: ./packages/utils
       - name: Build hyparquet demo
-        run: npm run build
+        run: |
+          npm i
+          npm run build
         working-directory: ./apps/hyparquet-demo
       - name: Build hightable demo
-        run: npm run build
-        working-directory: ./apps/hightable-demo
-      - name: Create index file content
         run: |
-
-        id: index_content
+          npm i
+          npm run build
+        working-directory: ./apps/hightable-demo
       - name: Move the build outputs to a folder
         run: |
           mkdir -p build_outputs_folder/apps
diff --git a/README.md b/README.md
@@ -10,3 +10,9 @@ It also contains the following applications:
 - [`hyperparam`](./apps/cli): a cli tool for viewing arbitrarily large datasets in the browser.
 - [`hightable-demo`](./apps/hightable-demo): an example project showing how to use [hightable](https://github.com/hyparam/hightable).
 - [`hyparquet-demo`](./apps/hyparquet-demo): an example project showing how to use [hyparquet](https://github.com/hyparam/hyparquet).
+
+## Development
+
+The dependencies between the packages and applications of this monorepo are pinned, and the packages are published to npm. It means that the changes in a dependency are not automatically reflected in the dependent package or application.
+
+To make the development easier, you can locally replace the npm dependencies with the local packages, replacing the pinned versions (eg `"@hyparam/utils": "0.1.0",`) with a relative path (`"@hyparam/utils": "file:../../packages/utils",`). It's not ideal, we might switch to pnpm or yarn workspaces in the future.
diff --git a/apps/cli/eslint.config.js b/apps/cli/eslint.config.js
@@ -1,7 +1,8 @@
 import javascript from '@eslint/js'
 import globals from 'globals'
 import typescript from 'typescript-eslint'
-import { sharedJsRules } from '../../shared.eslint.config.js'
+import sharedEslintRules from '../../shared.eslint.config.js'
+const { sharedJsRules } = sharedEslintRules
 
 export default [
   {
diff --git a/apps/cli/package.json b/apps/cli/package.json
@@ -23,7 +23,9 @@
   },
   "dependencies": {
     "highlight.js": "11.10.0",
-    "@hyparam/components": "file:../../packages/components"
+    "@hyparam/components": "0.1.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "28.0.1",
diff --git a/apps/cli/public/build/app.min.js b/apps/cli/public/build/app.min.js
diff --git a/apps/cli/public/build/app.min.js.map b/apps/cli/public/build/app.min.js.map
diff --git a/apps/hightable-demo/eslint.config.js b/apps/hightable-demo/eslint.config.js
@@ -4,7 +4,8 @@ import reactHooks from 'eslint-plugin-react-hooks'
 import reactRefresh from 'eslint-plugin-react-refresh'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
-import { sharedJsRules, sharedTsRules } from '../../shared.eslint.config.js'
+import sharedEslintRules from '../../shared.eslint.config.js'
+const { sharedJsRules, sharedTsRules } = sharedEslintRules
 
 export default tseslint.config(
   { ignores: ['dist'] },
diff --git a/apps/hyparquet-demo/eslint.config.js b/apps/hyparquet-demo/eslint.config.js
@@ -4,7 +4,8 @@ import reactHooks from 'eslint-plugin-react-hooks'
 import reactRefresh from 'eslint-plugin-react-refresh'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
-import { sharedJsRules, sharedTsRules } from '../../shared.eslint.config.js'
+import sharedEslintRules from '../../shared.eslint.config.js'
+const { sharedJsRules, sharedTsRules } = sharedEslintRules
 
 export default tseslint.config(
   { ignores: ['dist'] },
diff --git a/apps/hyparquet-demo/package.json b/apps/hyparquet-demo/package.json
@@ -13,7 +13,7 @@
     "test": "vitest run --dir test"
   },
   "dependencies": {
-    "@hyparam/utils": "file:../../packages/utils",
+    "@hyparam/utils": "0.1.0",
     "hyparquet": "1.5.0",
     "hyparquet-compressors": "0.1.4",
     "hightable": "0.7.0",
diff --git a/package.json b/package.json
diff --git a/packages/components/eslint.config.js b/packages/components/eslint.config.js
@@ -4,7 +4,8 @@ import reactHooks from 'eslint-plugin-react-hooks'
 import reactRefresh from 'eslint-plugin-react-refresh'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
-import { sharedJsRules, sharedTsRules } from '../../shared.eslint.config.js'
+import sharedEslintRules from '../../shared.eslint.config.js'
+const { sharedJsRules, sharedTsRules } = sharedEslintRules
 
 export default tseslint.config(
   { ignores: ['coverage/', 'dist/', 'es/'] },
diff --git a/packages/components/package.json b/packages/components/package.json
@@ -38,7 +38,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@hyparam/utils": "file:../utils",
+    "@hyparam/utils": "0.1.0",
     "hightable": "0.6.3",
     "hyparquet": "1.5.0",
     "hyparquet-compressors": "0.1.4"
@@ -60,6 +60,7 @@
     "eslint-plugin-react-hooks": "5.0.0",
     "eslint-plugin-react-refresh": "0.4.14",
     "globals": "15.11.0",
+    "jsdom": "25.0.1",
     "typescript": "5.6.3",
     "typescript-eslint": "8.13.0",
     "vite": "5.4.10",
diff --git a/packages/utils/eslint.config.js b/packages/utils/eslint.config.js
@@ -1,7 +1,8 @@
 import js from '@eslint/js'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
-import { sharedJsRules, sharedTsRules } from '../../shared.eslint.config.js'
+import sharedEslintRules from '../../shared.eslint.config.js'
+const { sharedJsRules, sharedTsRules } = sharedEslintRules
 
 export default tseslint.config(
   { ignores: ['coverage/', 'dist/', 'es/'] },
diff --git a/shared.eslint.config.js b/shared.eslint.config.js
@@ -1,4 +1,4 @@
-export const sharedJsRules = {
+const sharedJsRules = {
   'arrow-spacing': 'error',
   camelcase: 'off',
   'comma-spacing': 'error',
@@ -36,7 +36,9 @@ export const sharedJsRules = {
   'space-infix-ops': 'error',
 }
 
-export const sharedTsRules = {
+const sharedTsRules = {
   '@typescript-eslint/restrict-template-expressions': 'off',
   '@typescript-eslint/no-unused-vars': 'warn',
 }
+
+module.exports = { sharedJsRules, sharedTsRules }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`import javascript from '@eslint/js'`
`2`	`2`	`import globals from 'globals'`
`3`	`3`	`import typescript from 'typescript-eslint'`
`4`		`-import { sharedJsRules } from '../../shared.eslint.config.js'`
	`4`	`+import sharedEslintRules from '../../shared.eslint.config.js'`
	`5`	`+const { sharedJsRules } = sharedEslintRules`
`5`	`6`
`6`	`7`	`export default [`
`7`	`8`	`{`