chore: merge Fix/742 migrate doctest to jest (#749)

* Remove QuickSelect doctest

There are more Jest test cases already.

* Remove AverageMedian doctest

Already migrated to jest

* Migrate doctest for BinaryExponentiationRecursive.js

(also remove inline "main" test method)

* Migrate doctest for EulersTotient.js

(also remove inline "main" test method)

* Migrate doctest for PrimeFactors.js

(also remove inline "main" test method)

* Migrate doctest for BogoSort.js

Re-write prototype-polluting helper methods, too.

(also remove inline test driver code)

* Migrate doctest for BeadSort.js

(also remove inline test driver code)

* Migrate doctest for BucketSort.js

(also remove inline test driver code)

* Migrate doctest for CocktailShakerSort.js

(also remove inline test driver code)

* Migrate doctest for MergeSort.js

(also remove inline test driver code)

* Migrate doctest for QuickSort.js

(also remove inline test driver code)

* Migrate doctest for ReverseString.js

(also remove inline test driver code)

* Migrate doctest for ReverseString.js

* Migrate doctest for ValidateEmail.js

* Migrate doctest for ConwaysGameOfLife.js

(remove the animate code, too)

* Remove TernarySearch doctest

Already migrated to jest

* Migrate doctest for BubbleSort.js

(also remove inline test driver code)

* Remove doctest from CI and from dependencies

relates to #742
fixes #586

* Migrate doctest for RgbHsvConversion.js

* Add --fix option to "standard" npm script

* Migrate doctest for BreadthFirstSearch.js

(also remove inline test driver code)

* Migrate doctest for BreadthFirstShortestPath.js

(also remove inline test driver code)

* Migrate doctest for EulerMethod.js

(also remove inline test driver code)

Move manual test-code for plotting stuff in the browser in a distinct file, too. Those "*.manual-test.js" files are excluded from the UpdateDirectory.mjs script, as well.

* Migrate doctest for Mandelbrot.js

(also remove inline test driver code & moved manual drawing test into a *.manual-test.js)

* Migrate doctest for FloodFill.js

* Migrate doctest for KochSnowflake.js

(also move manual drawing test into a *.manual-test.js)

* Update npm lockfile

* Update README and COMMITTING with a few bits & bobs regarding testing & code quality
This commit is contained in:
Roland Hummel
2021-10-07 09:03:38 +02:00
committed by GitHub
parent 6eeb989930
commit b13b12e88c
53 changed files with 882 additions and 13514 deletions

View File

@ -1,40 +1,21 @@
/**
* Merge Sort is an algorithm where the main list is divided down into two half
* sized lists, which then have merge sort called on these two smaller lists
* recursively until there is only a sorted list of one.
/*
* MergeSort implementation.
*
* Merge Sort is an algorithm where the main list is divided down into two half sized lists, which then have merge sort
* called on these two smaller lists recursively until there is only a sorted list of one.
*
* On the way up the recursive calls, the lists will be merged together inserting
* the smaller value first, creating a larger sorted list.
*/
/**
* Sort and merge two given arrays
* @param {Array} list1 - sublist to break down
* @param {Array} list2 - sublist to break down
* @return {Array} merged list
* Sort and merge two given arrays.
*
* @param {Array} list1 Sublist to break down.
* @param {Array} list2 Sublist to break down.
* @return {Array} The merged list.
*/
/*
* Doctests
* > merge([5, 4],[ 1, 2, 3])
* [1, 2, 3, 5, 4]
* > merge([],[1, 2])
* [1, 2]
* > merge([1, 2, 3], [1])
* [1, 1, 2, 3]
* > merge([], [])
* []
*
* > mergeSort([5, 4])
* [4, 5]
* > mergeSort([8, 4, 10, 15, 9])
* [4, 8, 9, 10, 15]
* > mergeSort([1, 2, 3])
* [1, 2, 3]
* > mergeSort([ ])
* [ ]
*/
function merge (list1, list2) {
export function merge (list1, list2) {
const results = []
let i = 0
let j = 0
@ -51,11 +32,12 @@ function merge (list1, list2) {
}
/**
* Break down the lists into smaller pieces to be merged
* @param {Array} list - list to be sorted
* @return {Array} sorted list
* Break down the lists into smaller pieces to be merged.
*
* @param {Array} list List to be sorted.
* @return {Array} The sorted list.
*/
function mergeSort (list) {
export function mergeSort (list) {
if (list.length < 2) return list
const listHalf = Math.floor(list.length / 2)
@ -64,9 +46,3 @@ function mergeSort (list) {
return merge(mergeSort(subList1), mergeSort(subList2))
}
// Merge Sort Example
const unsortedArray = [10, 5, 3, 8, 2, 6, 4, 7, 9, 1]
const sortedArray = mergeSort(unsortedArray)
console.log('Before:', unsortedArray, 'After:', sortedArray)