Auto server extension (#190)

* Server extension is auto enabled

* Use install to check extension availability

* Use tab instead of spaces

* Install node dependencies

* [DEBUG]

* Correct name

* Revert [DEBUG]

* Update installation.rst

Author: fcollonval

.github/workflows/ci.yml

@@ -44,7 +44,7 @@ jobs:
     - name: Install plugin
       shell: bash -l {0}
       run: |
-        source ./start_env.sh && make dev-install
+        source ./start_env.sh && make install
 
     - name: Run linters
       shell: bash -l {0}

Makefile

@@ -35,9 +35,14 @@ format:  # Run formatters
 	find jupyterlab_code_formatter -name '*.py' | xargs black
 	npm run format
 
+install:
+	jlpm install
+	python -m pip install .
+
 test:  # Run test
-	cd $(SERVEREXTENSION_PATH)
-	pytest
+	pytest $(SERVEREXTENSION_PATH)
+	jupyter server extension list 2>&1 | grep -ie "jupyterlab_code_formatter.*OK"
+	jupyter labextension list 2>&1 | grep -ie "@ryantam626/jupyterlab_code_formatter.*OK"
 	python -m jupyterlab.browser_check
 
 publish:  # Publish

docs/installation.rst

@@ -14,9 +14,6 @@ Prerequisites
 Installation Step 1 (Installing the plugin itself)
 --------------------------------------------------
 
-1.1 Installing the extension
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 With Pip:
 
 .. code-block:: bash
@@ -28,30 +25,15 @@ With Conda:
 .. code-block:: bash
 
     conda install -c conda-forge jupyterlab_code_formatter
-    
-1.2 Enabling the Extension
-~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If you are using JupyterLab >= 3.0.0
-
-.. code-block:: bash
-    
-    jupyter server extension enable jupyterlab_code_formatter
-    # if you installed the plugin with pip and using --user, you need to add it here as well
-    jupyter server extension enable --user jupyterlab_code_formatter
-    
-...Or if you are still using JupyterLab < 3.0.0
+For users still using JupyterLab < 3.0.0, you will also need to run:
 
 .. code-block:: bash
     
     jupyter serverextension enable --py jupyterlab_code_formatter
+    jupyter labextension install @ryantam626/jupyterlab_code_formatter
 
 
-.. important::
-    You will also need to install a code formatter for this plugin to work. The default formatter for Python are :code:`isort` and :code:`black`, and :code:`formatR` for R. Installing these would be a good place to start.
-
-Also for users that haven't upgraded JupyterLab to version 3.0.0+, you will also need to run :code:`jupyter labextension install @ryantam626/jupyterlab_code_formatter`.
-
 Installation Step 2 (Installing a supported code formatter)
 -----------------------------------------------------------
 

jupyter-config/jupyterlab-code-formatter.json renamed to jupyter-config/jupyterlab_code_formatter.json

@@ -1,7 +1,7 @@
 {
   "ServerApp": {
     "jpserver_extensions": {
-      "jupyterlab-code-formatter": true
+      "jupyterlab_code_formatter": true
     }
   }
 }