chore: Rename frontend folder to skore-ui (#439)

part of #345

Author: rouk1

.github/workflows/backend.yml

@@ -3,30 +3,30 @@ name: Reusable backend workflow
 on: [workflow_call]
 
 jobs:
-  build-frontend:
+  build-skore-ui:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: 'npm'
-          cache-dependency-path: frontend/package-lock.json
+          cache-dependency-path: skore-ui/package-lock.json
       - shell: bash
         run: |
-          cd frontend
+          cd skore-ui
 
           npm install
           npm run build
           npm run build:lib -- --emptyOutDir false
       - uses: actions/upload-artifact@v4
         with:
-          name: frontend-package-distributions
-          path: frontend/dist
+          name: skore-ui-package-distributions
+          path: skore-ui/dist
 
   test-backend:
     runs-on: ubuntu-latest
-    needs: build-frontend
+    needs: build-skore-ui
     strategy:
       fail-fast: true
       matrix:
@@ -48,7 +48,7 @@ jobs:
       - name: Download package distributions
         uses: actions/download-artifact@v4
         with:
-          name: frontend-package-distributions
+          name: skore-ui-package-distributions
           path: src/skore/ui/static
 
       - name: Build
@@ -72,4 +72,4 @@ jobs:
     steps:
       - uses: geekyeggo/delete-artifact@v5
         with:
-          name: frontend-package-distributions
+          name: skore-ui-package-distributions

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       backend: ${{ steps.filter.outputs.backend }}
-      frontend: ${{ steps.filter.outputs.frontend }}
+      skore-ui: ${{ steps.filter.outputs.skore-ui }}
     permissions:
       pull-requests: read
     steps:
@@ -21,9 +21,9 @@ jobs:
               - 'pyproject.toml'
               - 'requirements*.txt'
               - '.github/workflows/backend.yml'
-            frontend:
-              - 'frontend/**'
-              - '.github/workflows/frontend.yml'
+            skore-ui:
+              - 'skore-ui/**'
+              - '.github/workflows/skore-ui.yml'
 
   lint-all-files:
     uses: ./.github/workflows/lint.yml
@@ -37,10 +37,10 @@ jobs:
     permissions:
       contents: read
 
-  lint-and-test-frontend:
+  lint-and-test-skore-ui:
     needs: [lint-all-files, changes]
-    if: ${{ needs.changes.outputs.frontend == 'true' }}
-    uses: ./.github/workflows/frontend.yml
+    if: ${{ needs.changes.outputs.skore-ui == 'true' }}
+    uses: ./.github/workflows/skore-ui.yml
     permissions:
       contents: read
       pull-requests: write
@@ -49,7 +49,7 @@ jobs:
     needs:
       - lint-all-files
       - lint-and-test-backend
-      - lint-and-test-frontend
+      - lint-and-test-skore-ui
     if: ${{ always() }}
     runs-on: Ubuntu-latest
     steps:

.github/workflows/release.yml

@@ -31,9 +31,9 @@ jobs:
         with:
           node-version: 20
 
-      - name: Build frontend and share library
+      - name: Build skore-ui and share library
         shell: bash
-        run: make build-frontend
+        run: make build-skore-ui
 
       - name: Override VERSION.txt with tag
         run: echo "${GITHUB_REF_NAME}" > VERSION.txt

.github/workflows/frontend.yml renamed to .github/workflows/skore-ui.yml

@@ -1,64 +1,64 @@
-name: Reusable frontend workflow
+name: Reusable skore-ui workflow
 
 on: [workflow_call]
 
 jobs:
-  lint-frontend:
+  lint-skore-ui:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: 'npm'
-          cache-dependency-path: frontend/package-lock.json
-      - name: Lint frontend
+          cache-dependency-path: skore-ui/package-lock.json
+      - name: Lint skore-ui
         run: |
-          cd frontend
+          cd skore-ui
 
           npm install
           npm run type-check
           npm run lint
           npm run format
           npm run style-lint
 
-  test-frontend:
+  test-skore-ui:
     runs-on: ubuntu-latest
-    needs: lint-frontend
+    needs: lint-skore-ui
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: 'npm'
-          cache-dependency-path: frontend/package-lock.json
-      - name: Test frontend
+          cache-dependency-path: skore-ui/package-lock.json
+      - name: Test skore-ui
         run: |
-          cd frontend
+          cd skore-ui
 
           npm install
           npm run test:unit:coverage
       - name: Report coverage
         if: always()
         uses: davelosert/vitest-coverage-report-action@v2
         with:
-          working-directory: ./frontend
+          working-directory: ./skore-ui
           pr-number: ${{ github.event.number }}
 
-  build-frontend:
+  build-skore-ui:
     runs-on: ubuntu-latest
-    needs: test-frontend
+    needs: test-skore-ui
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: 'npm'
-          cache-dependency-path: frontend/package-lock.json
-      - name: Build frontend
+          cache-dependency-path: skore-ui/package-lock.json
+      - name: Build skore-ui
         shell: bash
         run: |
-          cd frontend
+          cd skore-ui
 
           npm install
           npm run build

.pre-commit-config.yaml

@@ -28,23 +28,23 @@ repos:
     hooks:
       - id: tsc
         language: node
-        name: Use vue-tsc to typecheck frontend code.
-        entry: bash -c "cd frontend && npm run type-check"
-        files: ^frontend/
+        name: Use vue-tsc to typecheck skore-ui code.
+        entry: bash -c "cd skore-ui && npm run type-check"
+        files: ^skore-ui/
       - id: eslint
         language: node
-        name: Use eslint to lint frontend code.
-        entry: bash -c "cd frontend && npm run lint"
-        files: ^frontend/
+        name: Use eslint to lint skore-ui code.
+        entry: bash -c "cd skore-ui && npm run lint"
+        files: ^skore-ui/
       - id: prettier
         language: node
-        name: Use prettier to format frontend code.
-        entry: bash -c "cd frontend && npm run format"
-        files: ^frontend/
+        name: Use prettier to format skore-ui code.
+        entry: bash -c "cd skore-ui && npm run format"
+        files: ^skore-ui/
       - id: stylelint
         language: node
         name: Use stylelint to lint CSS.
-        entry: bash -c "cd frontend && npm run style-lint"
-        files: ^frontend/
+        entry: bash -c "cd skore-ui && npm run style-lint"
+        files: ^skore-ui/
 
 exclude: fixtures/

CONTRIBUTING.md

@@ -33,16 +33,16 @@ serve-ui:
 		--port 22140 \
 		--timeout-graceful-shutdown 0
 
-build-frontend:
+build-skore-ui:
 	# cleanup
-	rm -rf frontend/dist
+	rm -rf skore-ui/dist
 	rm -rf src/skore/ui/static
 	# build
 	(\
-		cd frontend;\
+		cd skore-ui;\
 		npm install;\
 		npm run build;\
 		npm run build:lib -- --emptyOutDir false;\
 	)
 	# move
-	mv frontend/dist/ src/skore/ui/static
+	mv skore-ui/dist/ src/skore/ui/static