feat: add filename formatter and directory workflow (#76)

Author: Panquesito7

.github/workflows/directory_formatter.yml

@@ -0,0 +1,41 @@
+name: Directory/Filename Formatter workflow
+on: [push, pull_request]
+
+jobs:
+  main:
+    name: (Directory) Formatter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - name: Setup Git configuration
+        run: |
+          git config --global user.name 'autoprettier'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
+      - name: Filename Formatter
+        run: |
+          IFS=$'\n'
+          for fname in `find . -type f -name '*.ts' -o -name '*.ts'`
+          do
+            echo "${fname}"
+            new_fname=`echo ${fname} | tr ' ' '_'`
+            echo "      ${new_fname}"
+            new_fname=`echo ${new_fname} | tr 'A-Z' 'a-z'`
+            echo "      ${new_fname}"
+            new_fname=`echo ${new_fname} | tr '-' '_'`
+            echo "      ${new_fname}"
+            if [ ${fname} != ${new_fname} ]
+            then
+              echo "      ${fname} --> ${new_fname}"
+              git "mv" "${fname}" ${new_fname}
+            fi
+          done
+          git commit -am "Formatting filenames ${GITHUB_SHA::8}" || true
+      - name: Update DIRECTORY.md
+        run: |
+          wget https://raw.githubusercontent.com/TheAlgorithms/scripts/main/build_directory_md.py
+          python3 build_directory_md.py TypeScript . .ts jest.config.ts,sorts/test,search/test,maths/test,dynamic_programming/test,data_structures/test,ciphers/test > DIRECTORY.md
+
+          git diff
+          git commit -m "Update DIRECTORY.md" DIRECTORY.md || true
+          git push --force origin HEAD:$GITHUB_REF || true

DIRECTORY.md

@@ -1,4 +1,4 @@
-import { XORCipher } from '../XORCipher';
+import { XORCipher } from '../xor_cipher';
 
 describe('Testing XORCipher function', () => {
   it('passing a string & number as an argument', () => {

Ciphers/test/XORCipher.test.ts renamed to ciphers/test/xor_cipher.test.ts

@@ -1,4 +1,4 @@
-import { Stack } from '../Stack';
+import { Stack } from '../stack';
 
 describe('Testing Stack data structure', () => {
   it('push should add a new element to the stack', () => {

Ciphers/XORCipher.ts renamed to ciphers/xor_cipher.ts

@@ -1,4 +1,4 @@
-import { knapsack } from "../Knapsack";
+import { knapsack } from "../knapsack";
 
 const cases: [number, number[], number[], number][] = [
   [15, [6, 5, 6, 6, 3, 7], [5, 6, 4, 6, 5, 2], 17],

Data-Structures/Stack.ts renamed to data_structures/stack.ts

@@ -1,4 +1,4 @@
-import { AbsoluteValue } from "../AbsoluteValue";
+import { AbsoluteValue } from "../absolute_value";
 
 describe("AbsoluteValue", () => {
   it("should return the absolute value of zero", () => {

Data-Structures/test/Stack.test.ts renamed to data_structures/test/stack.test.ts

@@ -1,4 +1,4 @@
-import { AliquotSum } from "../AliquotSum";
+import { AliquotSum } from "../aliquot_sum";
 
 test.each([[15, 9], [18, 21], [28, 28], [100, 117], [169, 14], [1729, 511], [15625, 3906]])("Aliquot Sum of %i is %i", (num, expected) => {
   expect(AliquotSum(num)).toBe(expected)

dynamic_programing/Knapsack.ts renamed to dynamic_programming/knapsack.ts

@@ -1,4 +1,4 @@
-import { ArmstrongNumber } from "../ArmstrongNumber"
+import { ArmstrongNumber } from "../armstrong_number"
 
 test.each([[9, true], [-310, false], [0, false], [407, true], [420, false], [92727, true], [13579, false]])('i is an Armstrong number or not', (num, expected) => {
   expect(ArmstrongNumber(num)).toBe(expected)

dynamic_programing/test/Knapsack.test.ts renamed to dynamic_programming/test/knapsack.test.ts

@@ -1,4 +1,4 @@
-import { BinaryConvert } from '../BinaryConvert'
+import { BinaryConvert } from '../binary_convert'
 
 describe('BinaryConvert', () => {
   it('should return the correct value', () => {

Maths/AbsoluteValue.ts renamed to maths/absolute_value.ts

@@ -1,4 +1,4 @@
-import { calculateMean } from "../CalculateMean";
+import { calculateMean } from "../calculate_mean";
 
 describe("Tests for AverageMean", () => {
   it("should be a function", () => {

Maths/AliquotSum.ts renamed to maths/aliquot_sum.ts

@@ -1,4 +1,4 @@
-import {degreesToRadians} from '../DegreesToRadians'; 
+import {degreesToRadians} from '../degrees_to_radians'; 
 
  test("DegreesToRadians", () => {
   expect(degreesToRadians(0)).toBe(0);

Maths/ArmstrongNumber.ts renamed to maths/armstrong_number.ts

@@ -1,4 +1,4 @@
-import { DigitSum } from "../DigitSum";
+import { DigitSum } from "../digit_sum";
 
 describe("DigitSum", () => {
   test.each([-42, -0.1, -1, 0.2, 3.3, NaN, -Infinity, Infinity])(

Maths/BinaryConvert.ts renamed to maths/binary_convert.ts

@@ -1,4 +1,4 @@
-import { Factorial } from "../Factorial";
+import { Factorial } from "../factorial";
 
 describe("Factorial", () => {
   test.each([-0.1, -1, -2, -42, 0.01, 0.42, 0.5, 1.337])(

Maths/CalculateMean.ts renamed to maths/calculate_mean.ts

@@ -1,4 +1,4 @@
-import {nthFibonacci} from '../Fibonacci';
+import {nthFibonacci} from '../fibonacci';
 
 describe('nthFibonacci', () => {
   test('should return correct value', () => {        

Maths/DegreesToRadians.ts renamed to maths/degrees_to_radians.ts

@@ -1,4 +1,4 @@
-import { FindMin } from "../FindMin";
+import { FindMin } from "../find_min";
 
 describe("FindMin", () => {
   test.each([[[1,2,3,4,5,6], 1], [[87,6,13,999], 6], [[0.8,0.2,0.3,0.5], 0.2], [[1,0.1,-1], -1]])(

Maths/DigitSum.ts renamed to maths/digit_sum.ts

@@ -1,4 +1,4 @@
-import { binaryGCF, greatestCommonFactor } from "../GreatestCommonFactor";
+import { binaryGCF, greatestCommonFactor } from "../greatest_common_factor";
 
 describe("binaryGCF", () => {
   test.each([[12, 8, 4], [1, 199, 1], [88, 40, 8], [288, 160, 32]])(

Maths/Factorial.ts renamed to maths/factorial.ts

@@ -1,4 +1,4 @@
-import { IsDivisible } from "../IsDivisible";
+import { IsDivisible } from "../is_divisible";
 
 describe("IsDivisible", () => {
     test.each([

Maths/Fibonacci.ts renamed to maths/fibonacci.ts

@@ -1,4 +1,4 @@
-import { IsEven } from "../IsEven";
+import { IsEven } from "../is_even";
 
 describe("IsEven", () => {
   test.each([[2, true], [1, false], [0, true], [-1, false], [-2, true]])(

Maths/FindMin.ts renamed to maths/find_min.ts

@@ -1,4 +1,4 @@
-import { IsLeapYear } from "../IsLeapYear";
+import { IsLeapYear } from "../is_leap_year";
 
 describe("IsLeapYear", () => {
   test.each([4, 8, 12, 2004])(

Maths/GreatestCommonFactor.ts renamed to maths/greatest_common_factor.ts

@@ -1,4 +1,4 @@
-import { IsOdd } from "../IsOdd";
+import { IsOdd } from "../is_odd";
 
 describe("IsOdd", () => {
   test.each([[2, false], [1, true], [0, false], [-1, true], [-2, false]])(

Maths/IsDivisible.ts renamed to maths/is_divisible.ts

@@ -1,4 +1,4 @@
-import { PerfectSquare } from "../PerfectSquare";
+import { PerfectSquare } from "../perfect_square";
 
 test("Check perfect square", () => {
     expect(PerfectSquare(16)).toBe(true);

Maths/IsEven.ts renamed to maths/is_even.ts

@@ -1,4 +1,4 @@
-import {radiansToDegrees} from '../RadiansToDegrees'; 
+import {radiansToDegrees} from '../radians_to_degrees'; 
 
 test("RadiansToDegrees", () => {
   expect(radiansToDegrees(0)).toBe(0);

Maths/IsLeapYear.ts renamed to maths/is_leap_year.ts

@@ -1,4 +1,4 @@
-import { SieveOfEratosthenes } from "../SieveOfEratosthenes";
+import { SieveOfEratosthenes } from "../sieve_of_eratosthenes";
 
 
 describe("Sieve of Eratosthenes", () => {

Maths/IsOdd.ts renamed to maths/is_odd.ts

@@ -1,4 +1,4 @@
-import { binarySearchIterative, binarySearchRecursive } from "../BinarySearch";
+import { binarySearchIterative, binarySearchRecursive } from "../binary_search";
 
 describe("BinarySearch", () => {
     const testArray: number[] = [1,2,3,4];

Maths/PerfectSquare.ts renamed to maths/perfect_square.ts

@@ -1,4 +1,4 @@
-import {bubbleSort} from "../BubbleSort"
+import {bubbleSort} from "../bubble_sort"
 
 describe("BubbleSort", () => { 
   it("should return the correct value for average case", () => { 

Maths/RadiansToDegrees.ts renamed to maths/radians_to_degrees.ts

@@ -1,4 +1,4 @@
-import { gnomeSort } from '../GnomeSort';
+import { gnomeSort } from '../gnome_sort';
 
 describe('Testing Gnome sort', () => {
   const testCases: number[][] = [

Maths/SieveOfEratosthenes.ts renamed to maths/sieve_of_eratosthenes.ts

@@ -1,4 +1,4 @@
-import { insertionSort } from "../InsertionSort";
+import { insertionSort } from "../insertion_sort";
 
 describe("Insertion Sort", () => {
   it("should return the correct value for average case", () => {

Maths/test/AbsoluteValue.test.ts renamed to maths/test/absolute_value.test.ts

@@ -1,4 +1,4 @@
-import { MergeSort } from "../MergeSort";
+import { MergeSort } from "../merge_sort";
 
 describe("Merge Sort", () => {
     it("generating array with variable length and comparing with sorted array", () => {

Maths/test/AliquotSum.test.ts renamed to maths/test/aliquot_sum.test.ts

@@ -1,4 +1,4 @@
-import { QuickSort } from "../QuickSort";
+import { QuickSort } from "../quick_sort";
 
 describe("Quick Sort", () => {
     it("should return the correct value for average case", () => {