linting the backend

Author: Laoujin

.github/workflows/nodejs.yml

@@ -31,5 +31,6 @@ jobs:
       run: |
         npm install
         npm test
+        npm run lint
       env:
         CI: true

backend/.eslintrc.js

@@ -36,7 +36,6 @@ module.exports = {
     "max-len": [1, { "code": 140 }],
     "dot-notation": [1],
     "padded-blocks": [0],
-    "object-curly-newline": ["error", { "ImportDeclaration": "never" }],
     "no-plusplus": [0],
     "no-console": "warn",
     "arrow-parens": ["error", "as-needed"],
@@ -56,8 +55,8 @@ module.exports = {
     "@typescript-eslint/indent": ["error", 2],
     "object-property-newline": [0],
     "object-curly-newline": ["error", {
-      "ObjectExpression": { "multiline": true, "minProperties": 4 },
-      "ObjectPattern": { "multiline": true, "minProperties": 4 },
+      "ObjectExpression": { "multiline": true, "minProperties": 5 },
+      "ObjectPattern": { "multiline": true, "minProperties": 5 },
       "ImportDeclaration": { "multiline": true, "minProperties": 8 },
       "ExportDeclaration": { "multiline": true, "minProperties": 3 }
     }],

backend/src/config.ts

@@ -1,7 +1,7 @@
 import * as dotenv from 'dotenv';
 
 if (process.env.NODE_ENV === 'development') {
-  console.log('Starting with NODE_ENV=development');
+  console.log('Starting with NODE_ENV=development'); // eslint-disable-line no-console
   dotenv.config();
 }
 

backend/src/controllers/attachments.ts

@@ -6,8 +6,8 @@ import {IAttachmentCollection, IAttachmentModelConfig, attachmentModelsConfig, I
 import {CollectionNames, SocketEventTypes} from '../models/common';
 import {IInvoice} from '../models/invoices';
 import {IProjectMonthOverview, TimesheetCheckAttachmentType} from '../models/projectsMonth';
-import { emitEntityEvent } from './utils/entity-events';
-import { ConfacRequest } from '../models/technical';
+import {emitEntityEvent} from './utils/entity-events';
+import {ConfacRequest} from '../models/technical';
 
 
 const saveAttachment = async (req: Request, attachmentModelConfig: IAttachmentModelConfig, file: Express.Multer.File) => {
@@ -35,7 +35,7 @@ const saveAttachment = async (req: Request, attachmentModelConfig: IAttachmentMo
       SocketEventTypes.EntityUpdated,
       standardCollectionName,
       result._id,
-      result
+      result,
     );
   }
 
@@ -60,7 +60,8 @@ export const saveAttachmentController = async (req: Request, res: Response) => {
 
   if (attachmentModelConfig.standardCollectionName === CollectionNames.ATTACHMENTS_PROJECT_MONTH_OVERVIEW) {
     const month = id;
-    const inserted = await req.db.collection<IProjectMonthOverview>(CollectionNames.ATTACHMENTS_PROJECT_MONTH_OVERVIEW).findOneAndUpdate({month}, {
+    const projectMonthOverviewCollection = req.db.collection<IProjectMonthOverview>(CollectionNames.ATTACHMENTS_PROJECT_MONTH_OVERVIEW);
+    const inserted = await projectMonthOverviewCollection.findOneAndUpdate({month}, {
       $set: {
         [type]: file.buffer,
         fileDetails: {
@@ -95,17 +96,18 @@ export const saveAttachmentController = async (req: Request, res: Response) => {
 
 
 
-
-
-
 const deleteAttachment = async (id: string, type: string, req: Request, attachmentModelConfig: IAttachmentModelConfig) => {
   const {standardCollectionName, attachmentCollectionName} = attachmentModelConfig;
 
   const data = await req.db.collection<IAttachments>(standardCollectionName).findOne({_id: new ObjectID(id)});
   const {_id, attachments} = data!;
 
   const updatedAttachments = attachments.filter(attachment => attachment.type !== type);
-  const inserted = await req.db.collection(standardCollectionName).findOneAndUpdate({_id}, {$set: {attachments: updatedAttachments}}, {returnOriginal: false});
+  const inserted = await req.db.collection(standardCollectionName).findOneAndUpdate(
+    {_id},
+    {$set: {attachments: updatedAttachments}},
+    {returnOriginal: false},
+  );
 
   const result = inserted.value;
   if (result) {
@@ -114,7 +116,7 @@ const deleteAttachment = async (id: string, type: string, req: Request, attachme
       SocketEventTypes.EntityUpdated,
       standardCollectionName,
       result._id,
-      result
+      result,
     );
   }
 
@@ -155,14 +157,8 @@ export const deleteAttachmentController = async (req: Request, res: Response) =>
 
 
 
-
-
-
-
-
-
 export const getAttachmentController = async (req: Request, res: Response) => {
-  const { id, model, type, fileName } = req.params;
+  const {id, model, type, fileName} = req.params;
   const attachmentModelConfig: IAttachmentModelConfig | undefined = attachmentModelsConfig.find(m => m.name === model);
 
   if (!attachmentModelConfig) {
@@ -237,14 +233,6 @@ export const getAttachmentController = async (req: Request, res: Response) => {
 
 
 
-
-
-
-
-
-
-
-
 export const createZipWithInvoicesController = async (req: Request, res: Response) => {
   const invoiceIds: ObjectID[] = req.body.map((invoiceId: string) => new ObjectID(invoiceId));
 

backend/src/controllers/clients.ts

@@ -29,7 +29,11 @@ export const saveClient = async (req: ConfacRequest, res: Response) => {
   if (_id) {
     client.audit = updateAudit(client.audit, req.user);
     const clientsCollection = req.db.collection<IClient>(CollectionNames.CLIENTS);
-    const {value: originalClient} = await clientsCollection.findOneAndUpdate({_id: new ObjectID(_id)}, {$set: client}, {returnOriginal: true});
+    const {value: originalClient} = await clientsCollection.findOneAndUpdate(
+      {_id: new ObjectID(_id)},
+      {$set: client},
+      {returnOriginal: true},
+    );
 
     await saveAudit(req, 'client', originalClient, client);
     const clientResponse = {_id, ...client};

backend/src/controllers/config.ts

@@ -7,7 +7,7 @@ import {getTemplatesPath} from './utils';
 import {CollectionNames, SocketEventTypes, updateAudit} from '../models/common';
 import {ConfacRequest} from '../models/technical';
 import {saveAudit} from './utils/audit-logs';
-import { emitEntityEvent } from './utils/entity-events';
+import {emitEntityEvent} from './utils/entity-events';
 
 export const getCompanyConfig = async (req: Request, res: Response) => {
   const companyConfig: ICompanyConfig | null = await req.db.collection(CollectionNames.CONFIG).findOne({key: 'conf'});
@@ -21,14 +21,12 @@ export const getCompanyConfig = async (req: Request, res: Response) => {
 
 
 /** Unprotected route */
-export const getSecurityConfig = async (req: Request, res: Response) => {
-  return res.send({
-    googleClientId: appConfig.security.clientId,
-    jwtInterval: Math.floor(appConfig.jwt.expiresIn / 2),
-    env: appConfig.ENVIRONMENT,
-    tag: appConfig.tag,
-  });
-};
+export const getSecurityConfig = async (req: Request, res: Response) => res.send({
+  googleClientId: appConfig.security.clientId,
+  jwtInterval: Math.floor(appConfig.jwt.expiresIn / 2),
+  env: appConfig.ENVIRONMENT,
+  tag: appConfig.tag,
+});
 
 
 
@@ -63,7 +61,7 @@ export const getTemplates = (req: Request, res: Response) => {
 
 
 /** Get logs_audit for an entity */
-export const getAudit = async (req: Request<void, void, void, {model: string, modelId: number}>, res: Response) => {
+export const getAudit = async (req: Request<void, void, void, {model: string; modelId: number}>, res: Response) => {
   const logs = await req.db.collection('logs_audit')
     .find({model: req.query.model, modelId: new ObjectID(req.query.modelId)})
     .toArray();

backend/src/controllers/emailInvoices.ts

@@ -1,15 +1,15 @@
 import {Request, Response} from 'express';
 import PDFMerge from 'pdf-merge';
 import sgMail from '@sendgrid/mail';
-import {MailData} from '@sendgrid/helpers/classes/mail';
+import {MailData} from '@sendgrid/helpers/classes/mail'; // eslint-disable-line import/no-extraneous-dependencies
 import fs from 'fs';
 import tmp from 'tmp';
 import {ObjectID} from 'mongodb';
 import {IAttachmentCollection, ISendGridAttachment} from '../models/attachments';
 import {IEmail} from '../models/clients';
 import {CollectionNames, IAttachment, SocketEventTypes} from '../models/common';
-import { emitEntityEvent } from './utils/entity-events';
-import { ConfacRequest } from '../models/technical';
+import {emitEntityEvent} from './utils/entity-events';
+import {ConfacRequest} from '../models/technical';
 
 
 type EmailAttachmentRequest = {
@@ -24,28 +24,31 @@ export const emailInvoiceController = async (req: Request<{id: number}, any, Ema
   const invoiceId = req.params.id;
   const email = req.body;
 
-  const attachmentTypes = email.attachments.map(a => a.type).reduce((acc: { [key: string]: number; }, cur) => {
+  const attachmentTypes = email.attachments.map(a => a.type).reduce((acc: {[key: string]: number}, cur) => {
     acc[cur] = 1;
     return acc;
   }, {});
   const attachmentBuffers: IAttachmentCollection | null = await req.db
     .collection(CollectionNames.ATTACHMENTS)
     .findOne({_id: new ObjectID(invoiceId)}, attachmentTypes);
 
-  if (!attachmentBuffers)
-    return res.status(500).send({message: "Couldn't find attachments!?"});
+  if (!attachmentBuffers) {
+    return res.status(500).send({message: 'Couldn\'t find attachments!?'});
+  }
 
-  if (email.combineAttachments && email.attachments.some(attachment => attachment.fileType !== 'application/pdf'))
+  if (email.combineAttachments && email.attachments.some(attachment => attachment.fileType !== 'application/pdf')) {
     return res.status(400).send({message: 'Emailing with combineAttachments=true: Can only merge pdfs'});
+  }
 
 
   const data = await req.db.collection('attachments_config').findOne({});
   const termsAndConditions: Buffer = data?.TermsAndConditions?.buffer;
 
   const mailData = await buildInvoiceEmailData(email, attachmentBuffers, termsAndConditions);
   const emailRes = await sendEmail(res, mailData);
-  if (emailRes)
+  if (emailRes) {
     return emailRes;
+  }
 
   if (req.query.emailInvoiceOnly) {
     await sendInvoiceOnlyEmail(email, attachmentBuffers, req.query.emailInvoiceOnly);
@@ -62,7 +65,7 @@ export const emailInvoiceController = async (req: Request<{id: number}, any, Ema
       SocketEventTypes.EntityUpdated,
       CollectionNames.INVOICES,
       updatedInvoice.value._id,
-      {...updatedInvoice.value, lastEmail: lastEmailSent}
+      {...updatedInvoice.value, lastEmail: lastEmailSent},
     );
   }
 
@@ -74,7 +77,7 @@ export const emailInvoiceController = async (req: Request<{id: number}, any, Ema
 async function buildInvoiceEmailData(
   email: EmailRequest,
   attachmentBuffers: IAttachmentCollection,
-  termsAndConditions: Buffer
+  termsAndConditions: Buffer,
 ): Promise<MailData> {
 
   // Make sure the invoice is the first document in the array
@@ -125,6 +128,7 @@ async function buildInvoiceEmailData(
     fs.writeSync(termsCondFile.fd, termsAndConditions);
 
     const mergedInvoicePdf: Buffer = await PDFMerge([invoiceFile, termsCondFile].map(f => f.name));
+    // eslint-disable-next-line no-confusing-arrow
     sendGridAttachments = sendGridAttachments.map((att, idx) => idx === 0 ? {...att, content: mergedInvoicePdf} : att);
 
     invoiceFile.removeCallback();
@@ -178,8 +182,13 @@ async function sendEmail(res: Response, mailData: MailData): Promise<Response |
 /**
  * Send email with only the invoice, not the timesheet etc
  * This email is sent only once
- **/
-async function sendInvoiceOnlyEmail(email: EmailRequest, attachmentBuffers: IAttachmentCollection, emailInvoiceOnly: string): Promise<void> {
+ * */
+async function sendInvoiceOnlyEmail(
+  email: EmailRequest,
+  attachmentBuffers: IAttachmentCollection,
+  emailInvoiceOnly: string,
+): Promise<void> {
+
   const attachment = email.attachments.find(x => x.type === 'pdf')!;
   const invoiceOnlyAttachments = [{
     content: attachmentBuffers[attachment.type].toString('base64'),
@@ -197,6 +206,6 @@ async function sendInvoiceOnlyEmail(email: EmailRequest, attachmentBuffers: IAtt
   };
 
   await sgMail.send(invoiceOnlyData, false).then(() => {
-    console.log(`emailInvoiceOnly sent to ${emailInvoiceOnly}`);
+    console.log(`emailInvoiceOnly sent to ${emailInvoiceOnly}`); // eslint-disable-line no-console
   });
 }