Migrate to hatch (#52)

* Migrate to `hatch`

* Update `check-release` workflow

* Update `build.yml`

* Remove `environment.yml`

* Use `jupyterlab-filesystem-access` in some places

* Remove lint workflow

Author: jtpio

environment.yml renamed to .binder/environment.yml

@@ -2,9 +2,7 @@ name: jupyterlab-filesystem-access
 channels:
   - conda-forge
 dependencies:
-  - jupyterlab
-  - yarn
-  - jupyter-packaging
-  - build
-  - check-manifest
+  - python=3.10
+  - jupyterlab >=3,<4.0.0a0
+  - nodejs >=18,<19
   - pip

.binder/postBuild

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -euo pipefail
+
+python -m pip install .

.eslintignore

@@ -3,3 +3,6 @@ dist
 coverage
 **/*.d.ts
 tests
+
+**/__tests__
+ui-tests

.github/workflows/build.yml

@@ -2,64 +2,89 @@ name: Build
 
 on:
   push:
-    branches:
-      - main
+    branches: main
   pull_request:
     branches: '*'
 
-defaults:
-  run:
-    shell: bash -l {0}
-
 jobs:
   build:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest]
+    runs-on: ubuntu-latest
+
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
-    - name: Install Conda environment from environment.yml
-      uses: mamba-org/provision-with-micromamba@main
+    - name: Base Setup
+      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+    - name: Install dependencies
+      run: python -m pip install -U jupyterlab~=3.1
+
+    - name: Lint the extension
+      run: |
+        set -eux
+        jlpm
+        jlpm run lint:check
 
     - name: Build the extension
       run: |
-        python -m pip install .
+        set -eux
+        python -m pip install .[test]
 
+        jupyter labextension list
         jupyter labextension list 2>&1 | grep -ie "jupyterlab-filesystem-access.*OK"
         python -m jupyterlab.browser_check
 
-        check-manifest -v
+    - name: Package the extension
+      run: |
+        set -eux
 
-        python -m build --sdist
-        cp dist/*.tar.gz jupyterlab-filesystem-access.tar.gz
+        pip install build
+        python -m build
         pip uninstall -y "jupyterlab_filesystem_access" jupyterlab
-        rm -rf jupyterlab-filesystem-access
 
-    - uses: actions/upload-artifact@v2
+    - name: Upload extension packages
+      uses: actions/upload-artifact@v3
       with:
-        name: jupyterlab-filesystem-access-sdist
-        path: jupyterlab-filesystem-access.tar.gz
+        name: extension-artifacts
+        path: dist/jupyterlab_filesystem_access*
+        if-no-files-found: error
 
   test_isolated:
     needs: build
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest]
+    runs-on: ubuntu-latest
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-    - name: Install Conda environment from environment.yml
-      uses: mamba-org/provision-with-micromamba@main
-    - uses: actions/download-artifact@v2
+      uses: actions/checkout@v3
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+        architecture: 'x64'
+    - uses: actions/download-artifact@v3
       with:
-        name: jupyterlab-filesystem-access-sdist
+        name: extension-artifacts
     - name: Install and Test
       run: |
-        pip install jupyterlab-filesystem-access.tar.gz
+        set -eux
+        # Remove NodeJS, twice to take care of system and locally installed node versions.
+        sudo rm -rf $(which node)
+        sudo rm -rf $(which node)
+
+        pip install "jupyterlab~=3.1" jupyterlab_filesystem_access*.whl
+
+
+        jupyter labextension list
         jupyter labextension list 2>&1 | grep -ie "jupyterlab-filesystem-access.*OK"
         python -m jupyterlab.browser_check --no-chrome-test
+
+
+  check_links:
+    name: Check Links
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1

.github/workflows/check-release.yml

@@ -1,63 +1,29 @@
 name: Check Release
 on:
   push:
-    branches:
-      - main
+    branches: ["main"]
   pull_request:
-    branches:
-      - main
-
-permissions:
-  contents: write
+    branches: ["*"]
 
 jobs:
   check_release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-          architecture: 'x64'
-      - name: Install node
-        uses: actions/setup-node@v2
-        with:
-          node-version: '14.x'
-
-
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      - name: Cache pip
-        uses: actions/cache@v1
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('package.json') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Cache checked links
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pytest-link-check
-          key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/.md') }}-md-links
-          restore-keys: |
-            ${{ runner.os }}-linkcheck-
-      - name: Upgrade packaging dependencies
-        run: |
-          pip install --upgrade pip setuptools wheel jupyter-packaging~=0.10 --user
+        uses: actions/checkout@v3
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install Dependencies
         run: |
-          pip install .
+          pip install -e .
       - name: Check Release
         uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
         with:
+
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Upload Distributions
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
-          name: jupyterlab_filesystem_access-releaser-dist-${{ github.run_number }}
+          name: jupyterlab-filesystem-access-releaser-dist-${{ github.run_number }}
           path: .jupyter_releaser_checkout/dist

.github/workflows/lint.yml

@@ -1,12 +1,19 @@
 *.bundle.*
 lib/
 node_modules/
+*.log
 .eslintcache
 .stylelintcache
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
 jupyterlab_filesystem_access/labextension
+# Version file is handled by hatchling
+jupyterlab_filesystem_access/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
@@ -58,6 +65,7 @@ htmlcov/
 .coverage.*
 .cache
 nosetests.xml
+coverage/
 coverage.xml
 *.cover
 .hypothesis/

.gitignore

@@ -2,4 +2,5 @@ node_modules
 **/node_modules
 **/lib
 **/package.json
+!/package.json
 jupyterlab_filesystem_access

.prettierignore

@@ -1,5 +1,6 @@
 {
   "singleQuote": true,
   "trailingComma": "none",
-  "arrowParens": "avoid"
+  "arrowParens": "avoid",
+  "endOfLine": "auto"
 }

.prettierrc

@@ -7,6 +7,6 @@
   "rules": {
     "property-no-vendor-prefix": null,
     "selector-no-vendor-prefix": null,
-    "value-no-vendor-prefix": null,
+    "value-no-vendor-prefix": null
   }
 }

.stylelintrc

@@ -42,7 +42,7 @@ pip install jupyterlab-filesystem-access
 To remove the extension, execute:
 
 ```bash
-pip uninstall jupyterlab_filesystem_access
+pip uninstall jupyterlab-filesystem-access
 ```
 
 ## Contributing
@@ -57,7 +57,7 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the jupyterlab_filesystem_access directory
+# Change directory to the jupyterlab-filesystem-access directory
 # Install package in development mode
 pip install -e .
 # Link your development version of the extension with JupyterLab
@@ -86,7 +86,7 @@ jupyter lab build --minimize=False
 ### Development uninstall
 
 ```bash
-pip uninstall jupyterlab_filesystem_access
+pip uninstall jupyterlab-filesystem-access
 ```
 
 In development mode, you will also need to remove the symlink created by `jupyter labextension develop`

MANIFEST.in

@@ -1,5 +1,5 @@
 {
   "packageManager": "python",
-  "packageName": "jupyterlab_filesystem_access",
+  "packageName": "jupyterlab-filesystem-access",
   "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab_filesystem_access"
 }

README.md

@@ -1,19 +1,9 @@
-import json
-from pathlib import Path
-
 from ._version import __version__
 
 
-HERE = Path(__file__).parent.resolve()
-
-
-with (HERE / "labextension" / "package.json").open() as fid:
-    data = json.load(fid)
-
-
 def _jupyter_labextension_paths():
     return [{
         "src": "labextension",
-        "dest": data["name"]
+        "dest": "jupyterlab-filesystem-access"
     }]