Add initial pre-commit (#256)

Author: blink1073

.pre-commit-config.yaml

@@ -0,0 +1,69 @@
+ci:
+  skip: [check-jsonschema]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: forbid-new-submodules
+      - id: check-builtin-literals
+      # - id: trailing-whitespace
+
+  # - repo: https://github.com/psf/black
+  #   rev: 22.3.0
+  #   hooks:
+  #     - id: black
+  #       args: ["--line-length", "100"]
+
+  # - repo: https://github.com/PyCQA/isort
+  #   rev: 5.10.1
+  #   hooks:
+  #     - id: isort
+  #       files: \.py$
+  #       args: [--profile=black]
+
+  # - repo: https://github.com/pre-commit/mirrors-prettier
+  #   rev: v2.6.1
+  #   hooks:
+  #     - id: prettier
+
+  # - repo: https://github.com/asottile/pyupgrade
+  #   rev: v2.31.1
+  #   hooks:
+  #     - id: pyupgrade
+  #       args: [--py37-plus]
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: 0.11.0
+    hooks:
+      - id: doc8
+        args: [--max-line-length=200]
+
+  # - repo: https://github.com/pycqa/flake8
+  #   rev: 4.0.1
+  #   hooks:
+  #     - id: flake8
+  #       additional_dependencies:
+  #         [
+  #           "flake8-bugbear==20.1.4",
+  #           "flake8-logging-format==0.6.0",
+  #           "flake8-implicit-str-concat==0.2.0",
+  #         ]
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.14.1
+    hooks:
+      - id: check-jsonschema
+        name: "Check GitHub Workflows"
+        files: ^\.github/workflows/
+        types: [yaml]
+        args: ["--schemafile", "https://json.schemastore.org/github-workflow"]

CONTRIBUTING.md

@@ -1,20 +1,63 @@
-# Development Install
+# Contributing
+
+If you're reading this section, you're probably interested in contributing to
+Jupyter.  Welcome and thanks for your interest in contributing!
+
+Please take a look at the Contributor documentation, familiarize yourself with
+using the Jupyter Server, and introduce yourself on the mailing list and
+share what area of the project you are interested in working on.
+
+For general documentation about contributing to Jupyter projects, see the
+[Project Jupyter Contributor Documentation](https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html).
+
+## Development Install
 
 ``` shell
 git clone https://github.com/jupyterlab/jupyterlab_server.git
 cd jupyterlab_server
 pip install -e .
 ```
 
-# Testing
+## Testing
 
 It is probably best to create a virtual environment to create a local test setup. There are multiple tools for creating a Python virtual environment out there from which you can choose the one you like best.
 
 To create a local test setup run the following commands (inside your virtual environment, if you chose to create one):
 
-``` shell
+```shell
 git clone https://github.com/jupyterlab/jupyterlab_server.git
 cd jupyterlab_server
 pip install -e .[test]  # install test dependencies
 pytest --pyargs jupyterlab_server
 ```
+
+## Code Styling
+`jupyterlab_server` has adopted automatic code formatting so you shouldn't
+need to worry too much about your code style.
+As long as your code is valid,
+the pre-commit hook should take care of how it should look.
+`pre-commit` and its associated hooks will automatically be installed when
+you run `pip install -e ".[test]"`
+
+To install `pre-commit` manually, run the following::
+
+```shell
+pip install pre-commit
+pre-commit install
+```
+
+You can invoke the pre-commit hook by hand at any time with:
+
+```shell
+pre-commit run
+````
+
+which should run any autoformatting on your code
+and tell you about any errors it couldn't fix automatically.
+You may also install [black integration](https://github.com/psf/black#editor-integration)
+into your text editor to format code automatically.
+
+If you have already committed files before setting up the pre-commit
+hook with `pre-commit install`, you can fix everything up using
+`pre-commit run --all-files`. You need to make the fixing commit
+yourself after that.

jupyterlab_server/config.py

@@ -39,7 +39,7 @@ def get_package_url(data):
 def get_federated_extensions(labextensions_path):
     """Get the metadata about federated extensions
     """
-    federated_extensions = dict()
+    federated_extensions = {}
     for ext_dir in labextensions_path:
         # extensions are either top-level directories, or two-deep in @org directories
         for ext_path in chain(iglob(pjoin(ext_dir, '[!@]*', 'package.json')),
@@ -106,7 +106,7 @@ def get_page_config(labextensions_path, app_settings_dir=None, logger=None):
     recursive_update(page_config, static_page_config)
 
     # Handle federated extensions that disable other extensions
-    disabled_by_extensions_all = dict()
+    disabled_by_extensions_all = {}
     extensions = page_config['federated_extensions'] = []
 
     federated_exts = get_federated_extensions(labextensions_path)
@@ -153,7 +153,7 @@ def get_page_config(labextensions_path, app_settings_dir=None, logger=None):
                 if ext_data.get(disabled_key):
                     disabled_by_extensions_all[ext] = ext_data[disabled_key]
 
-    disabled_by_extensions = dict()
+    disabled_by_extensions = {}
     for name in sorted(disabled_by_extensions_all):
         # skip if the extension itself is disabled by other config
         if page_config[disabled_key].get(name) == True:

jupyterlab_server/handlers.py

@@ -286,4 +286,4 @@ def _create_process(self, **kwargs):
 
 
 # Register the cleanup handler.
-atexit.register(Process._cleanup)
+atexit.register(Process._cleanup)

jupyterlab_server/process.py

@@ -21,7 +21,7 @@ def get_command(self):
         """Get the command and kwargs to run with `Process`.
         This is intended to be overridden.
         """
-        return ['python', '--version'], dict()
+        return ['python', '--version'], {}
 
     def initialize_settings(self):
         """Start the application.