Merge pull request #12 from cindytsai/Frontend

Frontend

Author: cindytsai

.editorconfig

@@ -4,7 +4,7 @@ root = true
 
 [*]
 indent_style = space
-indent_size = 4
+indent_size = 2
 trim_trailing_whitespace = true
 insert_final_newline = true
 charset = utf-8

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,7 @@
-* jupyter_libyt version:
-* libyt version:
-* Python version:
-* Operating System:
+- jupyter_libyt version:
+- libyt version:
+- Python version:
+- Operating System:
 
 ### Summary
 
@@ -23,5 +23,3 @@ If there was a crash, please include the traceback here.
 ```
 
 #### Expected Outcome
-
-

.github/workflows/publish-to-pypi.yml

@@ -12,9 +12,9 @@ jobs:
 
   run_tests:
     name: Run Tests
-    uses: ./.github/workflows/build-test.yml
+    uses: ./.github/workflows/run-tests.yml
 
-  build_source:
+  build_pkg:
     name: Build Sources
     runs-on: ubuntu-latest
     needs:
@@ -29,18 +29,18 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install build
-      - name: Build source tarball
-        run: python -m build --sdist --outdir dist
-      - name: Upload source tarball
+      - name: Build source tarball and wheel
+        run: python -m build
+      - name: Upload source tarball and wheel
         uses: actions/upload-artifact@v4
         with:
-          path: ./dist/*.tar.gz
+          path: ./dist/jupyter_libyt*
 
   publish_to_pypi:
     name: Publish to PyPI
     if: startsWith(github.event.ref, 'refs/tags/v')
     needs:
-      - build_source
+      - build_pkg
     runs-on: ubuntu-latest
     steps:
       - name: Download source tarball and builds

.github/workflows/build-test.yml renamed to .github/workflows/run-tests.yml

@@ -66,3 +66,20 @@ jobs:
           python -m pip install tox
       - name: Run flake8
         run: tox -e lint
+
+  jlpm_lint:
+    name: jlpm stylelint, prettier, eslint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/[email protected]
+        with:
+          python-version: "3.10"
+          cache: 'pip'
+      - name: Install dependencies
+        run: python -m pip install -U "jupyterlab>=4.0.0,<5"
+      - name: Run jlpm style and lint
+        run: |
+          jlpm
+          jlpm run lint:check
+

.github/workflows/style-check.yml

@@ -108,3 +108,8 @@ ENV/
 report.html
 
 *.ipynb
+
+# JupyterLab extension development
+node_modules/
+.yarn/
+jupyter_libyt/labextension/

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+jupyter_libyt

.prettierignore

@@ -0,0 +1 @@
+nodeLinker: node-modules

.yarnrc.yml

@@ -1,3 +1,3 @@
 ## Contributors
 
-* Shin-Rong Tsai <[email protected]>
+- Shin-Rong Tsai <[email protected]>

AUTHORS.md

@@ -1,19 +1,20 @@
 # Contributing
 
 ## Report Bugs and Submit Feedback
+
 Report bugs at https://github.com/yt-project/jupyter_libyt/issues.
 
 If you are reporting a bug, please include:
 
-* Your operating system name and version.
-* Any details about your local setup that might be helpful in troubleshooting.
-* Detailed steps to reproduce the bug.
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
 
 If you are proposing a feature:
 
-* Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that contributions
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
 ## Setting Up Development Environment
@@ -22,67 +23,80 @@ If you are proposing a feature:
 
 1. Fork the `jupyter_libyt` repo on GitHub.
 2. Clone your fork locally:
-  ```bash
-  git clone https://github.com/<your-github-account>/jupyter_libyt.git
-  ```
+
+```bash
+git clone https://github.com/<your-github-account>/jupyter_libyt.git
+```
+
 3. Create a branch for local development:
-  ```bash
-  git checkout -b name-of-your-bugfix-or-feature
-  ```
+
+```bash
+git checkout -b name-of-your-bugfix-or-feature
+```
 
 ### Using `tox` to Test, Do Code-Formatting, and Linting
 
 We use [`tox`](https://tox.wiki/en/4.11.3/installation.html) to run:
-  - Python unit test ([`pytest`](https://docs.pytest.org/en/7.4.x/))
-  - Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
-  - Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
-  - Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
-  - Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
+
+- Python unit test ([`pytest`](https://docs.pytest.org/en/7.4.x/))
+- Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
+- Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
+- Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
+- Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
 
 #### Python Unit test
+
 ```bash
 tox
 ```
 
 #### Converting Old String to F-String
+
 ```bash
 tox -e fstring
 ```
 
 #### Code Formatting
+
 ```bash
 tox -e format
 ```
 
 #### Sort Import Order
+
 ```bash
 tox -e sort_import
 ```
 
 #### Linting
+
 ```bash
 tox -e lint
 ```
 
 ### Pre-Commit
 
 We use [pre-commit](https://pre-commit.com/#install) to check code format and style before committing:
-  - Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
-  - Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
-  - Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
-  - Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
+
+- Converting old string to f-string ([`flynt`](https://github.com/ikamensh/flynt#flynt---string-formatting-converter))
+- Code formatting ([`black`](https://black.readthedocs.io/en/stable/))
+- Sort import order ([`isort`](https://pycqa.github.io/isort/index.html))
+- Linting ([`flake8`](https://flake8.pycqa.org/en/latest/))
 
 Set up pre-commit for the first time:
+
 ```bash
 pre-commit install
 ```
 
 Check every file:
+
 ```bash
 pre-commit run --all-files
 ```
 
 Commit your changes and push your branch to GitHub, pre-commit will apply to staged files before committing:
+
 ```bash
 git add .
 git commit -m "Your detailed description of your changes."