chore: extended prettier format command to package/git-proxy-cli and ran it

Author: kriswest

package.json

@@ -16,7 +16,7 @@
     "prepare": "node ./scripts/prepare.js",
     "lint": "eslint \"src/**/*.{js,jsx,ts,tsx,json}\" \"test/**/*.{js,jsx,ts,tsx,json}\"",
     "lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx,json}\" \"test/**/*.{js,jsx,ts,tsx,json}\"",
-    "format": "prettier --write src/**/*.{js,jsx,ts,tsx,css,md,json,scss} test/**/*.{js,jsx,ts,tsx,json} --config ./.prettierrc",
+    "format": "prettier --write src/**/*.{js,jsx,ts,tsx,css,md,json,scss} test/**/*.{js,jsx,ts,tsx,json} packages/git-proxy-cli/test/**/*.{js,jsx,ts,tsx,json}  packages/git-proxy-cli/index.js --config ./.prettierrc",
     "gen-schema-doc": "node ./scripts/doc-schema.js",
     "cypress:run": "cypress run"
   },

packages/git-proxy-cli/index.js

@@ -7,7 +7,8 @@ const util = require('util');
 
 const GIT_PROXY_COOKIE_FILE = 'git-proxy-cookie';
 // GitProxy UI HOST and PORT (configurable via environment variable)
-const { GIT_PROXY_UI_HOST: uiHost = 'http://localhost', GIT_PROXY_UI_PORT: uiPort = 8080 } = process.env;
+const { GIT_PROXY_UI_HOST: uiHost = 'http://localhost', GIT_PROXY_UI_PORT: uiPort = 8080 } =
+  process.env;
 
 const baseUrl = `${uiHost}:${uiPort}`;
 

packages/git-proxy-cli/test/testCli.proxy.config.json

@@ -1,8 +1,7 @@
 {
   "tempPassword": {
     "sendEmail": false,
-    "emailConfig": {
-    }
+    "emailConfig": {}
   },
   "authorisedList": [
     {
@@ -22,9 +21,9 @@
     {
       "type": "mongo",
       "connectionString": "mongodb://localhost:27017/gitproxy",
-      "options": {        
+      "options": {
         "useUnifiedTopology": true
-      },      
+      },
       "enabled": false
     }
   ],

src/config/env.ts

@@ -9,12 +9,12 @@ const {
   GIT_PROXY_SERVER_PORT = 8000,
   GIT_PROXY_HTTPS_SERVER_PORT = 8443,
   GIT_PROXY_UI_HOST = 'http://localhost',
-  GIT_PROXY_UI_PORT = 8080
+  GIT_PROXY_UI_PORT = 8080,
 } = process.env;
 
 export const serverConfig: ServerConfig = {
   GIT_PROXY_SERVER_PORT,
   GIT_PROXY_HTTPS_SERVER_PORT,
   GIT_PROXY_UI_HOST,
-  GIT_PROXY_UI_PORT
+  GIT_PROXY_UI_PORT,
 };

src/db/mongo/helper.ts

@@ -25,7 +25,7 @@ export const connect = async (collectionName: string): Promise<Collection> => {
 export const findDocuments = async <T>(
   collectionName: string,
   filter: Filter<Document> = {},
-  options: FindOptions<Document> = {}
+  options: FindOptions<Document> = {},
 ): Promise<T[]> => {
   const collection = await connect(collectionName);
   return collection.find(filter, options).toArray() as Promise<T[]>;
@@ -34,7 +34,7 @@ export const findDocuments = async <T>(
 export const findOneDocument = async <T>(
   collectionName: string,
   filter: Filter<Document> = {},
-  options: FindOptions<Document> = {}
+  options: FindOptions<Document> = {},
 ): Promise<T | null> => {
   const collection = await connect(collectionName);
   return (await collection.findOne(filter, options)) as T | null;

src/db/types.ts

@@ -1,8 +1,8 @@
 export type PushQuery = {
   error: boolean;
-  blocked: boolean,
-  allowPush: boolean,
-  authorised: boolean
+  blocked: boolean;
+  allowPush: boolean;
+  authorised: boolean;
 };
 
 export type UserRole = 'canPush' | 'canAuthorise';

src/plugin.ts

@@ -15,9 +15,11 @@ function isCompatiblePlugin(obj: any, propertyName: string = 'isGitProxyPlugin')
   // valid plugin objects will have the appropriate property set to true
   // if the prototype chain is exhausted, return false
   while (obj != null) {
-    if (Object.prototype.hasOwnProperty.call(obj, propertyName) &&
+    if (
+      Object.prototype.hasOwnProperty.call(obj, propertyName) &&
       obj.isGitProxyPlugin &&
-      Object.keys(obj).includes('exec')) {
+      Object.keys(obj).includes('exec')
+    ) {
       return true;
     }
     obj = Object.getPrototypeOf(obj);
@@ -55,42 +57,48 @@ class PluginLoader {
    */
   async load(): Promise<void> {
     try {
-      const modulePromises = this.targets.map(target =>
-        this._loadPluginModule(target).catch(error => {
+      const modulePromises = this.targets.map((target) =>
+        this._loadPluginModule(target).catch((error) => {
           console.error(`Failed to load plugin: ${error}`); // TODO: log.error()
           return Promise.reject(error); // Or return an error object to handle it later
-        })
+        }),
       );
 
       const moduleResults = await Promise.allSettled(modulePromises);
       const loadedModules = moduleResults
-        .filter((result): result is PromiseFulfilledResult<any> => result.status === 'fulfilled' && result.value !== null)
-        .map(result => result.value);
+        .filter(
+          (result): result is PromiseFulfilledResult<any> =>
+            result.status === 'fulfilled' && result.value !== null,
+        )
+        .map((result) => result.value);
 
       console.log(`Found ${loadedModules.length} plugin modules`); // TODO: log.debug()
 
-      const pluginTypeResultPromises = loadedModules.map(mod =>
-        this._getPluginObjects(mod).catch(error => {
+      const pluginTypeResultPromises = loadedModules.map((mod) =>
+        this._getPluginObjects(mod).catch((error) => {
           console.error(`Failed to cast plugin objects: ${error}`); // TODO: log.error()
           return Promise.reject(error); // Or return an error object to handle it later
-        })
+        }),
       );
 
       const settledPluginTypeResults = await Promise.allSettled(pluginTypeResultPromises);
       /**
        * @type {PluginTypeResult[]} List of resolved PluginTypeResult objects
        */
       const pluginTypeResults = settledPluginTypeResults
-        .filter((result): result is PromiseFulfilledResult<any> => result.status === 'fulfilled' && result.value !== null)
-        .map(result => result.value);
+        .filter(
+          (result): result is PromiseFulfilledResult<any> =>
+            result.status === 'fulfilled' && result.value !== null,
+        )
+        .map((result) => result.value);
 
       for (const result of pluginTypeResults) {
-        this.pushPlugins.push(...result.pushAction)
-        this.pullPlugins.push(...result.pullAction)
+        this.pushPlugins.push(...result.pushAction);
+        this.pullPlugins.push(...result.pullAction);
       }
 
       const combinedPlugins = [...this.pushPlugins, ...this.pullPlugins];
-      combinedPlugins.forEach(plugin => {
+      combinedPlugins.forEach((plugin) => {
         console.log(`Loaded plugin: ${plugin.constructor.name}`);
       });
     } catch (error) {
@@ -128,15 +136,17 @@ class PluginLoader {
         console.log('found pull plugin', potentialModule.constructor.name);
         plugins.pullAction.push(potentialModule);
       } else {
-        console.error(`Error: Object ${potentialModule.constructor.name} does not seem to be a compatible plugin type`);
+        console.error(
+          `Error: Object ${potentialModule.constructor.name} does not seem to be a compatible plugin type`,
+        );
       }
     }
 
     // handles the default export case
     // `module.exports = new ProxyPlugin()` in CJS or `exports default new ProxyPlugin()` in ESM
     // the "module" is a single object that could be a plugin
     if (isCompatiblePlugin(pluginModule)) {
-      handlePlugin(pluginModule)
+      handlePlugin(pluginModule);
     } else {
       // handle the typical case of a module which exports multiple objects
       // module.exports = { x, y } (CJS) or multiple `export ...` statements (ESM)
@@ -173,11 +183,11 @@ class PushActionPlugin extends ProxyPlugin {
    * Wrapper class which contains at least one function executed as part of the action chain for git push operations.
    * The function must be called `exec` and take in two parameters: an Express Request (req) and the current Action
    * executed in the chain (action). This function should return a Promise that resolves to an Action.
-   * 
+   *
    * Optionally, child classes which extend this can simply define the `exec` function as their own property.
    * This is the preferred implementation when a custom plugin (subclass) has its own state or additional methods
    * that are required.
-   * 
+   *
    * @param {function} exec - A function that:
    *   - Takes in an Express Request object as the first parameter (`req`).
    *   - Takes in an Action object as the second parameter (`action`).
@@ -201,11 +211,11 @@ class PullActionPlugin extends ProxyPlugin {
    * Wrapper class which contains at least one function executed as part of the action chain for git pull operations.
    * The function must be called `exec` and take in two parameters: an Express Request (req) and the current Action
    * executed in the chain (action). This function should return a Promise that resolves to an Action.
-   * 
+   *
    * Optionally, child classes which extend this can simply define the `exec` function as their own property.
    * This is the preferred implementation when a custom plugin (subclass) has its own state or additional methods
    * that are required.
-   * 
+   *
    * @param {function} exec - A function that:
    *   - Takes in an Express Request object as the first parameter (`req`).
    *   - Takes in an Action object as the second parameter (`action`).
@@ -218,9 +228,4 @@ class PullActionPlugin extends ProxyPlugin {
   }
 }
 
-export {
-  PluginLoader,
-  PushActionPlugin,
-  PullActionPlugin,
-  isCompatiblePlugin,
-}
+export { PluginLoader, PushActionPlugin, PullActionPlugin, isCompatiblePlugin };

src/proxy/actions/Action.ts

@@ -1,5 +1,5 @@
-import { getProxyUrl } from "../../config";
-import { Step } from "./Step";
+import { getProxyUrl } from '../../config';
+import { Step } from './Step';
 
 /**
  * Represents a commit.
@@ -62,15 +62,15 @@ class Action {
     this.type = type;
     this.method = method;
     this.timestamp = timestamp;
-    this.project = repo.split("/")[0];
-    this.repoName = repo.split("/")[1];
+    this.project = repo.split('/')[0];
+    this.repoName = repo.split('/')[1];
     this.url = `${getProxyUrl()}/${repo}`;
     this.repo = repo;
   }
 
   /**
    * Add a step to the action.
-   * @param {Step} step 
+   * @param {Step} step
    */
   addStep(step: Step): void {
     this.steps.push(step);

src/proxy/actions/Step.ts

@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from "uuid";
+import { v4 as uuidv4 } from 'uuid';
 
 /** Class representing a Push Step. */
 class Step {
@@ -17,7 +17,7 @@ class Step {
     errorMessage: string | null = null,
     blocked: boolean = false,
     blockedMessage: string | null = null,
-    content: any = null
+    content: any = null,
   ) {
     this.id = uuidv4();
     this.stepName = stepName;
@@ -35,12 +35,12 @@ class Step {
   }
 
   setContent(content: any): void {
-    this.log("setting content");
+    this.log('setting content');
     this.content = content;
   }
 
   setAsyncBlock(message: string): void {
-    this.log("setting blocked");
+    this.log('setting blocked');
     this.blocked = true;
     this.blockedMessage = message;
   }

src/proxy/actions/autoActions.ts

@@ -33,7 +33,4 @@ const attemptAutoRejection = async (action: Action) => {
   }
 };
 
-export {
-  attemptAutoApproval,
-  attemptAutoRejection,
-};
+export { attemptAutoApproval, attemptAutoRejection };