Merge pull request #20 from SecJS/feat/len-get-branch

feat: Add getBranch function and constructor to Blacklist

Author: jlenon7

README.md

@@ -249,6 +249,16 @@ console.log(clean.cleanArraysInObject(object2)) // { number2: [{ number1: "numbe
 
 ## Functions Usage
 
+### getBranch
+
+> Get the actual git branch that the project is running or not a repository.
+
+```js
+import { getBranch } from '@secjs/utils'
+
+await getBranch() // master || Not a repository
+```
+
 ### pathPattern
 
 > Transform all route paths to the same pattern.

index.ts

@@ -18,6 +18,7 @@ export * from './src/Functions/kmRadius'
 export * from './src/Functions/paginate'
 export * from './src/Functions/getFiles'
 export * from './src/Functions/scheduler'
+export * from './src/Functions/getBranch'
 export * from './src/Functions/getFolders'
 export * from './src/Functions/fileExists'
 export * from './src/Functions/pathPattern'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/utils",
-  "version": "1.3.6",
+  "version": "1.3.7",
   "description": "",
   "license": "MIT",
   "author": "João Lenon",

src/Classes/Blacklist.ts

@@ -2,14 +2,22 @@ import { createInterface } from 'readline'
 import { createWriteStream, createReadStream } from 'fs'
 
 export class Blacklist {
+  private readonly filePath?: string
+
+  constructor(filePath?: string) {
+    this.filePath = filePath
+  }
+
   /**
    * Add value to a file path
    *
    * @param value The value to be add
    * @param filePath The file path to the blacklist
    * @return void
    */
-  async add(value: string, filePath: string): Promise<void> {
+  async add(value: string, filePath?: string): Promise<void> {
+    filePath = filePath || this.filePath
+
     return new Promise((resolve, reject) => {
       const stream = createWriteStream(filePath, { flags: 'a' })
 
@@ -31,6 +39,8 @@ export class Blacklist {
    * @return string|null The value found or null
    */
   async find(value: string, filePath: string): Promise<string | null> {
+    filePath = filePath || this.filePath
+
     const stream = createReadStream(filePath)
 
     const lines = createInterface({
@@ -57,6 +67,8 @@ export class Blacklist {
    * @return void The value found or null
    */
   async remove(value: string, filePath: string): Promise<void> {
+    filePath = filePath || this.filePath
+
     return new Promise((resolve, reject) => {
       const readStream = createReadStream(filePath)
 

src/Functions/getBranch.ts

@@ -0,0 +1,23 @@
+import { promisify } from 'util'
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const exec = promisify(require('child_process').exec)
+
+/**
+ * Get the actual branch HEAD from the repository
+ *
+ * @return the branch HEAD name or not a repository
+ */
+export async function getBranch(): Promise<string> {
+  let branch: string
+
+  try {
+    branch = (await exec('git branch --show-current')).stdout.replace('\n', '')
+
+    if (!branch || branch === '') branch = 'Not a repository'
+  } catch (error) {
+    branch = 'Not a repository'
+  }
+
+  return branch
+}

tests/Functions/getBranch.spec.ts

@@ -0,0 +1,9 @@
+import { getBranch } from '../../src/Functions/getBranch'
+
+describe('\n getBranch Function', () => {
+  it('should return the branch from @secjs/utils', async () => {
+    const branch = await getBranch()
+
+    expect(branch).toBeTruthy()
+  })
+})