Merge pull request #576 from bollwyvl/gh-575-avoid-private-cm

Use ICodeMirror, more type imports, order plugin for fixer

Author: krassowski

.github/workflows/job.test.yml

@@ -59,9 +59,8 @@ jobs:
             ${{ env.CACHE_EPOCH }}-${{ matrix.os }}-lint-
 
       - name: Set up Python and mamba
-        uses: conda-incubator/setup-miniconda@master
+        uses: conda-incubator/setup-miniconda@v2
         with:
-          condarc-file: .github/.condarc
           environment-file: requirements/github-actions.yml
           miniforge-variant: Mambaforge
           use-mamba: true
@@ -108,6 +107,9 @@ jobs:
       - name: Lint frontend
         run: jlpm lint:check
 
+      - name: Check distributions
+        run: python scripts/distcheck.py
+
   build:
     name: build
     runs-on: ${{ matrix.os }}
@@ -138,9 +140,8 @@ jobs:
             ${{ env.CACHE_EPOCH }}-${{ matrix.os }}-build-
 
       - name: Set up Python and mamba
-        uses: conda-incubator/setup-miniconda@master
+        uses: conda-incubator/setup-miniconda@v2
         with:
-          condarc-file: .github/.condarc
           miniforge-variant: Mambaforge
 
       - name: Install minimal build deps
@@ -253,9 +254,8 @@ jobs:
             ${{ env.CACHE_EPOCH }}-${{ matrix.os }}-${{ matrix.python }}-atest-
 
       - name: Set up Python and mamba
-        uses: conda-incubator/setup-miniconda@master
+        uses: conda-incubator/setup-miniconda@v2
         with:
-          condarc-file: .github/.condarc
           environment-file: requirements/github-actions.yml
           miniforge-variant: Mambaforge
           use-mamba: true

CHANGELOG.md

@@ -5,8 +5,10 @@
 - bug fixes:
 
   - fixes name of jupyterlab-lsp package displayed in JupyterLab UI ([#570])
+  - remove vendored CodeMirror from distribution ([#576])
 
 [#570]: https://github.com/krassowski/jupyterlab-lsp/pull/570
+[#576]: https://github.com/krassowski/jupyterlab-lsp/pull/576
 
 ### `@krassowski/jupyterlab-lsp 3.5.0` (2020-03-22)
 

CONTRIBUTING.md

@@ -126,6 +126,12 @@ To run tests matching specific phrase, forward `-t` argument over yarn and lerna
 jlpm test -- -- -t match_phrase
 ```
 
+To verify the webpack build wouldn't include problematic vendored dependencies:
+
+```bash
+python scripts/distcheck.py
+```
+
 ### Server Development
 
 #### Testing `jupyter-lsp`

package.json

@@ -25,8 +25,8 @@
     "vscode-css-languageserver-bin": "^1.4.0",
     "vscode-html-languageserver-bin": "^1.4.0",
     "vscode-json-languageserver-bin": "^1.0.1",
-    "yaml-language-server": "^0.12.0",
-    "vscode-json-languageservice": "^3.9.1 <3.10.0"
+    "vscode-json-languageservice": "^3.9.1 <3.10.0",
+    "yaml-language-server": "^0.12.0"
   },
   "husky": {
     "hooks": {}
@@ -38,7 +38,7 @@
   },
   "private": true,
   "scripts": {
-    "bootstrap": "jlpm --no-optional --prefer-offline && lerna bootstrap && jlpm lint && jlpm clean && jlpm build",
+    "bootstrap": "jlpm --no-optional --prefer-offline && lerna bootstrap && jlpm clean && jlpm build && jlpm lint",
     "build": "jlpm build:schema && jlpm build:meta && jlpm build:ws && jlpm build:labextension",
     "build:schema": "lerna run build:schema --stream",
     "build:meta": "lerna run build --stream --scope @krassowski/jupyterlab-lsp-metapackage",

packages/.eslintrc.js

@@ -10,6 +10,9 @@ module.exports = {
   root: true,
   extends: [
     'eslint:recommended',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'prettier/@typescript-eslint',
@@ -55,12 +58,32 @@ module.exports = {
     'no-undef': 'warn',
     'no-useless-escape': 'off',
     'prefer-const': 'off',
-    // deviations from jupyterlab, should not be changed
-    // a pitfall of enums is that they do not work correctly
-    // when circular dependencies are present
-    // (see https://stackoverflow.com/a/59665223/)
-    'import/no-cycle': 'error',
+    // the default, but for reference...
+    'import/order': [
+      'warn',
+      {
+        groups: [
+          'builtin',
+          'external',
+          'parent',
+          'sibling',
+          'index',
+          'object',
+          'unknown'
+        ],
+        pathGroups: [
+          { pattern: 'react/**', group: 'builtin', order: 'after' },
+          { pattern: 'codemirror/**', group: 'external', order: 'before' },
+          { pattern: '@lumino/**', group: 'external', order: 'before' },
+          { pattern: '@jupyterlab/**', group: 'external', order: 'after' }
+        ],
+        'newlines-between': 'always',
+        alphabetize: { order: 'asc' }
+      }
+    ],
     // deviations from jupyterlab, should probably be fixed
+    'import/no-cycle': 'off', // somehow we lapsed here... ~200 cycles now
+    'import/export': 'off', // we do class/interface + NS pun exports _all over_
     '@typescript-eslint/triple-slash-reference': 'off',
     'jest/no-test-callback': 'off',
     'jest/valid-expect': 'off',

packages/_example-extractor/src/api.spec.ts

@@ -1,9 +1,8 @@
+import { IExtractedCode } from '@krassowski/jupyterlab-lsp';
 import { expect } from 'chai';
 
 import { extractor } from '.';
 
-import { IExtractedCode } from '@krassowski/jupyterlab-lsp';
-
 const EXAMPLE = `%%foo
 bar
 `;

packages/_example-extractor/src/index.ts

@@ -2,7 +2,6 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
-
 import {
   ILSPCodeExtractorsManager,
   RegExpForeignCodeExtractor

packages/code-jumpers/src/history.ts

@@ -1,7 +1,8 @@
-import { IGlobalPosition } from './positions';
 import { IModelDB, IObservableUndoableList } from '@jupyterlab/observables';
 import { JSONValue } from '@lumino/coreutils';
 
+import { IGlobalPosition } from './positions';
+
 const DB_ENTRY = 'jumpy_history';
 
 export class JumpHistory {

packages/code-jumpers/src/index.ts

@@ -1,5 +1,5 @@
+import { FileEditorJumper } from './jumpers/fileeditor';
 import { CodeJumper } from './jumpers/jumper';
 import { NotebookJumper } from './jumpers/notebook';
-import { FileEditorJumper } from './jumpers/fileeditor';
 
 export { CodeJumper, NotebookJumper, FileEditorJumper };

packages/code-jumpers/src/jumpers/fileeditor.ts

@@ -1,10 +1,12 @@
+import { CodeEditor } from '@jupyterlab/codeeditor';
+import { IDocumentManager } from '@jupyterlab/docmanager';
+import { IDocumentWidget } from '@jupyterlab/docregistry';
 import { FileEditor } from '@jupyterlab/fileeditor';
+
+import { JumpHistory } from '../history';
 import { IGlobalPosition, ILocalPosition } from '../positions';
+
 import { CodeJumper, jumpers } from './jumper';
-import { JumpHistory } from '../history';
-import { IDocumentManager } from '@jupyterlab/docmanager';
-import { IDocumentWidget } from '@jupyterlab/docregistry';
-import { CodeEditor } from '@jupyterlab/codeeditor';
 
 export class FileEditorJumper extends CodeJumper {
   editor: FileEditor;