Merge pull request #19 from jtpio/eslint

Add Eslint

Author: jtpio

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+coverage
+**/*.d.ts

.eslintrc.js

@@ -0,0 +1,47 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:jsdoc/recommended',
+    'plugin:prettier/recommended',
+    'plugin:react/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2017,
+  },
+  plugins: ['@typescript-eslint', 'jsdoc'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': [
+      'error',
+      { prefixWithI: 'always' },
+    ],
+    '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/camelcase': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/quotes': [
+      'error',
+      'single',
+      { avoidEscape: true, allowTemplateLiterals: false },
+    ],
+    curly: ['error', 'all'],
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-property-type': 'off',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/no-types': 'warn',
+    'prefer-arrow-callback': 'error',
+  },
+  settings: {
+    jsdoc: {
+      mode: 'typescript',
+    },
+    react: {
+      version: 'detect',
+    },
+  },
+};

.github/workflows/build.yml

@@ -4,26 +4,33 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
+
     - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
+
     - name: Install node
       uses: actions/setup-node@v1
       with:
        node-version: '10.x'
+
     - name: Install Python
       uses: actions/setup-python@v1
       with:
         python-version: '3.8'
+
     - name: Install JupyterLab
       run: python -m pip install jupyterlab nbresuse
+
     - name: Build and install the extension
       run: |
         jlpm
         jlpm run build
-        jlpm run install
+        jlpm run link
+
     - name: Browser check
       run: python -m jupyterlab.browser_check
+
+    - name: Lint
+      run: jlpm run lint:check

.gitignore

@@ -4,3 +4,4 @@ node_modules/
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
+.vscode

.lintstagedrc

@@ -0,0 +1,5 @@
+{
+  "**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}": [
+    "prettier --write"
+  ]
+}

.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+**/node_modules
+**/lib
+**/build
+**/static

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

README.md

@@ -46,7 +46,7 @@ For more info, check the [memory limit](https://github.com/yuvipanda/nbresuse#me
 
 Edit `~/.jupyter/jupyter_notebook_config.py`:
 
-``` python
+```python
 c = get_config()
 
 c.NotebookApp.ResourceUseDisplay.mem_limit = Size_of_GB *1024*1024*1024
@@ -78,6 +78,6 @@ jlpm
 # Build Typescript source
 jlpm run build
 
-# Link and install the extensions
-jlpm run install
+# Link the local extensions
+jlpm run link
 ```

lerna.json

@@ -1,7 +1,5 @@
 {
-  "packages": [
-    "packages/*"
-  ],
+  "packages": ["packages/*"],
   "npmClient": "jlpm",
   "useWorkspaces": true,
   "version": "independent"

package.json

@@ -4,15 +4,37 @@
     "bootstrap": "lerna bootstrap",
     "build": "lerna run build",
     "clean": "lerna run clean",
-    "link": "lerna run link",
-    "install": "lerna run link && jupyter labextension install jupyterlab-topbar-extension"
+    "link": "lerna run link && jupyter labextension install jupyterlab-topbar-extension",
+    "lint": "jlpm run eslint && jlpm run prettier",
+    "lint:check": "jlpm run eslint:check && jlpm run prettier:check",
+    "eslint": "eslint . --ext .ts,.tsx --fix",
+    "eslint:check": "eslint . --ext .ts,.tsx",
+    "prettier": "prettier --write \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
+    "prettier:check": "prettier --list-different \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\""
   },
   "workspaces": {
     "packages": [
       "packages/*"
     ]
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
   "devDependencies": {
-    "lerna": "^3.20.2"
+    "@typescript-eslint/eslint-plugin": "^2.21.0",
+    "@typescript-eslint/parser": "^2.21.0",
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.10.0",
+    "eslint-plugin-jsdoc": "^22.0.0",
+    "eslint-plugin-prettier": "^3.1.2",
+    "eslint-plugin-react": "^7.18.3",
+    "husky": "^3.0.0",
+    "lerna": "^3.20.2",
+    "lint-staged": "^10.0.8",
+    "prettier": "^2.0.2",
+    "rimraf": "^3.0.2",
+    "typescript": "~3.8.1"
   }
 }

packages/system-monitor-base/package.json

@@ -27,7 +27,6 @@
   "scripts": {
     "build": "tsc",
     "link": "jupyter labextension link . --no-build",
-    "prettier": "prettier --write '**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}'",
     "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
     "prepare": "npm run clean && npm run build",
     "watch": "tsc -w"
@@ -43,23 +42,7 @@
     "@types/react": "~16.9.0",
     "@types/react-dom": "~16.9.0",
     "@types/react-sparklines": "^1.7.0",
-    "husky": "^3.0.0",
-    "lint-staged": "^8.1.5",
-    "prettier": "^1.17.0",
     "rimraf": "^2.6.1",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-plugin-prettier": "^2.0.1",
     "typescript": "~3.8.1"
-  },
-  "lint-staged": {
-    "**/*{.ts,.tsx,.css,.json,.md}": [
-      "prettier --write",
-      "git add"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
   }
 }