Merge pull request #20 from hbcarlos/blockly_file_type

FileType, Manager and Register

Author: hbcarlos

.eslintignore

@@ -1,5 +1,27 @@
-node_modules
+**/node_modules
+**/lib
+**/package.json
+**/patches
 dist
 coverage
 **/*.d.ts
 tests
+
+.github
+binder
+jupyterlab_blockly/labextension
+.eslintignore
+.eslintrc.js
+.gitignore
+.pre-commit-config.yaml
+.prettierignore
+.prettierrc
+CHANGELOG.md
+install.json
+LICENSE
+MANIFEST.in
+pyproject.toml
+README.md
+RELEASE.md
+tsconfig.json
+yarn.lock

.eslintrc.js

@@ -3,7 +3,8 @@ module.exports = {
     'eslint:recommended',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended'
+    'plugin:prettier/recommended',
+    'plugin:react/recommended'
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
@@ -15,11 +16,11 @@ module.exports = {
     '@typescript-eslint/naming-convention': [
       'error',
       {
-        'selector': 'interface',
-        'format': ['PascalCase'],
-        'custom': {
-          'regex': '^I[A-Z]',
-          'match': true
+        selector: 'interface',
+        format: ['PascalCase'],
+        custom: {
+          regex: '^I[A-Z]',
+          match: true
         }
       }
     ],

.github/workflows/binder-on-pr.yml

@@ -0,0 +1,28 @@
+# Reference https://mybinder.readthedocs.io/en/latest/howto/gh-actions-badges.html
+name: Binder Badge
+on:
+  pull_request_target:
+    types: [opened]
+
+permissions:
+  pull-requests: write
+jobs:
+  binder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: comment on PR with Binder link
+        uses: actions/github-script@v3
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            var PR_HEAD_USERREPO = process.env.PR_HEAD_USERREPO;
+            var PR_HEAD_REF = process.env.PR_HEAD_REF;
+            github.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${PR_HEAD_USERREPO}/${PR_HEAD_REF}?urlpath=lab) :point_left: Launch a Binder on branch _${PR_HEAD_USERREPO}/${PR_HEAD_REF}_`
+            })
+        env:
+          PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
+          PR_HEAD_USERREPO: ${{ github.event.pull_request.head.repo.full_name }}

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: local
+    hooks:
+      - id: prettier
+        name: prettier
+        entry: 'npm run prettier'
+        language: node
+      - id: eslint
+        name: eslint
+        entry: 'npm run eslint'
+        language: node

.prettierrc

@@ -1,5 +1,6 @@
 {
   "singleQuote": true,
   "trailingComma": "none",
-  "arrowParens": "avoid"
-}
+  "arrowParens": "avoid",
+  "endOfLine": "auto"
+}

README.md

@@ -5,26 +5,34 @@
 Blockly extension for JupyterLab.
 
 ## Blockly
+
 Blockly is a library from Google for building beginner-friendly block-based programming languages.
 
 Docs: https://developers.google.com/blockly/guides/overview
 Repo: https://github.com/google/blockly
 
-
 ## Requirements
 
-* JupyterLab == 3.4
+- JupyterLab == 3.4
 
 ## Install
 
 To install the extension, execute:
 
 ```bash
-micromamba create -n blockly -c conda-forge python
+micromamba create -n blockly -c conda-forge python jupyterlab==3.4 ipykernel xeus-python xeus-lua jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR
 micromamba activate blockly
 pip install jupyterlab_blockly
 ```
 
+#### Kernels
+
+- ipykernel
+- xeus-python
+- xeus-lua
+- [JavaScript](https://github.com/n-riesco/ijavascript#installation)
+- [JavaScript](https://github.com/yunabe/tslab)
+
 ## Uninstall
 
 To remove the extension, execute:
@@ -33,7 +41,6 @@ To remove the extension, execute:
 pip uninstall jupyterlab_blockly
 ```
 
-
 ## Contributing
 
 ### Development install
@@ -45,12 +52,14 @@ The `jlpm` command is JupyterLab's pinned version of
 `yarn` or `npm` in lieu of `jlpm` below.
 
 ```bash
-micromamba create -n blockly -c conda-forge python nodejs yarn jupyterlab==3.4 jupyter-packaging
+micromamba create -n blockly -c conda-forge python nodejs pre-commit yarn jupyterlab==3.4 jupyter-packaging jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR ipykernel xeus-python xeus-lua
 micromamba activate blockly
 # Clone the repo to your local environment
 # Change directory to the jupyterlab_blockly directory
 # Install package in development mode
 pip install -e .
+# Installing pre-commit to run command when adding commits
+pre-commit install
 # Link your development version of the extension with JupyterLab
 jupyter labextension develop . --overwrite
 # Rebuild extension Typescript source after making changes

RELEASE.md

@@ -15,7 +15,7 @@ Python package. Before generating a package, we first need to install `build`.
 pip install build twine
 ```
 
-To create a Python source package (``.tar.gz``) and the binary package (`.whl`) in the `dist/` directory, do:
+To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
 
 ```bash
 python -m build

package.json

@@ -37,9 +37,14 @@
     "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
     "clean:labextension": "rimraf jupyterlab_blockly/labextension",
     "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
-    "eslint": "eslint . --ext .ts,.tsx --fix",
+    "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",
     "install:extension": "jlpm run build",
+    "lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
+    "lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
+    "prettier": "jlpm prettier:base --write --list-different",
+    "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css}\"",
+    "prettier:check": "jlpm prettier:base --check",
     "watch": "run-p watch:src watch:labextension",
     "watch:src": "tsc -w",
     "watch:labextension": "jupyter labextension watch .",
@@ -48,11 +53,16 @@
   "dependencies": {
     "@jupyterlab/application": "^3.4",
     "@jupyterlab/apputils": "^3.4",
+    "@jupyterlab/cells": "^3.4",
+    "@jupyterlab/codeeditor": "^3.4",
+    "@jupyterlab/coreutils": "^5.4",
     "@jupyterlab/docregistry": "^3.4",
     "@jupyterlab/filebrowser": "^3.4",
     "@jupyterlab/launcher": "^3.4",
     "@jupyterlab/outputarea": "^3.4",
     "@jupyterlab/rendermime": "^3.4",
+    "@jupyterlab/services": "^6.4",
+    "@jupyterlab/ui-components": "^3.4",
     "@lumino/algorithm": "^1.9.0",
     "@lumino/coreutils": "^1.11.0",
     "@lumino/messaging": "^1.10.0",
@@ -69,6 +79,7 @@
     "eslint": "^8.9.0",
     "eslint-config-prettier": "^8.4.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.30.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.5.1",
     "rimraf": "^3.0.2",

patches/@jupyterlab+codeeditor+3.4.2.patch renamed to patches/@jupyterlab+codeeditor+3.4.3.patch

@@ -4,9 +4,10 @@ import {
   DocumentModel
 } from '@jupyterlab/docregistry';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-// import { ITranslator } from '@jupyterlab/translation';
+import { IEditorMimeTypeService } from '@jupyterlab/codeeditor';
 
 import { BlocklyEditor, BlocklyPanel } from './widget';
+import { BlocklyRegistry } from './registry';
 import { BlocklyManager } from './manager';
 
 /**
@@ -16,10 +17,9 @@ export class BlocklyEditorFactory extends ABCWidgetFactory<
   BlocklyEditor,
   DocumentModel
 > {
-  private _manager: BlocklyManager;
+  private _registry: BlocklyRegistry;
   private _rendermime: IRenderMimeRegistry;
-  private _language: string;
-  // private _translator: ITranslator;
+  private _mimetypeService: IEditorMimeTypeService;
 
   /**
    * Constructor of BlocklyEditorFactory.
@@ -28,14 +28,13 @@ export class BlocklyEditorFactory extends ABCWidgetFactory<
    */
   constructor(options: BlocklyEditorFactory.IOptions) {
     super(options);
-    this._manager = new BlocklyManager();
+    this._registry = new BlocklyRegistry();
     this._rendermime = options.rendermime;
-    this._language = this._manager.language;
-    // this._translator = options.translator;
+    this._mimetypeService = options.mimetypeService;
   }
 
-  get manager(): BlocklyManager {
-    return this._manager;
+  get registry(): BlocklyRegistry {
+    return this._registry;
   }
 
   /**
@@ -47,15 +46,13 @@ export class BlocklyEditorFactory extends ABCWidgetFactory<
   protected createNewWidget(
     context: DocumentRegistry.IContext<DocumentModel>
   ): BlocklyEditor {
-    return new BlocklyEditor({
-      context,
-      content: new BlocklyPanel(
-        context,
-        this._manager,
-        this._rendermime,
-        this._language
-      )
-    });
+    const manager = new BlocklyManager(
+      this._registry,
+      context.sessionContext,
+      this._mimetypeService
+    );
+    const content = new BlocklyPanel(context, manager, this._rendermime);
+    return new BlocklyEditor({ context, content, manager });
   }
 }
 
@@ -65,5 +62,9 @@ export namespace BlocklyEditorFactory {
      * A rendermime instance.
      */
     rendermime: IRenderMimeRegistry;
+    /*
+     * A mimeType service instance.
+     */
+    mimetypeService: IEditorMimeTypeService;
   }
 }