Add prettier eslint config

Author: hop-dev

eslint.config.mjs

@@ -1,5 +1,7 @@
 import tseslint from '@typescript-eslint/eslint-plugin';
 import tsparser from '@typescript-eslint/parser';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+
 import js from '@eslint/js';
 import globals from 'globals';
 export default [
@@ -12,13 +14,14 @@ export default [
     },
     plugins: {
       '@typescript-eslint': tseslint,
+      ...eslintPluginPrettierRecommended.plugins,
     },
     rules: {
       ...js.configs.recommended.rules,
       ...tseslint.configs['eslint-recommended'].rules,
       ...tseslint.configs.recommended.rules,
-      indent: ['error', 2],
-      quotes: ['error', 'single'],
+      ...eslintPluginPrettierRecommended.rules,
+      'prettier/prettier': ['error', { singleQuote: true }]
     },
     files: ['src/**/*.ts'],
   },

package.json

@@ -40,6 +40,7 @@
   "devDependencies": {
     "@types/cli-progress": "3.11.6",
     "@types/inquirer": "9.0.7",
+    "@types/lodash-es": "^4.17.12",
     "@types/uuid": "10.0.0",
     "@typescript-eslint/eslint-plugin": "8.23.0",
     "@typescript-eslint/parser": "8.23.0",
@@ -48,6 +49,9 @@
     "eslint": "9.20.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-config-airbnb-typescript": "18.0.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "prettier": "3.5.0",
     "typescript": "5.7.3"
   }
 }

src/commands/asset_criticality.ts

@@ -1,12 +1,23 @@
 import { faker } from '@faker-js/faker';
 import { generateNewSeed } from '../constants';
-import { assignAssetCriticalityToEntities, createRandomHost, createRandomUser } from './entity-store';
-
+import {
+  assignAssetCriticalityToEntities,
+  createRandomHost,
+  createRandomUser,
+} from './entity-store';
 
 /**
  * Generate asset criticality
  */
-export const generateAssetCriticality = async ({ users, hosts, seed = generateNewSeed() }: { users: number; hosts: number; seed?: number}) => {
+export const generateAssetCriticality = async ({
+  users,
+  hosts,
+  seed = generateNewSeed(),
+}: {
+  users: number;
+  hosts: number;
+  seed?: number;
+}) => {
   faker.seed(seed);
 
   try {
@@ -17,12 +28,12 @@ export const generateAssetCriticality = async ({ users, hosts, seed = generateNe
     const generatedHosts = faker.helpers.multiple(createRandomHost, {
       count: hosts,
     });
-    
+
     await assignAssetCriticalityToEntities(generatedUsers, 'user.name');
     console.log(`Assigned asset criticality to ${generatedUsers.length} users`);
     await assignAssetCriticalityToEntities(generatedHosts, 'host.name');
     console.log(`Assigned asset criticality to ${generatedHosts.length} hosts`);
-    
+
     console.log('Finished generating asset criticality');
   } catch (error) {
     console.log('Error: ', error);

src/commands/documents.ts

@@ -1,20 +1,30 @@
-
 import createAlerts, { BaseCreateAlertsReturnType } from '../createAlerts';
 import createEvents from '../createEvents';
 import eventMappings from '../mappings/eventMappings.json' assert { type: 'json' };
 import { getEsClient, indexCheck } from './utils/index';
 import { getConfig } from '../get_config';
-import { MappingTypeMapping, BulkOperationContainer } from '@elastic/elasticsearch/lib/api/types';
+import {
+  MappingTypeMapping,
+  BulkOperationContainer,
+} from '@elastic/elasticsearch/lib/api/types';
 import pMap from 'p-map';
 import { chunk } from 'lodash-es';
 import cliProgress from 'cli-progress';
 import { faker } from '@faker-js/faker';
 import { getAlertIndex } from '../utils';
 
 const config = getConfig();
-const client = getEsClient(); 
-
-const generateDocs = async ({ createDocs, amount, index }: {createDocs: DocumentCreator; amount: number; index: string}) => {
+const client = getEsClient();
+
+const generateDocs = async ({
+  createDocs,
+  amount,
+  index,
+}: {
+  createDocs: DocumentCreator;
+  amount: number;
+  index: string;
+}) => {
   if (!client) {
     throw new Error('failed to create ES client');
   }
@@ -26,7 +36,7 @@ const generateDocs = async ({ createDocs, amount, index }: {createDocs: Document
       Math.min(limit, amount),
       generated,
       createDocs,
-      index
+      index,
     );
     try {
       const result = await bulkUpsert(docs);
@@ -51,18 +61,25 @@ const bulkUpsert = async (docs: unknown[]) => {
 };
 
 interface DocumentCreator {
-	(descriptor: { id_field: string, id_value: string }): object;
+  (descriptor: { id_field: string; id_value: string }): object;
 }
 
-const alertToBatchOps = (alert: BaseCreateAlertsReturnType, index: string): unknown[] => {
+const alertToBatchOps = (
+  alert: BaseCreateAlertsReturnType,
+  index: string,
+): unknown[] => {
   return [
     { index: { _index: index, _id: alert['kibana.alert.uuid'] } },
     { ...alert },
   ];
+};
 
-}
-
-const createDocuments = (n: number, generated: number, createDoc: DocumentCreator, index: string): unknown[] => {
+const createDocuments = (
+  n: number,
+  generated: number,
+  createDoc: DocumentCreator,
+  index: string,
+): unknown[] => {
   return Array(n)
     .fill(null)
     .reduce((acc, _, i) => {
@@ -82,9 +99,12 @@ const createDocuments = (n: number, generated: number, createDoc: DocumentCreato
     }, []);
 };
 
-
-export const generateAlerts = async (alertCount: number, hostCount: number, userCount: number, space: string) => {
-
+export const generateAlerts = async (
+  alertCount: number,
+  hostCount: number,
+  userCount: number,
+  space: string,
+) => {
   if (userCount > alertCount) {
     console.log('User count should be less than alert count');
     process.exit(1);
@@ -95,33 +115,53 @@ export const generateAlerts = async (alertCount: number, hostCount: number, user
     process.exit(1);
   }
 
-  console.log(`Generating ${alertCount} alerts containing ${hostCount} hosts and ${userCount} users in space ${space}`);
+  console.log(
+    `Generating ${alertCount} alerts containing ${hostCount} hosts and ${userCount} users in space ${space}`,
+  );
   const concurrency = 10; // how many batches to send in parallel
   const batchSize = 2500; // number of alerts in a batch
   const no_overrides = {};
 
-  const batchOpForIndex = ({ userName, hostName } : { userName: string, hostName: string }) => alertToBatchOps(createAlerts(no_overrides, { userName, hostName, space }), getAlertIndex(space));
-
+  const batchOpForIndex = ({
+    userName,
+    hostName,
+  }: {
+    userName: string;
+    hostName: string;
+  }) =>
+    alertToBatchOps(
+      createAlerts(no_overrides, { userName, hostName, space }),
+      getAlertIndex(space),
+    );
 
   console.log('Generating entity names...');
-  const userNames = Array.from({ length: userCount }, () => faker.internet.userName());
-  const hostNames = Array.from({ length: hostCount }, () => faker.internet.domainName());
+  const userNames = Array.from({ length: userCount }, () =>
+    faker.internet.userName(),
+  );
+  const hostNames = Array.from({ length: hostCount }, () =>
+    faker.internet.domainName(),
+  );
 
-  console.log('Assigning entity names...')
+  console.log('Assigning entity names...');
   const alertEntityNames = Array.from({ length: alertCount }, (_, i) => ({
     userName: userNames[i % userCount],
     hostName: hostNames[i % hostCount],
   }));
-  
+
   console.log('Entity names assigned. Batching...');
-  const operationBatches = chunk(alertEntityNames, batchSize).map((batch) => 
-    batch.flatMap(batchOpForIndex)
+  const operationBatches = chunk(alertEntityNames, batchSize).map((batch) =>
+    batch.flatMap(batchOpForIndex),
   );
 
   console.log('Batching complete. Sending to ES...');
 
-  console.log(`Sending in ${operationBatches.length} batches of ${batchSize} alerts, with up to ${concurrency} batches in parallel\n\n`);
-  const progress = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic);
+  console.log(
+    `Sending in ${operationBatches.length} batches of ${batchSize} alerts, with up to ${concurrency} batches in parallel\n\n`,
+  );
+  const progress = new cliProgress.SingleBar(
+    {},
+    cliProgress.Presets.shades_classic,
+  );
 
   progress.start(operationBatches.length, 0);
 
@@ -130,16 +170,18 @@ export const generateAlerts = async (alertCount: number, hostCount: number, user
     async (operations) => {
       await bulkUpsert(operations);
       progress.increment();
-    },  
-    { concurrency }
+    },
+    { concurrency },
   );
 
   progress.stop();
 };
 
-// this creates asset criticality not events? 
+// this creates asset criticality not events?
 export const generateEvents = async (n: number) => {
-  if(!config.eventIndex) { throw new Error('eventIndex not defined in config'); }
+  if (!config.eventIndex) {
+    throw new Error('eventIndex not defined in config');
+  }
   await indexCheck(config.eventIndex, eventMappings as MappingTypeMapping);
 
   console.log('Generating events...');
@@ -157,15 +199,17 @@ export const generateGraph = async ({ users = 100, maxHosts = 3 }) => {
   //await alertIndexCheck(); TODO
   console.log('Generating alerts graph...');
 
-  type AlertOverride ={host: { name: string }; user: { name: string }}; 
+  type AlertOverride = { host: { name: string }; user: { name: string } };
 
-  const clusters: (ReturnType<typeof createAlerts>&AlertOverride)[][] = [];
+  const clusters: (ReturnType<typeof createAlerts> & AlertOverride)[][] = [];
 
   /**
    * The type you can pass to the bulk API, if you're working with Fake Alerts.
    * This accepts partial docs, full docs, and other docs that indicate _index, _id, and such
    */
-  type FakeAlertBulkOperations = BulkOperationContainer | Partial<AlertOverride>;
+  type FakeAlertBulkOperations =
+    | BulkOperationContainer
+    | Partial<AlertOverride>;
 
   const alerts: FakeAlertBulkOperations[] = [];
   for (let i = 0; i < users; i++) {
@@ -184,7 +228,9 @@ export const generateGraph = async ({ users = 100, maxHosts = 3 }) => {
     clusters.push(userCluster);
   }
 
-  let lastAlertFromCluster: (ReturnType<typeof createAlerts>&AlertOverride) | null  = null;
+  let lastAlertFromCluster:
+    | (ReturnType<typeof createAlerts> & AlertOverride)
+    | null = null;
   clusters.forEach((cluster) => {
     if (lastAlertFromCluster) {
       const alert = createAlerts({
@@ -196,21 +242,27 @@ export const generateGraph = async ({ users = 100, maxHosts = 3 }) => {
         },
       });
       alerts.push({
-        index: { _index: getAlertIndex('default'), _id: alert['kibana.alert.uuid'] },
+        index: {
+          _index: getAlertIndex('default'),
+          _id: alert['kibana.alert.uuid'],
+        },
       });
       alerts.push(alert);
     }
     cluster.forEach((alert) => {
       alerts.push({
-        index: { _index: getAlertIndex('default'), _id: alert['kibana.alert.uuid'] },
+        index: {
+          _index: getAlertIndex('default'),
+          _id: alert['kibana.alert.uuid'],
+        },
       });
       alerts.push(alert);
       lastAlertFromCluster = alert;
     });
   });
 
   try {
-    if (!client) throw new Error;
+    if (!client) throw new Error();
     const result = await client.bulk({ body: alerts, refresh: true });
     console.log(`${result.items.length} alerts created`);
   } catch (err) {
@@ -222,7 +274,7 @@ export const deleteAllAlerts = async () => {
   console.log('Deleting all alerts...');
   try {
     console.log('Deleted all alerts');
-    if (!client) throw new Error;
+    if (!client) throw new Error();
     await client.deleteByQuery({
       index: '.alerts-security.alerts-*',
       refresh: true,
@@ -240,10 +292,12 @@ export const deleteAllAlerts = async () => {
 
 export const deleteAllEvents = async () => {
   console.log('Deleting all events...');
-  if (!config.eventIndex) { throw new Error('eventIndex not defined in config'); }
+  if (!config.eventIndex) {
+    throw new Error('eventIndex not defined in config');
+  }
   try {
     console.log('Deleted all events');
-    if (!client) throw new Error;
+    if (!client) throw new Error();
     await client.deleteByQuery({
       index: config.eventIndex,
       refresh: true,