Fix linting errors

.eslintrc.js

@@ -1,13 +1,13 @@
 module.exports = {
   root: true,
-  env: {node: true, es2020: true},
+  env: {node: true, es2020: true, jest: true},
   extends: [
     'eslint:recommended'
   ],
   ignorePatterns: ['dist', '.eslintrc.cjs', 'tests'],
   parserOptions: {ecmaVersion: 'latest', sourceType: 'module'},
   parser: '@typescript-eslint/parser',
-  plugins: ['jsdoc'],
+  plugins: ['jsdoc', 'jest'],
   rules: {
     'prefer-const': ['error', {
       'destructuring': 'any',
@@ -50,7 +50,7 @@ module.exports = {
     // 'jsdoc/require-example': 1,
     // 'jsdoc/require-file-overview': 1,
     'jsdoc/require-hyphen-before-param-description': 1,
-    'jsdoc/require-jsdoc': 1, // Recommended
+    'jsdoc/require-jsdoc': [1, { contexts: ['ClassDeclaration', 'ClassProperty', 'FunctionDeclaration', 'MethodDefinition'] }],
     'jsdoc/require-param': 1, // Recommended
     'jsdoc/require-param-description': 1, // Recommended
     'jsdoc/require-param-name': 1, // Recommended

.gitignore

@@ -3,7 +3,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
-
+.idea/
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
@@ -108,4 +108,6 @@ src/config/authentication_map.ts
 src/utils/rsp.ts
 src/utils/DecentralizedFileStreamer.ts
 src/utils/UpdateLDES.ts
-aggregation-data
+aggregation-data
+logs/
+scratch/

README.md

@@ -22,7 +22,7 @@ We employ [Type Indexes](https://solid.github.io/type-indexes/) to store the loc
 npm run start-solid-server
 ``` 
 The command will start a Solid Server on the port 3000 with a Solid Pod named `aggregation_pod` which can be accessed at `http://localhost:3000/aggregation_pod/`. The aggregation results are stored in the aggregator's Solid Pod in form of the LDES stream using the [LDES in LDP](https://woutslabbinck.github.io/LDESinLDP/) specification.
-
+- Create a folder and a file named `logs/aggregation.log` in the root directory of the project. The logs of the Solid Stream Aggregator are stored in this file.
 - Now, start the Solid Stream Aggregator with the command
 ```bash
 npm run start aggregation 
@@ -60,4 +60,4 @@ This code is copyrighted by [Ghent University - imec](https://www.ugent.be/ea/id
 
 ## Contact
 
-For any questions, please contact [Kush](mailto:kushagrasingh.bisen@ugent.be) or create an issue in the repository [here])(https://github.com/SolidLabResearch/solid-stream-aggregator/issues) .
+For any questions, please contact [Kush](mailto:kushagrasingh.bisen@ugent.be) or create an issue in the repository [here](https://github.com/SolidLabResearch/solid-stream-aggregator/issues) .

esdoc.json

@@ -0,0 +1,6 @@
+{
+    "source": "./src",
+    "destination": "./docs",
+    "plugins": [{"name": "esdoc-standard-plugin"}]
+  }
+