test eslint

.env

+PORT=8000
\ No newline at end of file

.eslintrc.json

+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "airbnb-typescript/base",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parserOptions": {
+      "project": "./tsconfig.json",
+      "ecmaVersion": 2021
+     },
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint"],
+    "settings": {
+        "import/resolver": {
+          "node": {
+            "extensions": [".js", ".jsx", ".ts", ".tsx"]
+          }
+        }
+    },
+    "rules": {
+        "linebreak-style": [
+            "error",
+            "windows"
+        ],
+        "import/prefer-default-export":"off",
+        "@typescript-eslint/camelcase":"off",
+        "@typescript-eslint/no-var-requires":"off"
+    }
+  }
+  
\ No newline at end of file

.gitignore

+node_modules
+build
+npm-debug.log
+.DS_Store
\ No newline at end of file

.gitlab-ci.yml

+variables:
+  SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"  # Defines the location of the analysis task cache
+  GIT_DEPTH: "0"  # Tells git to fetch all the branches of the project, required by the analysis task
+sonarcloud-check:
+  image:
+    name: sonarsource/sonar-scanner-cli:latest
+    entrypoint: [""]
+  cache:
+    key: "${CI_JOB_NAME}"
+    paths:
+      - .sonar/cache
+  script:
+    - sonar-scanner
+  only:
+    - merge_requests
+    - master
+    - develop

7

++ openapi-types@9.3.0
+added 1 package from 1 contributor and audited 807 packages in 4.508s
+
+89 packages are looking for funding
+  run `npm fund` for details
+
+found 0 vulnerabilities
+

__test__/README.md

+----Como correr los test ----
+
+Para crear un test para un correspondiente archivo se debe proceder de la siguiente forma:
+    -Para un archivo ```ejemplo.ts``` crear dentro de la carpeta __test__ un archivo llamado ```ejemplo.test.js```
+    -Dentro del archivo ejemplo.test.ts incluir el archivo ejemplo.ts con ```const sum = require('./../ejemplo');```
+    -Para cada función a probar ```funcionEjemplo(arg)``` la forma de diseñar un test es:
+        -```test(Desc, () => {expect(funcionEjemplo(ejemploArg)).toBe(resultado);});```
+    -Aqui los argumentos son:
+        -```funcionEjemplo``` = es la funcion que esta siendo probada, que tiene como inputs ```arg```
+        -```Desc```           = es un string, que debe describir brevemente el test que se lleva a cabo
+        -```ejemploArg```     = son los argumentos con los cuales se testeará la ```funcionEjemplo```
+        -```resultado```      = es el retorno esperado de ```funcionEjemplo``` con los argumentos ```ejemploArg```
+    -Pueden agrupar los test con ```describe("Nombre del grupo de tests", () =>{}```, dentro de ese bloque se especifican los test al igual que antes, cambiando ```test``` por ```it```
+
+Los tests son ejecutados de las siguientes formas:
+    -Manualmente pueden ejecutarse todos mediante ```npm run test```
+    -Individualmente cada test puede ser ejecutado con ```npm test -- -t "Nombre del test" ``` (El nombre es el argumento del ```describe``` previamente mencionado)
+    -Alternativamente todos los test son ejecutados al llevar a cabo un push. Si uno de los test no es exitoso, el push no se lleva a cabo
\ No newline at end of file

package.json

+{
+  "name": "repp_backend",
+  "version": "1.0.0",
+  "description": "Herramienta de calculo del requerimiento energetico ponderado de una poblacion, llamado REPP.",
+  "main": "index.ts",
+  "dependencies": {
+    "config.json": "0.0.4",
+    "express": "^4.17.1",
+    "gulp-eslint": "^6.0.0",
+    "openapi-types": "^9.3.0",
+    "swagger-jsdoc": "^6.1.0",
+    "swagger-ui-express": "^4.1.6",
+    "tsconfig.json": "^1.0.10",
+    "xlsx": "^0.17.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/node": "^16.7.10",
+    "@typescript-eslint/eslint-plugin": "^2.34.0",
+    "@typescript-eslint/parser": "^2.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb": "^18.2.1",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-airbnb-typescript": "^7.2.1",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-react": "^7.21.5",
+    "eslint-plugin-react-hooks": "^4.0.8",
+    "husky": "^4.3.8",
+    "jest": "^27.0.6",
+    "lint-staged": "^11.1.2",
+    "nodemon": "^2.0.12",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.4.2"
+  },
+  "scripts": {
+    "start": "nodemon ./src/index.ts",
+    "test": "jest",
+    "pretest": "./node_modules/.bin/eslint --ignore-path .gitignore . --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.fing.edu.uy/julieta.dubra/repp.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.ts": [
+      "./node_modules/.bin/eslint --fix",
+      "git add"
+    ]
+  }
+}

sonar-project.properties

+sonar.projectKey=repp_backend
+sonar.organization=pis
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=repp_backend
+#sonar.projectVersion=1.0
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
+#sonar.sourceEncoding=UTF-8
\ No newline at end of file

src/Controllers/ExcelController.ts

+/* eslint-disable no-console */
+import { Request, Response } from 'express';
+
+const parseExcel = async (req: Request, res: Response) => {
+  console.log(req);
+  console.log(res);
+};
+
+module.exports = {
+  parseExcel,
+};

src/DAOs/README.txt

+Aca van los DAOs, los daos son los archivos que tienen comunicacion directa con la BD. Ningun otro archivo que no sea un dao puede tener acceso directo a la BD
\ No newline at end of file

src/Enum/README.txt

+Aca van los enumerados, elemental watson
\ No newline at end of file

src/Interfaces/README.txt

+Aca van las interfaces, acordarse de como nombrarlas, esta en el documento en Teams
\ No newline at end of file

src/Models/README.txt

+Aca van los modelos, osea los "tipos"
\ No newline at end of file

src/Services/ExcelPaserService.ts

+import * as XLSX from 'xlsx';
+
+const parseExcel = (excelFile: string) => {
+  XLSX.readFile(excelFile);
+};
+
+module.exports = {
+  parseExcel,
+};

src/Services/README.txt

+Aca van los servicios, oh wew
\ No newline at end of file

src/index.ts

+/* eslint-disable no-console */
+import express, { Application } from 'express';
+
+const swaggerJsDoc = require('swagger-jsdoc');
+const swaggerUi = require('swagger-ui-express');
+
+const app: Application = express();
+const PORT = process.env.PORT || 8000;
+
+// swagger init
+const swaggerOptions = {
+  swaggerDefinition: {
+    openapi: '3.0.0',
+    info: {
+      title: 'REPP Rest API',
+      description: '',
+      servers: ['http://localhost:3000'],
+    },
+  },
+  apis: ['src/routes.ts'],
+};
+const swaggerDocs = swaggerJsDoc(swaggerOptions);
+
+// middlewares
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));
+
+app.use(require('./routes.ts'));
+
+app.listen(PORT, (): void => {
+  console.log(`REPP Backend running here 👉 https://localhost:${PORT}`);
+});
+
+function q() {
+  return NaN;
+}

src/routes.ts

+import { Request, Response } from 'express';
+
+const { Router } = require('express');
+const { parseExcel } = require('./Controllers/ExcelController.ts');
+
+const router = Router();
+
+router.get('/', (req: Request, res: Response): void => {
+  res.send('Hey! This is REPP API, you can go to /api-docs to learn more!');
+});
+
+// Che esto es para ejemplo de como usar swagger, hay que arreglarlo
+// TODO
+/**
+ * @swagger
+ * /excelParser:
+ *  post:
+ *      tags:
+ *          -   parser
+ *      description: Excel Parser
+ *      requestBody:
+ *          required: true
+ *          content:
+ *              application/json:
+ *                  schema:
+ *                      type: object
+ *                      required:
+ *                          -   email
+ *                          -   password
+ *                      properties:
+ *                          excel:
+ *                              type: string
+ *      responses:
+ *          '200':
+ *              description: returns the parsed JSON of the excel file provided
+ *              content:
+ *                  application/json:
+ *                      schema:
+ *                          type: object
+ *                          properties:
+ *                              excelParsed:
+ *                                  type: string
+ */
+router.post('/excelParser', parseExcel);
+
+module.exports = router;

tsconfig.json

+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
+    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    // "outDir": "./",                              /* Redirect output structure to the directory. */
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                                 /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
+  }
+}