Add lint and fix test

Author: fcollonval

.github/workflows/test.yml

@@ -46,6 +46,7 @@ jobs:
           mamba-version: "*"
           channels: conda-forge
           python-version: "3.7"
+
       - name: Install dependencies
         run: |
           mamba install python=${{ matrix.python-version }} pip nodejs=16 yarn
@@ -58,6 +59,11 @@ jobs:
           yarn build
           cd ../tests; npm install
 
+      - name: Linter check
+        working-directory: javascript
+        run: |
+          yarn lint:check
+
       - name: Run Python tests
         run: |
           pytest -v

javascript/.eslintcache

@@ -0,0 +1 @@
+[{"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/api.d.ts":"1","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/api.js":"2","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/index.d.ts":"3","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/index.js":"4","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/utils.d.ts":"5","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/utils.js":"6","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/ymodels.d.ts":"7","/home/fcollonval/projects/jupyter_ydoc/javascript/lib/ymodels.js":"8","/home/fcollonval/projects/jupyter_ydoc/javascript/src/api.ts":"9","/home/fcollonval/projects/jupyter_ydoc/javascript/src/index.ts":"10","/home/fcollonval/projects/jupyter_ydoc/javascript/src/utils.ts":"11","/home/fcollonval/projects/jupyter_ydoc/javascript/src/ymodels.ts":"12","/home/fcollonval/projects/jupyter_ydoc/javascript/test/ymodels.spec.ts":"13"},{"size":14660,"mtime":1667573006775,"results":"14","hashOfConfig":"15"},{"size":305,"mtime":1667573006791,"results":"16","hashOfConfig":"15"},{"size":133,"mtime":1667570816542,"results":"17","hashOfConfig":"15"},{"size":429,"mtime":1667573006807,"results":"18","hashOfConfig":"15"},{"size":517,"mtime":1667573006815,"results":"19","hashOfConfig":"15"},{"size":1065,"mtime":1667573006823,"results":"20","hashOfConfig":"15"},{"size":17964,"mtime":1667573006935,"results":"21","hashOfConfig":"15"},{"size":39275,"mtime":1667573007083},{"size":14903,"mtime":1667570712700,"results":"22","hashOfConfig":"15"},{"size":396,"mtime":1667570712700,"results":"23","hashOfConfig":"15"},{"size":1180,"mtime":1667570712700,"results":"24","hashOfConfig":"15"},{"size":42408,"mtime":1667570712700,"results":"25","hashOfConfig":"15"},{"size":14256,"mtime":1667573007467,"results":"26","hashOfConfig":"15"},{"filePath":"27","messages":"28","suppressedMessages":"29","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},"1u2rmju",{"filePath":"30","messages":"31","suppressedMessages":"32","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"33","messages":"34","suppressedMessages":"35","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"36","messages":"37","suppressedMessages":"38","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"39","messages":"40","suppressedMessages":"41","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"42","messages":"43","suppressedMessages":"44","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"45","messages":"46","suppressedMessages":"47","errorCount":9,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"48","messages":"49","suppressedMessages":"50","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"51","messages":"52","suppressedMessages":"53","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"54","messages":"55","suppressedMessages":"56","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"57","messages":"58","suppressedMessages":"59","errorCount":18,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"60","messages":"61","suppressedMessages":"62","errorCount":31,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/api.d.ts",["63"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/api.js",["64"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/index.d.ts",["65"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/index.js",["66"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/utils.d.ts",["67"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/utils.js",["68"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/lib/ymodels.d.ts",["69","70","71","72","73","74","75","76","77"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/src/api.ts",["78"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/src/index.ts",["79"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/src/utils.ts",["80"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/src/ymodels.ts",["81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98"],[],"/home/fcollonval/projects/jupyter_ydoc/javascript/test/ymodels.spec.ts",["99","100","101","102","103","104","105","106","107","108","109","110","111","112","113","114","115","116","117","118","119","120","121","122","123","124","125","126","127","128","129"],[],{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"132","severity":2,"message":"133","line":219,"column":7,"nodeType":"134","messageId":"135","endLine":219,"endColumn":16},{"ruleId":"132","severity":2,"message":"133","line":422,"column":7,"nodeType":"134","messageId":"135","endLine":422,"endColumn":16},{"ruleId":"132","severity":2,"message":"136","line":426,"column":7,"nodeType":"134","messageId":"135","endLine":426,"endColumn":22},{"ruleId":"132","severity":2,"message":"136","line":427,"column":7,"nodeType":"134","messageId":"135","endLine":427,"endColumn":22},{"ruleId":"132","severity":2,"message":"133","line":517,"column":7,"nodeType":"134","messageId":"135","endLine":517,"endColumn":16},{"ruleId":"132","severity":2,"message":"133","line":539,"column":7,"nodeType":"134","messageId":"135","endLine":539,"endColumn":16},{"ruleId":"132","severity":2,"message":"137","line":604,"column":7,"nodeType":"134","messageId":"135","endLine":604,"endColumn":21},{"ruleId":"132","severity":2,"message":"137","line":605,"column":7,"nodeType":"134","messageId":"135","endLine":605,"endColumn":21},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"132","severity":2,"message":"136","line":365,"column":13,"nodeType":"134","messageId":"135","endLine":365,"endColumn":28},{"ruleId":"132","severity":2,"message":"133","line":409,"column":29,"nodeType":"134","messageId":"135","endLine":409,"endColumn":38},{"ruleId":"132","severity":2,"message":"133","line":465,"column":7,"nodeType":"134","messageId":"135","endLine":465,"endColumn":16},{"ruleId":"132","severity":2,"message":"138","line":763,"column":11,"nodeType":"134","messageId":"135","endLine":763,"endColumn":25},{"ruleId":"132","severity":2,"message":"138","line":781,"column":32,"nodeType":"134","messageId":"135","endLine":781,"endColumn":46},{"ruleId":"132","severity":2,"message":"133","line":799,"column":7,"nodeType":"134","messageId":"135","endLine":799,"endColumn":16},{"ruleId":"132","severity":2,"message":"133","line":952,"column":7,"nodeType":"134","messageId":"135","endLine":952,"endColumn":16},{"ruleId":"132","severity":2,"message":"136","line":959,"column":7,"nodeType":"134","messageId":"135","endLine":959,"endColumn":22},{"ruleId":"132","severity":2,"message":"136","line":962,"column":7,"nodeType":"134","messageId":"135","endLine":962,"endColumn":22},{"ruleId":"132","severity":2,"message":"136","line":1030,"column":7,"nodeType":"134","messageId":"135","endLine":1030,"endColumn":22},{"ruleId":"132","severity":2,"message":"133","line":1151,"column":7,"nodeType":"134","messageId":"135","endLine":1151,"endColumn":16},{"ruleId":"132","severity":2,"message":"133","line":1161,"column":7,"nodeType":"134","messageId":"135","endLine":1161,"endColumn":16},{"ruleId":"132","severity":2,"message":"133","line":1188,"column":7,"nodeType":"134","messageId":"135","endLine":1188,"endColumn":16},{"ruleId":"132","severity":2,"message":"133","line":1198,"column":7,"nodeType":"134","messageId":"135","endLine":1198,"endColumn":16},{"ruleId":"132","severity":2,"message":"137","line":1303,"column":7,"nodeType":"134","messageId":"135","endLine":1303,"endColumn":21},{"ruleId":"132","severity":2,"message":"137","line":1306,"column":7,"nodeType":"134","messageId":"135","endLine":1306,"endColumn":21},{"ruleId":"132","severity":2,"message":"137","line":1536,"column":7,"nodeType":"134","messageId":"135","endLine":1536,"endColumn":21},{"ruleId":"130","message":"131","line":1,"column":1,"endLine":1,"endColumn":2,"severity":2,"nodeType":null},{"ruleId":"132","severity":2,"message":"139","line":19,"column":11,"nodeType":"134","messageId":"135","endLine":19,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":21,"column":13,"nodeType":"134","messageId":"135","endLine":21,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":34,"column":11,"nodeType":"134","messageId":"135","endLine":34,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":36,"column":13,"nodeType":"134","messageId":"135","endLine":36,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":49,"column":11,"nodeType":"134","messageId":"135","endLine":49,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":51,"column":13,"nodeType":"134","messageId":"135","endLine":51,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":64,"column":11,"nodeType":"134","messageId":"135","endLine":64,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":66,"column":13,"nodeType":"134","messageId":"135","endLine":66,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":82,"column":13,"nodeType":"134","messageId":"135","endLine":82,"endColumn":26},{"ruleId":"132","severity":2,"message":"140","line":84,"column":15,"nodeType":"134","messageId":"135","endLine":84,"endColumn":27},{"ruleId":"132","severity":2,"message":"139","line":100,"column":18,"nodeType":"134","messageId":"135","endLine":100,"endColumn":31},{"ruleId":"132","severity":2,"message":"140","line":102,"column":11,"nodeType":"134","messageId":"135","endLine":102,"endColumn":23},{"ruleId":"132","severity":2,"message":"139","line":112,"column":11,"nodeType":"134","messageId":"135","endLine":112,"endColumn":24},{"ruleId":"132","severity":2,"message":"139","line":124,"column":11,"nodeType":"134","messageId":"135","endLine":124,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":126,"column":13,"nodeType":"134","messageId":"135","endLine":126,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":159,"column":11,"nodeType":"134","messageId":"135","endLine":159,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":161,"column":13,"nodeType":"134","messageId":"135","endLine":161,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":184,"column":11,"nodeType":"134","messageId":"135","endLine":184,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":186,"column":13,"nodeType":"134","messageId":"135","endLine":186,"endColumn":25},{"ruleId":"132","severity":2,"message":"139","line":216,"column":11,"nodeType":"134","messageId":"135","endLine":216,"endColumn":24},{"ruleId":"132","severity":2,"message":"140","line":218,"column":13,"nodeType":"134","messageId":"135","endLine":218,"endColumn":25},{"ruleId":"132","severity":2,"message":"133","line":249,"column":34,"nodeType":"134","messageId":"135","endLine":249,"endColumn":43},{"ruleId":"132","severity":2,"message":"133","line":254,"column":51,"nodeType":"134","messageId":"135","endLine":254,"endColumn":60},{"ruleId":"132","severity":2,"message":"133","line":260,"column":51,"nodeType":"134","messageId":"135","endLine":260,"endColumn":60},{"ruleId":"132","severity":2,"message":"133","line":272,"column":51,"nodeType":"134","messageId":"135","endLine":272,"endColumn":60},{"ruleId":"132","severity":2,"message":"133","line":287,"column":51,"nodeType":"134","messageId":"135","endLine":287,"endColumn":60},{"ruleId":"132","severity":2,"message":"133","line":304,"column":45,"nodeType":"134","messageId":"135","endLine":304,"endColumn":54},{"ruleId":"132","severity":2,"message":"133","line":305,"column":28,"nodeType":"134","messageId":"135","endLine":305,"endColumn":37},{"ruleId":"132","severity":2,"message":"138","line":352,"column":20,"nodeType":"134","messageId":"135","endLine":352,"endColumn":34},{"ruleId":"132","severity":2,"message":"138","line":359,"column":20,"nodeType":"134","messageId":"135","endLine":359,"endColumn":34},"react/prop-types","Definition for rule 'react/prop-types' was not found.","camelcase","Identifier 'cell_type' is not in camel case.","Identifier","notCamelCase","Identifier 'execution_count' is not in camel case.","Identifier 'nbformat_minor' is not in camel case.","Identifier 'outputs_hidden' is not in camel case.","Identifier 'orig_nbformat' is not in camel case.","Identifier 'display_name' is not in camel case."]

javascript/.eslintrc.cjs

@@ -0,0 +1,99 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    commonjs: true,
+    node: true,
+    'jest/globals': true
+  },
+  globals: {
+    BigInt: 'readonly',
+    HTMLCollectionOf: 'readonly',
+    NodeJS: 'readonly',
+    RequestInit: 'readonly',
+    RequestInfo: 'readonly',
+    ScrollLogicalPosition: 'readonly'
+  },
+  root: true,
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  overrides: [
+    {
+      files: ['test/**/*.spec.ts'],
+      plugins: ['jest'],
+      extends: ['plugin:jest/recommended'],
+      rules: {
+        'jest/no-conditional-expect': 'warn',
+        'jest/valid-title': 'warn',
+        'jest/no-standalone-expect': [
+          'error',
+          {
+            additionalTestBlockFunctions: ['it']
+          }
+        ]
+      }
+    }
+  ],
+  rules: {
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: 'interface',
+        format: ['PascalCase'],
+        custom: {
+          regex: '^I[A-Z]',
+          match: true
+        }
+      }
+    ],
+    '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/ban-ts-comment': ['warn', { 'ts-ignore': true }],
+    '@typescript-eslint/ban-types': 'warn',
+    '@typescript-eslint/no-non-null-asserted-optional-chain': 'warn',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-empty-interface': 'off',
+    '@typescript-eslint/triple-slash-reference': 'warn',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    camelcase: [
+      'error',
+      {
+        allow: [
+          'cell_type',
+          'display_name',
+          'orig_nbformat',
+          'outputs_hidden'
+        ]
+      }
+    ],
+    'id-match': ['error', '^[a-zA-Z_]+[a-zA-Z0-9_]*$'], // https://certitude.consulting/blog/en/invisible-backdoor/
+    'no-inner-declarations': 'off',
+    'no-prototype-builtins': 'off',
+    'no-control-regex': 'warn',
+    'no-undef': 'warn',
+    'no-case-declarations': 'warn',
+    'no-useless-escape': 'off',
+    'prefer-const': 'off',
+    'sort-imports': [
+      'error',
+      {
+        ignoreCase: true,
+        ignoreDeclarationSort: true,
+        ignoreMemberSort: false,
+        memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+        allowSeparatedGroups: false
+      }
+    ]
+  }
+};

javascript/.prettierrc

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

javascript/.vscode/launch.json

@@ -1,15 +1,15 @@
 {
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "attach",
-            "name": "Attach to jest",
-            // Usage:
-            // Open the parent directory in VSCode
-            // Run `jlpm test:debug:watch` in a terminal
-            // Run this debugging task
-            "port": 9229
-        }
-    ]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to jest",
+      // Usage:
+      // Open the parent directory in VSCode
+      // Run `jlpm test:debug:watch` in a terminal
+      // Run this debugging task
+      "port": 9229
+    }
+  ]
 }

javascript/babel.config.js renamed to javascript/babel.config.cjs

@@ -6,12 +6,12 @@
 module.exports = {
   presets: [
     [
-      "@babel/preset-env",
+      '@babel/preset-env',
       {
         targets: {
-          node: "current",
-        },
-      },
-    ],
-  ],
+          node: 'current'
+        }
+      }
+    ]
+  ]
 };

javascript/jest.config.cjs

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+const path = require('path');
+const esModules = ['lib0', 'y-protocols', 'y-websocket', 'yjs'].join('|');
+
+module.exports = {
+  preset: 'ts-jest/presets/js-with-babel',
+  testTimeout: 10000,
+  testPathIgnorePatterns: ['/lib/', '/node_modules/'],
+  moduleFileExtensions: [
+    'ts',
+    'tsx',
+    'js',
+    'jsx',
+    'json',
+    'node',
+    'mjs',
+    'cjs'
+  ],
+  transformIgnorePatterns: [`/node_modules/(?!${esModules}).+`],
+  reporters: ['default'],
+  coverageReporters: ['json', 'lcov', 'text', 'html'],
+  coverageDirectory: path.join(__dirname, 'coverage'),
+  testRegex: '/test/.*.spec.ts[x]?$',
+  globals: {
+    'ts-jest': {
+      tsconfig: `./tsconfig.test.json`
+    }
+  }
+};