Add spelling and docstring enforcement (#1147)

Author: blink1073

.github/workflows/python-tests.yml

@@ -57,6 +57,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install enchant-2  # for spell checking
       - run: hatch run docs:build
 
   test_lint:
@@ -69,7 +73,7 @@ jobs:
          run: |
           hatch run typing:test
           hatch run lint:style
-          pipx run 'validate-pyproject[all]' pyproject.toml
+          pipx run interrogate -v .
           pipx run doc8 --max-line-length=200  --ignore-path=docs/source/other/full-config.rst
           npm install -g eslint
           eslint .

.pre-commit-config.yaml

@@ -5,17 +5,18 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
-      - id: end-of-file-fixer
       - id: check-case-conflict
+      - id: check-ast
+      - id: check-docstring-first
       - id: check-executables-have-shebangs
-      - id: requirements-txt-fixer
       - id: check-added-large-files
       - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-json
       - id: check-toml
       - id: check-yaml
       - id: debug-statements
-      - id: forbid-new-submodules
-      - id: check-builtin-literals
+      - id: end-of-file-fixer
       - id: trailing-whitespace
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
@@ -29,12 +30,12 @@ repos:
       - id: mdformat
 
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 22.12.0
     hooks:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.177
+    rev: v0.0.194
     hooks:
       - id: ruff
         args: ["--fix"]

docs/source/conf.py

@@ -84,6 +84,13 @@
     "sphinxemoji.sphinxemoji",
 ]
 
+try:
+    import enchant  # type:ignore  # noqa
+
+    extensions += ["sphinxcontrib.spelling"]
+except ImportError:
+    pass
+
 myst_enable_extensions = ["html_image"]
 
 # Add any paths that contain templates here, relative to this directory.

examples/authorization/jupyter_nbclassic_readonly_config.py

@@ -1,3 +1,4 @@
+"""Nbclassic read only auth example."""
 from jupyter_server.auth import Authorizer
 
 

examples/authorization/jupyter_nbclassic_rw_config.py

@@ -1,3 +1,4 @@
+"""Nbclassic read/write auth example."""
 from jupyter_server.auth import Authorizer
 
 

examples/authorization/jupyter_temporary_config.py

@@ -1,3 +1,4 @@
+"""Nbclassic temporary server auth example."""
 from jupyter_server.auth import Authorizer
 
 

examples/identity/system_password/jupyter_server_config.py

@@ -1,3 +1,4 @@
+"""Jupyter server system password identity provider example."""
 import pwd
 from getpass import getuser
 
@@ -7,10 +8,13 @@
 
 
 class SystemPasswordIdentityProvider(IdentityProvider):
+    """A system password identity provider."""
+
     # no need to generate a default token (token can still be used, but it's opt-in)
     need_token = False
 
     def process_login_form(self, handler):
+        """Process a login form."""
         username = getuser()
         password = handler.get_argument("password", "")
         try:

examples/simple/conftest.py

@@ -1 +1,2 @@
+"""Pytest configurtion."""
 pytest_plugins = ["jupyter_server.pytest_plugin"]

examples/simple/jupyter_server_config.py

@@ -1,4 +1,4 @@
-# Configuration file for jupyter-server extensions.
+"""Configuration file for jupyter-server extensions."""
 # ------------------------------------------------------------------------------
 # Application(SingletonConfigurable) configuration
 # ------------------------------------------------------------------------------

examples/simple/jupyter_simple_ext11_config.py

@@ -1 +1,2 @@
+"""Jupyter server config."""
 c.SimpleApp11.ignore_js = True  # type:ignore[name-defined]