2.2.1 Release (#294)

* Master to dev Release (#259) * TableChart : Auto-hide columns prefixed with __ * Master to dev Release (#259) * Added prettier (config based on neo4j/nx repository) * Added eslint and husky (config based on neo4j/nx repository) * Updated eslint config to be as light as possible with Typescript * Updated all files with prettier and linter, refactored files to avoid errors * Added Eslint check step in Github workflows * Updated all files with prettier and linter after rebase on Develop branch * Squash Security Bumbs (#281) * Bump loader-utils from 2.0.2 to 2.0.4 in /gallery Bumps [loader-utils](https://github.com/webpack/loader-utils) from 2.0.2 to 2.0.4. - [Release notes](https://github.com/webpack/loader-utils/releases) - [Changelog](https://github.com/webpack/loader-utils/blob/v2.0.4/CHANGELOG.md) - [Commits](webpack/loader-utils@v2.0.2...v2.0.4) --- updated-dependencies: - dependency-name: loader-utils dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> * Bump loader-utils from 1.4.0 to 1.4.2 Bumps [loader-utils](https://github.com/webpack/loader-utils) from 1.4.0 to 1.4.2. - [Release notes](https://github.com/webpack/loader-utils/releases) - [Changelog](https://github.com/webpack/loader-utils/blob/v1.4.2/CHANGELOG.md) - [Commits](webpack/loader-utils@v1.4.0...v1.4.2) --- updated-dependencies: - dependency-name: loader-utils dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> * Update yarn.lock * yarn gallery util 3.2.1 * bump * remove lodash 4.17.15 lock * remove minimatch 3.0.4 lock * remove d3 color lock * remove node.fet color lock * ut * no node fetch * lod * lod2 * ncheck * d3 init Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Niels de Jong <[email protected]> * Bump loader-utils from 2.0.2 to 2.0.4 in /gallery (#264) Bumps [loader-utils](https://github.com/webpack/loader-utils) from 2.0.2 to 2.0.4. - [Release notes](https://github.com/webpack/loader-utils/releases) - [Changelog](https://github.com/webpack/loader-utils/blob/v2.0.4/CHANGELOG.md) - [Commits](webpack/loader-utils@v2.0.2...v2.0.4) --- updated-dependencies: - dependency-name: loader-utils dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fixes #160 (#269) * Fix : Replace parameter in iFrame URLs (#276) * Fix : Replace parameter in iFrame URLs * Fix wrong merge conflict Co-authored-by: Marius Conjeaud <[email protected]> * Bump loader-utils from 2.0.2 to 2.0.4 in /gallery (#290) * Bump loader-utils from 1.4.0 to 1.4.2 (#265) Bumps [loader-utils](https://github.com/webpack/loader-utils) from 1.4.0 to 1.4.2. - [Release notes](https://github.com/webpack/loader-utils/releases) - [Changelog](https://github.com/webpack/loader-utils/blob/v1.4.2/CHANGELOG.md) - [Commits](webpack/loader-utils@v1.4.0...v1.4.2) --- updated-dependencies: - dependency-name: loader-utils dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump loader-utils from 2.0.2 to 2.0.4 in /gallery Bumps [loader-utils](https://github.com/webpack/loader-utils) from 2.0.2 to 2.0.4. - [Release notes](https://github.com/webpack/loader-utils/releases) - [Changelog](https://github.com/webpack/loader-utils/blob/v2.0.4/CHANGELOG.md) - [Commits](webpack/loader-utils@v2.0.2...v2.0.4) --- updated-dependencies: - dependency-name: loader-utils dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Niels de Jong <[email protected]> * Crash on Boolean options parameter selection (#285) * bug on non string values * Fix merge conflicts * Fix merge conflicts * Fix merge conflicts * Fix merge conflicts * Fix merge conflicts Co-authored-by: Niels de Jong <[email protected]> * Hotfix for Neo4j container issues with 5.3 (#293) * Updated deployment scripts to use minimal build without source maps (#271) * Changed build script to use mimimal (no source map) deployment * Added TODOs based on comments * Changing card image download logic (#273) * feature(): Changing download logic for card download by downloading the entire card instead of just the view. This kind of change adds also the buttons to the downloaded image, that is not ideal. * fix(download report image): added missing ref for card expanded view * Removed package-lock.json Co-authored-by: Alfred Rubin <[email protected]> Co-authored-by: Niels de Jong <[email protected]> * Dynamic Card titles (#270) * change of names * Resolving conflicts * Bug fix * Refactoring * Fixed replacement of params in card headers Co-authored-by: Niels de Jong <[email protected]> * Docs on custom map provider (#282) * Docs on custom map provider * Update docs/modules/ROOT/pages/user-guide/reports/map.adoc Co-authored-by: MariusC <[email protected]> Co-authored-by: MariusC <[email protected]> Co-authored-by: Niels de Jong <[email protected]> * Added release notes, bumped version number Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Harold Agudelo <[email protected]> Co-authored-by: Marius Conjeaud <[email protected]> Co-authored-by: “Bastien <“[email protected]”> Co-authored-by: Bastien Hubert <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Neil Menezes <[email protected]> Co-authored-by: MariusC <[email protected]> Co-authored-by: alfredorubin96 <[email protected]> Co-authored-by: Alfred Rubin <[email protected]>
neo4j-labs · Dec 16, 2022 · 4a99551 · 4a99551
1 parent a4f17bd
commit 4a99551
Show file tree

Hide file tree

Showing 136 changed files with 15,423 additions and 12,018 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,170 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint", "react"],
+  "extends": ["eslint:recommended", "prettier", "plugin:@typescript-eslint/recommended"], // this is optional
+  "env": {
+    "browser": true,
+    "node": true
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  },
+  "ignorePatterns": ["node_modules/**", "packages/**/dist/**", "packages/**/coverage/**"],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off", // Off for v1
+    "@typescript-eslint/ban-ts-comment": "off", // Off for v1
+    "@typescript-eslint/no-empty-function": "off", // Off for v1
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "vars": "all", "varsIgnorePattern": "^_*", "args": "after-used", "argsIgnorePattern": "^_" }
+    ],
+    "array-callback-return": "off", // Off for v1
+    "arrow-body-style": "off",
+    "block-scoped-var": "error",
+    "camelcase": "off", // Off for v1
+    "consistent-return": "off", // Off for v1
+    "consistent-this": ["error", "self"],
+    "constructor-super": "error",
+    "curly": ["error", "all"],
+    "default-case": "error",
+    "default-param-last": "off", // Off for v1
+    "dot-notation": "error",
+    "eqeqeq": "off", // Off for v1
+    "func-names": "error",
+    "func-style": [
+      "error",
+      "declaration",
+      {
+        "allowArrowFunctions": true
+      }
+    ],
+    "grouped-accessor-pairs": "error",
+    "line-comment-position": "off", // Off for v1
+    "lines-between-class-members": "error",
+    "max-depth": "error",
+    "max-len": [
+      "off", // Off for v1
+      {
+        "code": 120,
+        "comments": 120,
+        "ignoreUrls": true,
+        "ignoreTemplateLiterals": true
+      }
+    ],
+    "max-lines-per-function": ["off"],
+    "max-nested-callbacks": ["error", 5],
+    "max-statements": ["off"],
+    "max-statements-per-line": "error",
+    "no-alert": "off", // Off for v1
+    "no-array-constructor": "error",
+    "no-await-in-loop": "off", // Off for v1
+    "no-buffer-constructor": "error",
+    "no-caller": "error",
+    "no-confusing-arrow": "error",
+    "no-console": "warn",
+    "no-constructor-return": "error",
+    "no-constant-condition": "error",
+    "no-debugger": "warn",
+    "no-dupe-else-if": "error",
+    "no-else-return": "error",
+    "no-empty-function": [
+      "off", // Off for v1
+      {
+        "allow": ["constructors"]
+      }
+    ],
+    "no-eq-null": "off", // Off for V1
+    "no-eval": "error",
+    "no-extend-native": "error",
+    "no-extra-bind": "error",
+    "no-extra-label": "error",
+    "no-implicit-coercion": "error",
+    "no-implicit-globals": "error",
+    "no-implied-eval": "error",
+    "no-import-assign": "error",
+    "no-invalid-this": "off",
+    "no-iterator": "error",
+    "no-labels": "error",
+    "no-lone-blocks": "error",
+    "no-lonely-if": "error",
+    "no-loop-func": "error",
+    "no-magic-numbers": "off",
+    "no-multi-assign": "error",
+    "no-multi-str": "error",
+    "no-nested-ternary": "off", // Off for v1
+    "no-new": "error",
+    "no-new-func": "error",
+    "no-new-object": "error",
+    "no-new-wrappers": "error",
+    "no-octal-escape": "error",
+    "no-param-reassign": "off", // Off for v1
+    "no-path-concat": "error",
+    "no-plusplus": [
+      "error",
+      {
+        "allowForLoopAfterthoughts": true
+      }
+    ],
+    "no-proto": "off", // Off for v1
+    "no-restricted-globals": "error",
+    "no-return-assign": "error",
+    "no-return-await": "error",
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-setter-return": "error",
+    "no-sync": "error",
+    "no-tabs": "error",
+    "no-template-curly-in-string": "error",
+    "no-underscore-dangle": "off", // Off for v1
+    "no-unmodified-loop-condition": "error",
+    "no-unneeded-ternary": "error",
+    "no-unreachable": "error",
+    "no-unused-expressions": "off", // Off for v1
+    "no-useless-call": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-concat": "off", // Off for v1
+    "no-useless-rename": "error",
+    "no-useless-return": "error",
+    "no-var": "error",
+    "no-void": ["error", { "allowAsStatement": true }],
+    "one-var": ["error", "never"],
+    "operator-assignment": "error",
+    "padding-line-between-statements": "error",
+    "prefer-arrow-callback": "warn",
+    "prefer-const": "off", // Off for v1
+    "prefer-destructuring": [
+      // Off for v1
+      "warn",
+      {
+        "VariableDeclarator": {
+          "array": true,
+          "object": true
+        },
+        "AssignmentExpression": {
+          "array": false,
+          "object": false
+        }
+      }
+    ],
+    "prefer-numeric-literals": "warn",
+    "prefer-promise-reject-errors": "warn",
+    "prefer-rest-params": "warn",
+    "prefer-spread": "warn",
+    "prefer-template": "warn",
+    "radix": "off", // Off for v1
+    "require-atomic-updates": "error",
+    "require-await": "warn", // Warn for v1
+    "sort-keys": "off",
+    "spaced-comment": [
+      "warn",
+      "always",
+      {
+        "markers": ["/"]
+      }
+    ],
+    "symbol-description": "error",
+    "yoda": "error"
+  }
+}
diff --git a/.github/workflows/develop-deployment.yml b/.github/workflows/develop-deployment.yml
@@ -1,9 +1,9 @@
 name: Test/Deploy Develop
- 
+
 on:
  push:
    branches: [ develop ]
- 
+
 jobs:
  build-test:
    runs-on: ubuntu-latest
@@ -25,6 +25,8 @@ jobs:
        ./scripts/docker-neo4j-initializer/start-movies-db.sh
    - run: rm -rf docs
    - run: yarn install
+   - name: Eslint check
+     run: yarn run lint
    - name: Cypress run
      uses: cypress-io/github-action@v2
      with:
@@ -44,7 +46,7 @@ jobs:
      with:
        node-version: ${{ matrix.node-version }}
    - run: yarn install
-   - run: PRODUCTION=true && yarn run build
+   - run: yarn run build-minimal
    - name: Set AWS credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:

diff --git a/.github/workflows/develop-test.yml b/.github/workflows/develop-test.yml
@@ -1,10 +1,9 @@
 name: Test Develop
- 
+
 on:
  pull_request:
    branches: [ develop ]
-
-
+
 jobs:
  build-test:
    runs-on: ubuntu-latest
@@ -25,6 +24,8 @@ jobs:
        chmod +x ./scripts/docker-neo4j-initializer/start-movies-db.sh
        ./scripts/docker-neo4j-initializer/start-movies-db.sh
    - run: yarn install
+   - name: Eslint check
+     run: yarn run lint
    - name: Cypress run
      uses: cypress-io/github-action@v2
      with:

diff --git a/.github/workflows/master-deployment.yml b/.github/workflows/master-deployment.yml
@@ -1,10 +1,9 @@
 name: Test/Deploy Master
- 
+
 on:
  push:
    branches: [ master ]
-
-
+
 jobs:
  build-test:
    runs-on: ubuntu-latest
@@ -26,6 +25,8 @@ jobs:
         ./scripts/docker-neo4j-initializer/start-movies-db.sh
    - run: rm -rf docs
    - run: yarn install
+   - name: Eslint check
+     run: yarn run lint
    - name: Cypress run
      uses: cypress-io/github-action@v2
      with:
@@ -46,7 +47,7 @@ jobs:
 #        node-version: ${{ matrix.node-version }}
 #    - run: rm -rf docs
 #    - run: yarn install
-#    - run: yarn run build
+#    - run: yarn run build-minimal
 #    - name: Set AWS credentials
 #      uses: aws-actions/configure-aws-credentials@v1
 #      with:
@@ -78,7 +79,7 @@ jobs:
       context: .
       file: ./Dockerfile
       push: true
-      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.2.0
+      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.2.1
 #  build-npm:
 #    needs: build-test
 #    runs-on: ubuntu-latest
@@ -92,8 +93,8 @@ jobs:
 #      with:
 #        node-version: ${{ matrix.node-version }}
 #    - run: rm -rf docs
-#    - run: yarn install
-#    - run: yarn run build
+#    - run: yarn install-minimal
+#    - run: yarn run build-minimal
 #    - run: curl ${{ secrets.INDEX_HTML_DEPLOYMENT_URL }} > dist/index.html
 #    - run: npm pack
 #    - run: rm -rf target
@@ -128,7 +129,7 @@ jobs:
      with:
        node-version: ${{ matrix.node-version }}
    - run: cd gallery && yarn install
-   - run: cd gallery && CI=false yarn run build
+   - run: cd gallery && yarn run build
    - name: Set AWS credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:

diff --git a/.github/workflows/master-test.yml b/.github/workflows/master-test.yml
@@ -1,10 +1,9 @@
 name: Test Master
- 
+
 on:
  pull_request:
    branches: [ master ]
-
-
+
 jobs:
  build-test:
    runs-on: ubuntu-latest
@@ -25,6 +24,8 @@ jobs:
        chmod +x ./scripts/docker-neo4j-initializer/start-movies-db.sh
        ./scripts/docker-neo4j-initializer/start-movies-db.sh
    - run: yarn install
+   - name: Eslint check
+     run: yarn run lint
    - name: Cypress run
      uses: cypress-io/github-action@v2
      with:

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn run lint-staged
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,6 @@
+{
+  "*.ts": ["prettier --write", "eslint --fix"],
+  "*.tsx": ["prettier --write", "eslint --fix"],
+  "*.json": ["prettier --write"],
+  "*.js": ["prettier --write"]
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+coverage
+dist
+node_modules
+docs
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,12 @@
+{
+  "printWidth": 120,
+  "semi": true,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "useTabs": false,
+  "tabWidth": 2,
+  "arrowParens": "always",
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "endOfLine": "lf"
+}
diff --git a/Dockerfile b/Dockerfile
@@ -13,7 +13,7 @@ COPY ./package.json /usr/local/src/neodash/package.json
 
 RUN yarn install
 COPY ./ /usr/local/src/neodash
-RUN PRODUCTION=true && yarn run build
+RUN yarn run build-minimal
 
 # production stage
 FROM nginx:alpine AS neodash
@@ -38,4 +38,4 @@ RUN chown -R nginx:nginx /usr/share/nginx/html/
 USER nginx
 EXPOSE 5005
 HEALTHCHECK cmd curl --fail http://localhost:5005 || exit 1
-LABEL version="2.2.0"
+LABEL version="2.2.1"
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 
 ## NeoDash - Neo4j Dashboard Builder
-NeoDash is an open source tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports. 
+NeoDash is an open source tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports.
 
 ![screenshot](public/screenshot.png)
 
@@ -22,6 +22,23 @@ docker run -it --rm -p 5005:5005 nielsdejong/neodash
 
 See the [Developer Guide](https://neo4j.com/labs/neodash/2.1/developer-guide/) for more on installing, building, and running the application.
 
+## Coding practices
+In order to improve the code quality, we added a Prettier and a Linter to this repository.
+
+### Behavior
+While commiting, a pre-commit hook will be executed in order to prettify and run the Linter on your staged files. Linter warnings are currently accepted. The commands executed by this hook can be found in /.lintstagedrc.json.
+
+There is also a dedicated linting step in the Github project pipeline in order to catch each potential inconsistency.
+
+**Don't hesitate to setup your IDE formatting feature to use the Prettier module and our defined rules (.prettierrc.json).**
+
+### Manual execution
+If you want to **manually prettify all the project .ts and .tsx files**, you can run `yarn run format`.
+
+If you wan to **manually run linting of all your .ts and .tsx files**, you can run `yarn run lint`.
+
+If you wan to **manually run linting of all your .ts and .tsx staged files**, you can run `yarn run lint-staged`.
+
 ## User Guide
 NeoDash comes with built-in examples of dashboards and reports. For more details on the types of reports and how to customize them, see the [User Guide](
 https://neo4j.com/labs/neodash/2.1/user-guide/).