Merge pull request #562 from bollwyvl/gh-561-quick-fix

Propose Extractor API (#561, Plan A)

.github/workflows/job.test.yml

@@ -25,7 +25,7 @@ env:
   JLPM_CMD: jlpm --ignore-optional --prefer-offline --frozen-lockfile
 
   # Increase this value to reset all caches
-  CACHE_EPOCH: 1
+  CACHE_EPOCH: 2
   JULIA_LANGSERVER: 3.2.0
 
 jobs:

CHANGELOG.md

@@ -12,10 +12,15 @@
   - fixes IPython `pinfo` and `pinfo2` (`?` and `??`) for identifiers containing `s` ([#547])
   - fixes incorrect behaviour of LSP features in some IPython magics with single line of content ([#560])
 
+- for extension authors:
+
+  - minimal functional extractor and code overrides APIs are now exported; these APIs cab be subject to change in future releases ([#562])
+
 [#544]: https://github.com/krassowski/jupyterlab-lsp/pull/544
 [#547]: https://github.com/krassowski/jupyterlab-lsp/pull/547
 [#553]: https://github.com/krassowski/jupyterlab-lsp/pull/553
 [#560]: https://github.com/krassowski/jupyterlab-lsp/pull/560
+[#562]: https://github.com/krassowski/jupyterlab-lsp/pull/562
 
 ### `jupyter-lsp 1.1.4` (2020-02-21)
 

packages/.eslintrc.js

@@ -6,6 +6,7 @@ module.exports = {
     node: true,
     'jest/globals': true
   },
+  globals: { JSX: 'readonly' },
   root: true,
   extends: [
     'eslint:recommended',

packages/_example-extractor/README.md

@@ -0,0 +1,5 @@
+# Extractor API
+
+This is an example of the Extractor API. See the [discussion].
+
+[discussion]: https://github.com/krassowski/jupyterlab-lsp/issues/561

packages/_example-extractor/babel.config.js

@@ -0,0 +1 @@
+module.exports = require('@jupyterlab/testutils/lib/babel.config');

packages/_example-extractor/jest.config.js

@@ -0,0 +1,31 @@
+const func = require('@jupyterlab/testutils/lib/jest-config');
+const upstream = func('jupyterlab-lsp', __dirname);
+
+const reuseFromUpstream = [
+  'moduleFileExtensions',
+  'moduleNameMapper',
+  'setupFiles',
+  'setupFilesAfterEnv',
+  'testPathIgnorePatterns'
+];
+
+let local = {
+  globals: { 'ts-jest': { tsconfig: 'tsconfig.json' } },
+  testRegex: `.*\.spec\.tsx?$`,
+  transform: {
+    '\\.(ts|tsx)?$': 'ts-jest',
+    '\\.(js|jsx)?$': './transform.js',
+    '\\.svg$': 'jest-raw-loader'
+  },
+  transformIgnorePatterns: [
+    '/node_modules/(?!(@jupyterlab/.*|@jupyterlab-classic/.*)/)'
+  ],
+  testLocationInResults: true,
+  reporters: [...upstream['reporters'], 'jest-github-actions-reporter']
+};
+
+for (const option of reuseFromUpstream) {
+  local[option] = upstream[option];
+}
+
+module.exports = local;

packages/_example-extractor/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@krassowski/jupyterlab-lsp-example-extractor",
+  "description": "Example extractor package from @krassowski/jupyterlab-lsp",
+  "version": "0.0.0",
+  "private": true,
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "author": "JupyterLab-LSP Development Team",
+  "files": [
+    "lib/**/*.{js,ts}"
+  ],
+  "dependencies": {
+    "@krassowski/jupyterlab-lsp": "^3.4"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.4.3",
+    "@types/chai": "^4.1.7",
+    "@types/jest": "^23.3.11",
+    "@jupyterlab/application": "^3.0.0",
+    "typescript": "~4.1.3",
+    "jest": "^26.0.0",
+    "ts-jest": "^26.4.3",
+    "chai": "^4.2.0"
+  },
+  "jupyterlab": {
+    "extension": true
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "test": "jest",
+    "clean:lib": "rimraf lib"
+  }
+}

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

@@ -0,0 +1,46 @@
+import { expect } from 'chai';
+
+import { extractor } from '.';
+
+import { IExtractedCode } from '@krassowski/jupyterlab-lsp';
+
+const EXAMPLE = `%%foo
+bar
+`;
+
+let FIXTURES: { [key: string]: IExtractedCode } = {
+  'does extract foo': {
+    foreign_code: 'bar\n',
+    host_code: EXAMPLE,
+    range: { end: { column: 0, line: 2 }, start: { column: 0, line: 1 } },
+    virtual_shift: null
+  },
+  'does NOT extract bar': {
+    foreign_code: null,
+    host_code: 'baz',
+    range: null,
+    virtual_shift: null
+  },
+  'does NOT extract foobar': {
+    foreign_code: null,
+    host_code: EXAMPLE.replace('foo', 'foobar'),
+    range: null,
+    virtual_shift: null
+  }
+};
+
+FIXTURES['does extract foo -v bar'] = {
+  ...FIXTURES['does extract foo'],
+  host_code: EXAMPLE.replace('foo', 'foo -v')
+};
+
+describe('The foo extractor', () => {
+  test.each(Object.entries(FIXTURES))(
+    '%s',
+    (_: string, expected: IExtractedCode) => {
+      const extracted = extractor.extract_foreign_code(expected.host_code);
+      expect(extracted).to.have.length(1);
+      expect(extracted[0]).to.deep.equal(expected);
+    }
+  );
+});

packages/_example-extractor/src/index.ts

@@ -0,0 +1,29 @@
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+
+import {
+  ILSPCodeExtractorsManager,
+  RegExpForeignCodeExtractor
+} from '@krassowski/jupyterlab-lsp';
+
+const NS = '@krassowski/jupyterlab-lsp-example-extractor';
+
+export const extractor = new RegExpForeignCodeExtractor({
+  language: 'foo',
+  pattern: '^%%(foo)( .*?)?\n([^]*)',
+  foreign_capture_groups: [3],
+  is_standalone: true,
+  file_extension: 'foo'
+});
+
+const plugin: JupyterFrontEndPlugin<void> = {
+  id: `${NS}:PLUGIN`,
+  requires: [ILSPCodeExtractorsManager],
+  activate: (_app: JupyterFrontEnd, extractors: ILSPCodeExtractorsManager) => {
+    extractors.register(extractor, 'python');
+  }
+};
+
+export default plugin;

packages/_example-extractor/transform.js

@@ -0,0 +1,2 @@
+const config = require('./babel.config.js');
+module.exports = require('babel-jest').createTransformer(config);

packages/_example-extractor/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../tsconfigbase",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src",
+    "types": ["jest"],
+    "tsBuildInfoFile": "lib/.tsbuildinfo"
+  },
+  "include": ["src/**/*"],
+  "references": [
+    {
+      "path": "../jupyterlab-lsp"
+    }
+  ]
+}

packages/jupyterlab-lsp/src/api/extractor.ts

@@ -0,0 +1,14 @@
+/**
+ * Extractor Public API
+ *
+ * Please note that this APIs can be subject to change and relocation to separate package in the future releases.
+ *
+ * @see https://github.com/krassowski/jupyterlab-lsp/issues/561
+ */
+export { LanguageIdentifier } from '../lsp';
+export {
+  IForeignCodeExtractor,
+  IForeignCodeExtractorsRegistry,
+  IExtractedCode
+} from '../extractors/types';
+export { RegExpForeignCodeExtractor } from '../extractors/regexp';

packages/jupyterlab-lsp/src/api/index.ts

@@ -0,0 +1,5 @@
+/** Extractor Public API */
+export * from './extractor';
+
+/** Overrides Public API */
+export * from './overrides';

packages/jupyterlab-lsp/src/api/overrides.ts

@@ -0,0 +1,11 @@
+/**
+ * Overrides Public API
+ *
+ * Please note that this APIs can be subject to change and relocation to separate package in the future releases.
+ *
+ * @see https://github.com/krassowski/jupyterlab-lsp/issues/561
+ */
+export {
+  ILSPCodeOverridesManager,
+  IScopedCodeOverride
+} from '../overrides/tokens';

packages/jupyterlab-lsp/src/components/statusbar.tsx

@@ -293,25 +293,26 @@ export class LSPStatus extends VDomRenderer<LSPStatus.Model> {
    * Render the status item.
    */
   render() {
-    if (!this.model) {
+    const { model } = this;
+
+    if (model == null) {
       return null;
     }
+
     return (
       <GroupItem
         spacing={this.displayText ? 2 : 0}
-        title={this.model.long_message}
+        title={model.long_message}
         onClick={this.handleClick}
         className={'lsp-status-group'}
       >
-        <this.model.status_icon.react
+        <model.status_icon.react
           top={'2px'}
           kind={'statusBar'}
           title={'LSP Code Intelligence'}
         />
-        {this.displayText ? (
-          <TextItem source={this.model.short_message} />
-        ) : null}
-        <TextItem source={this.model.feature_message} />
+        {this.displayText ? <TextItem source={model.short_message} /> : null}
+        <TextItem source={model.feature_message} />
       </GroupItem>
     );
   }

packages/jupyterlab-lsp/src/extractors/regexp.spec.ts

@@ -30,7 +30,7 @@ describe('getIndexOfCaptureGroup', () => {
   it('extracts index of a captured group', () => {
     // tests for https://github.com/krassowski/jupyterlab-lsp/issues/559
     let result = getIndexOfCaptureGroup(
-      new RegExp('^%%(python|python2|python3|pypy)( .*?)?\n([^]*)'),
+      new RegExp('^%%(python|python2|python3|pypy)( .*?)?\\n([^]*)'),
       '%%python\nh',
       'h'
     );
@@ -59,7 +59,7 @@ describe('RegExpForeignCodeExtractor', () => {
 
   let python_cell_extractor = new RegExpForeignCodeExtractor({
     language: 'python',
-    pattern: '^%%(python|python2|python3|pypy)( .*?)?\n([^]*)',
+    pattern: '^%%(python|python2|python3|pypy)( .*?)?\\n([^]*)',
     foreign_capture_groups: [3],
     keep_in_host: true,
     is_standalone: true,

packages/jupyterlab-lsp/src/feature.ts

@@ -164,6 +164,9 @@ export interface IFeatureEditorIntegration<T extends IVirtualEditor<IEditor>> {
    * position transformation errors).
    */
   afterChange?(change: IEditorChange, root_position: IRootPosition): void;
+
+  /** no-unused-vars rule is hard to disable selectively */
+  __unused_editor_?: T;
 }
 
 export interface IFeatureEditorIntegrationConstructor<

packages/jupyterlab-lsp/src/index.ts

@@ -1,3 +1,11 @@
+/** The Public API, as exposed in the `main` field of package.json */
+
+/** General public tokens, including lumino Tokens and namespaces */
+export * from './tokens';
+
+/** Component- and feature-specific APIs */
+export * from './api';
+
 import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
@@ -51,8 +59,6 @@ import { CODE_OVERRIDES_MANAGER } from './overrides';
 import IPaths = JupyterFrontEnd.IPaths;
 import { LOG_CONSOLE } from './virtual/console';
 
-export * from './tokens';
-
 export interface IFeatureOptions {
   /**
    * The feature to be registered.

packages/lsp-ws-connection/package.json

@@ -48,7 +48,7 @@
     "karma-webpack": "^4.0.2",
     "mocha": "^6.1.4",
     "puppeteer": "^1.17.0",
-    "rimraf": "^2.6.3",
+    "rimraf": "^3.0.2",
     "sinon": "^7.3.2",
     "source-map-loader": "~0.2.1",
     "typescript": "~4.1.3",

packages/metapackage/package.json

@@ -23,19 +23,20 @@
     "build": "tsc -b",
     "clean": "rimraf lib",
     "prepublishOnly": "npm run build",
-    "watch": "tsc -b --watch"
+    "watch": "tsc -b --watch --preserveWatchOutput"
   },
   "dependencies": {
     "lsp-ws-connection": "file:../lsp-ws-connection",
     "@krassowski/completion-theme": "file:../completion-theme",
     "@krassowski/theme-material": "file:../theme-material",
     "@krassowski/theme-vscode": "file:../theme-vscode",
     "@krassowski/code-jumpers": "file:../code-jumpers",
-    "@krassowski/jupyterlab-lsp": "file:../jupyterlab-lsp"
+    "@krassowski/jupyterlab-lsp": "file:../jupyterlab-lsp",
+    "@krassowski/jupyterlab-lsp-example-extractor": "file:../_example-extractor"
   },
   "devDependencies": {
     "fs-extra": "^8.0.1",
-    "rimraf": "~2.6.2",
+    "rimraf": "^3.0.2",
     "typedoc": "^0.14.2",
     "typescript": "~4.1.3"
   },

packages/metapackage/src/index.ts

@@ -1,6 +1,7 @@
 import '@krassowski/code-jumpers';
-import '@krassowski/jupyterlab-lsp';
 import '@krassowski/completion-theme';
+import '@krassowski/jupyterlab-lsp-example-extractor';
+import '@krassowski/jupyterlab-lsp';
 import '@krassowski/theme-material';
 import '@krassowski/theme-vscode';
 import 'lsp-ws-connection';

packages/metapackage/tsconfig.json

@@ -25,6 +25,9 @@
     },
     {
       "path": "../code-jumpers"
+    },
+    {
+      "path": "../_example-extractor"
     }
   ]
 }

scripts/atest.py

@@ -74,7 +74,7 @@ def atest(attempt, extra_args):
     stem = get_stem(attempt, extra_args)
 
     for non_critical in NON_CRITICAL:
-        extra_args += ["--noncritical", "AND".join(non_critical)]
+        extra_args += ["--skiponfailure", "AND".join(non_critical)]
 
     if attempt != 1:
         previous = OUT / f"{get_stem(attempt - 1, extra_args)}.robot.xml"
@@ -94,7 +94,6 @@ def atest(attempt, extra_args):
         OUT / f"{stem}.log.html",
         "--report",
         OUT / f"{stem}.report.html",
-        "--xunitskipnoncritical",
         "--xunit",
         OUT / f"{stem}.xunit.xml",
         "--variable",