Merge pull request #2 from graasp/1/initAndSetup

1/init and setup

Author: spaenleh

.eslintignore

@@ -0,0 +1,5 @@
+build
+public
+coverage
+src/registerServiceWorker.js
+cypress/integration/examples

.eslintrc.json .eslintrc.eslintrc.json renamed to .eslintrc

@@ -4,11 +4,16 @@
     "es2021": true
   },
   "extends": [
-    "plugin:react/recommended",
     "airbnb",
     "plugin:@typescript-eslint/recommended",
-    "prettier"
+    "prettier",
+    "plugin:react/recommended",
+    "plugin:cypress/recommended"
   ],
+  "globals": {
+    "cy": true,
+    "Cypress": true
+  },
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaFeatures": {
@@ -19,6 +24,9 @@
   },
   "plugins": ["react", "react-hooks", "@typescript-eslint", "prettier"],
   "rules": {
+    "import/no-import-module-exports": "off",
+    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
+    "import/prefer-default-export": "off",
     "prettier/prettier": "error",
     "import/extensions": [
       "error",
@@ -34,6 +42,8 @@
         "allowExpressions": true
       }
     ],
+    "@typescript-eslint/no-var-requires": "off",
+    "global-require": "off",
     "react-hooks/rules-of-hooks": "error",
     "react-hooks/exhaustive-deps": "warn",
     "comma-dangle": "off",

.github/workflows/cypress.yml

@@ -0,0 +1,57 @@
+name: cypress tests
+on: [push]
+jobs:
+  cypress-run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          cache: 'yarn'
+
+      - name: install yarn
+        # avoid checksum errors with github packages
+        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+
+      - name: cypress run
+        uses: cypress-io/github-action@v2
+        env:
+          REACT_APP_API_HOST: http://localhost:3636
+          REACT_APP_GRAASP_DOMAIN: localhost
+          REACT_APP_GRAASP_APP_ID: id-1234567890
+          REACT_APP_MOCK_API: true
+          NODE_ENV: test
+        with:
+          install: false
+          config: baseUrl=http://localhost:3000
+          start: yarn start:ci
+          wait-on: 'http://localhost:3000'
+          wait-on-timeout: 180
+          browser: chrome
+          headless: true
+          quiet: true
+
+      # after the test run completes
+      # store videos and any screenshots
+      # NOTE: screenshots will be generated only if E2E test failed
+      # thus we store screenshots only on failures
+      # Alternative: create and commit an empty cypress/screenshots folder
+      # to always have something to upload
+      - uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: cypress-screenshots
+          path: cypress/screenshots
+      # Test run video was always captured, so this action uses "always()" condition
+      - uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: cypress-videos
+          path: cypress/videos
+
+      - name: coverage report
+        run: npx nyc report --reporter=text-summary

.gitignore

@@ -7,6 +7,7 @@
 
 # testing
 /coverage
+/.nyc_output
 
 # production
 /build
@@ -16,11 +17,27 @@
 .env.local
 .env.development.local
 .env.test.local
+.env.test
+.env.prod
 .env.production.local
 
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
+# yarn
+.yarn/
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+yarn-error.log
+
 # editor files
 /.idea
+
+# cypress
+cypress/screenshots/
+cypress/videos/
+cypress/downloads/

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn commitlint --edit $1
+yarn commitlint --edit ${1}

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn pretty-quick --staged && yarn lint && yarn test:once
+yarn pretty-quick --staged && yarn lint && yarn test

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn lint && yarn test:once && yarn build
+yarn lint && yarn build && yarn test

.prettierrc

@@ -1,7 +1,10 @@
 {
-  "semi": true,
   "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
   "singleQuote": true,
   "jsxSingleQuote": false,
-  "printWidth": 80
+  "importOrder": ["^react", "^@?graasp*", "^@?mui*", "^@.*", "^[./]"],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
 }

.versionrc

@@ -0,0 +1,33 @@
+{
+  "types": [
+    {
+      "type": "feat",
+      "section": "Features"
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes"
+    },
+    {
+      "type": "test",
+      "section": "Tests"
+    },
+    {
+      "type": "build",
+      "section": "Build System"
+    },
+    {
+      "type": "docs",
+      "section": "Documentation"
+    },
+    {
+      "type": "ci",
+      "section": "Continuous Integration"
+    },
+    {
+      "type": "chore",
+      "section": "Chores",
+      "hidden": true
+    }
+  ]
+}