Doctest required #142

itsvinayak · 2020-05-04T07:28:32Z

it will be good if algorithms have Doctest's https://www.npmjs.com/package/doctest

cclauss · 2020-05-12T10:24:46Z

Which files in this repo currently have doctests?
It would be good to have a list of examples in this repo that contributors could review.

itsvinayak · 2020-05-12T13:46:25Z

@cclauss currently none of the files have Doctest

cclauss · 2020-05-12T14:12:12Z

Todos:

Add doctests to at least two algorithms in this repo BogoSort.js: Simplify Array.isSorted() and add doctests #171
Help at least one contributor to add doctests to a new algorithm contribution
Discuss how difficult it was to complete 1. and 2.
Decide if we should make doctests a requirement of new contributions to this repo.

itsvinayak · 2020-05-12T17:55:58Z

more people of the community should discuss this issue

As discussed at #164 (comment) Also related to add doctests as discussed in #142

* added DecimalToHex * added luhn's checksum algorithm * deleted checksums * Update keyFinder.js modified used the suitable identifier for the variables * Update keyFinder.js 1. modified the identifiers and used the suitable identifiers for the variables 2. leave the loop when a key is match and found to increase the speed of searching in this stage of development 3. return the key number if founded, return 0 if found nothing * Update keyFinder.js a sub-function is used to assist the keyfinder to find the key * Update keyFinder.js Finally, there are several changes in the function keyFinder(str) that make it works well * Update keyFinder.js Add some key words to the wordbank to increase the chance of the matching. * fixed and added test cases * fixed alert * Add wiggle sort * adding Graph data structure * Added SHA-1 and SHA-256 hashing algorithms (TheAlgorithms#83) * Added SHA-1 and SHA-256 hashing algorithms * Fixed typos in comments * Removed redundant unsigned integer casting * Added Jump Search to readme.md * Added JumpSearch algorithm * Update jumpSearch.js * Added Semicolon to Avoid Auto Semicolon Insertion This fixes a [recommendation on lgtm](https://lgtm.com/projects/g/TheAlgorithms/Javascript/snapshot/9fe2ca0492e0813c5e5486498c6b53a00c4a61e3/files/Sorts/bucketSort.js?sort=name&dir=ASC&mode=heatmap) * Fixed Whitespace, Operators, and Quotes to Comply with JSLint I modified the whitespace in the files and changed single quotes to double quotes. I also changed some `==` and `!=` operators to `===` and `!==` to comply with JSLint. * Create find_lcm.js - Created find_lcm.js - Created maths folder * Create average_mean.js * Create factorial.js This program calculates and displays the factorial for a user-input number. * Create abs.js This script calculates absolute value. * Made "use strict" Global * Made "use strict" Global & Made JSLint Happy * Kadane Algo is added * Issue fixed * GitHub Action to test Javascript * Update nodejs.yml * cd linear-algebra-javascript * Create update_directory_md.yml * updating DIRECTORY.md * update_directory_md.yml: Remove GH Actions workaround * Graph Theory * Delete Graphs * Graph * Dijkstra Smallest Path * DijkstraSmallestPath after fixing some errors. * Topological Sort directed graphs * correcting name of file * updating DIRECTORY.md * doublylinkedlist * add-doublylinkedlist * add-doublylinkedlist * change in Directory.md * updating DIRECTORY.md * update (#1) * Graph Theory * Delete Graphs * Graph * Dijkstra Smallest Path * DijkstraSmallestPath after fixing some errors. * Topological Sort directed graphs * correcting name of file * updating DIRECTORY.md * doublylinkedlist * add-doublylinkedlist * add-doublylinkedlist * change in Directory.md * updating DIRECTORY.md Co-authored-by: Nur69 <60115902+Nur69@users.noreply.github.com> Co-authored-by: Stepfen Shawn <m18824909883@163.com> Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Co-authored-by: hmizz <hamza.chabchoub@medtech.tn> * Contributing guidelines * npx standard --fix * Update CONTRIBUTING.md * Update README.md * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Update CONTRIBUTING.md Co-authored-by: Christian Clauss <cclauss@me.com> * Add standard to our testing Run in allow failures mode until the non-compliant files are fixed. * npx standard || true * Update README.md * Fixing non compliant files (Ciphers, Conversions and Data Structures) * Update nodejs.yml * Data Structures/Graph * sorts/ * fix broken link * search/ * search/ (TheAlgorithms#143) * factorial.js: Standardjs fixes Related to TheAlgorithms#139 * /* global alert, prompt */ * find_lcm.js: Standardjs fixes * abs.js: abs_val() --> absVal() for standardjs (TheAlgorithms#144) * find_lcm.js: Standardjs fixes (TheAlgorithms#146) * Update factorial.js * SHA256.js: Standardjs fixes * factorial.js: /* global prompt */ * Update nodejs.yml * DijkstraSmallestPath.js: Standardjs fixes (TheAlgorithms#147) * Fixed typo in CONTRIBUTING.md file (TheAlgorithms#148) * Fixed typo in CONTRIBUTING.md file * Update CONTRIBUTING.md Co-authored-by: vinayak <itssvinayak@gmail.com> * math/ * sort/ * Add Pascal's triangle. (TheAlgorithms#149) * Add Pascal's triangle. * Update pascalTriangle.js * Update pascalTriangle.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Javascript/linear-algebra-javascript * Update nodejs.yml * Update nodejs.yml * Update nodejs.yml * Trailing space ;-) * Update README.md * adding an implementation of a queue using 2 stacks (TheAlgorithms#137) * adding an implementation of a queue using 2 stacks * Update QueueUsing2Stacks.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Create palindrome algorithm (TheAlgorithms#134) * Create palindrome algorithm * Update Palindrome.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Create pull_request_template.md (TheAlgorithms#153) * Create pull_request_template.md * Update pull_request_template.md * Update pull_request_template.md * Update pull_request_template.md * Update pull_request_template.md * Update README.md * Update CONTRIBUTING.md * added hcf finding algorithm (TheAlgorithms#104) * added hcf finding algorith * Update and rename find_hcf.js to FindHcf.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Create Fibonacci.js (TheAlgorithms#133) * Create Fibonacci.js * Update Fibonacci.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Javascript/Math: editing file name * updating DIRECTORY.md * Update nodejs.yml * Update README.md * editing file names * updating DIRECTORY.md * Quick Select Search (TheAlgorithms#131) * HeapSort algorithm * Create QuickSelect.js * Algorithm to reverse a string. * Update ReverseString.js * Update Heapsort.js * Update QuickSelect.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Update README.md * Max heap implementation (TheAlgorithms#157) * Added MaxHeap implementation * Added MaxHeap implementation * Added MaxHeap implementation * Added MaxHeap implementation * Delete package-lock.json * Delete .gitignore * updating DIRECTORY.md * Renaming files according to naming convention (TheAlgorithms#158) * updating DIRECTORY.md * Fibonacci without recursion added (TheAlgorithms#159) * changes made * Update Fibonacci.js * fib Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * format files * updating DIRECTORY.md * Add good_filepaths function in workflow script * updating DIRECTORY.md * Add md_prefix and print_path functions * Add reverse words (TheAlgorithms#162) * add reverse words * Update ReverseWords.js * Update ReverseWords.js Co-authored-by: vinayak <itssvinayak@gmail.com> * updating DIRECTORY.md * Add build_directory_md * GitHub Action nodejs.yml upgrade to Node.js 14 (TheAlgorithms#165) * JavaScript, not Javascript (TheAlgorithms#166) * Rename script.js to UpdateDirectory.js * updating DIRECTORY.md * run: node UpdateDirectory.js * run: node .github/workflows/UpdateDirectory.js * updating DIRECTORY.md * BogoSort.js: Simplify Array.isSorted() and add doctests As discussed at TheAlgorithms#164 (comment) Also related to add doctests as discussed in TheAlgorithms#142 * node -e "doctest('Sorts/BogoSort.js', {})" * doctest --module Sorts Sorts/BogoSort.js * Update nodejs.yml * Update nodejs.yml * npx doctest Sorts/BogoSort.js || true * node_modules/doctest Sorts/BogoSort.js || true * npx doctest Sorts/BogoSort.js * updating DIRECTORY.md * Ensure that build fail on bad test * updating DIRECTORY.md * Ready for review * Add doctest to BucketSort.js * updating DIRECTORY.md * Update nodejs.yml * updating DIRECTORY.md * npx doctest Sorts/BogoSort.js Sorts/BucketSort.js * updating DIRECTORY.md * updating DIRECTORY.md * Add Graph BFS algorithm (TheAlgorithms#169) * Add Graph BFS algorithm * updating DIRECTORY.md * Fix failing tests * updating DIRECTORY.md * Fix further failing tests Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> * updating DIRECTORY.md * Re-orgainze files and folders in the repository (TheAlgorithms#172) * Re-orgainze files and folders in the repository * updating DIRECTORY.md Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Co-authored-by: Alex Brown <opti.jawsome@gmail.com> Co-authored-by: Wan Cheuk Lun <winsonrich@gmail.com> Co-authored-by: Mohit Sharma <msvbs98@gmail.com> Co-authored-by: Akarsh <akarsh.satija@gmail.com> Co-authored-by: naor <naor2205@gmail.com> Co-authored-by: Anup Kumar Panwar <1anuppanwar@gmail.com> Co-authored-by: Ravi Patel <ravi.patel1245@gmail.com> Co-authored-by: mavroian <mavflorin@gmail.com> Co-authored-by: Libin Yang <szuyanglb@outlook.com> Co-authored-by: PatOnTheBack <51241310+PatOnTheBack@users.noreply.github.com> Co-authored-by: lakshyabatman <lakshya.khera@gmail.com> Co-authored-by: Christian Clauss <cclauss@me.com> Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Co-authored-by: Nur69 <60115902+Nur69@users.noreply.github.com> Co-authored-by: Stepfen Shawn <m18824909883@163.com> Co-authored-by: hmizz <hamza.chabchoub@medtech.tn> Co-authored-by: vinayak <itssvinayak@gmail.com> Co-authored-by: Juliano Nunes <julianomarquesnunes@gmail.com> Co-authored-by: Muhammad Awais <aawais.nu@gmail.com> Co-authored-by: Nour B <56294154+nourrrrrrrr@users.noreply.github.com> Co-authored-by: hmizz <60817898+hmizz@users.noreply.github.com> Co-authored-by: Novojit Saha <55886194+redfly1@users.noreply.github.com> Co-authored-by: Samarth Jain <53353139+samjain2907@users.noreply.github.com> Co-authored-by: Satzyakiz <40039258+Satzyakiz@users.noreply.github.com> Co-authored-by: Sahil Bansal <shlbnsl843@gmail.com> Co-authored-by: Abhi Ramani <abhiramani3@gmail.com> Co-authored-by: John Law <johnlaw.po@gmail.com>

nandanvasudevan · 2020-08-02T04:35:28Z

Can we update the package.json with DocTest?
It's really easy to use especially for everything in this repo.

As requested at #142 (comment)

cclauss · 2020-08-02T04:55:55Z

update the package.json with DocTest?

Done in 4cbdc9e

nandanvasudevan · 2020-08-03T16:12:58Z

Decide if we should make doctests a requirement of new contributions to this repo.

I think we should.

Discuss how difficult it was to complete 1. and 2.

Shall I start writing a DocTest.md to help people add DocTests?

remmaso · 2020-10-02T07:49:47Z

In your document, open the “Insert” menu and then choose the “Drawing” command. In the Drawing window that opens, click the “Text Box” button on the toolbar at the top. Now, click and drag your mouse to create a text box in the space provided, and then add your desired tex

marsonya · 2020-10-07T07:54:00Z

hey @itsvinayak, i would like to help with adding doctest across the codebase. i checked out the two doctest implementations by @cclauss. the implementation style is clear to me.

do i start adding pr referencing this issue for every file i implement doctest?

cclauss · 2020-10-07T08:49:21Z

Open pull requests, not issues. It is OK to refer to this issue. Only one file per PR so they are easy to review and land.

marsonya · 2020-10-07T08:51:01Z

understood. i will get to work right away.
thanks @cclauss

itsvinayak · 2020-10-12T07:28:51Z

hey, @marsonya can you help me with this #461 issue

marsonya · 2020-10-12T16:52:34Z

hey, @marsonya can you help me with this #461 issue

sure!
I will create a documentation for doctest.
Getting started right away.

Question.
Do I add the documentation to CONTRIBUTING.md or create a new file?

itsvinayak · 2020-10-12T17:21:57Z

@marsonya thanks
Add it to CONTRIBUTING.md itself

sukhpreetsekhon · 2020-10-20T15:46:20Z

raised PR for doctest #502. Please review. Thanks!

…eEmail.js

…Words.js

…String.js

Khez · 2020-10-31T11:29:38Z

@cclauss Can I keep on adding doctests in this format ? Already done a couple of the String files with #532 #533 #534

Anything I need to change going forward with the rest of the files ?

I saw some of the algorithms have .test.js files, do we update them to doctest ?

marsonya · 2020-11-02T14:33:13Z

hey, @marsonya can you help me with this #461 issue

Apologies for the delay. I have added doctest contribution guidelines. Kindly take a look and let me know if it works or if it needs ant changes.
Here's the PR #546

#142 #461 Adding Doctests to String/ReverseString.js

#142 #461 Adding Doctests to String/ReverseWords.js

#142 #461 Adding Doctests to String/ValidateEmail.js

mhihasan · 2021-06-07T22:57:38Z

Some files have jest tests. Should we remove those jest tests and add doctest instead? Because, current doctest version is throwing error on export statement, though next release might fix this

cclauss · 2021-06-08T06:38:40Z

Please do not remove tests. Contributors should have the freedom to choose to test with doctest or jest. Contibutors should not have the freedom to have no tests at all.

raklaptudirm · 2021-06-08T15:18:19Z

@cclauss We still haven't settled on the issues of doctests failing because some files have none.

Ameya101 · 2021-07-12T10:15:52Z

Add it in Contributing.md dont create a new file

defaude · 2021-10-05T09:31:32Z

@raklaptudirm I recommend we close this issue in favour of #742

As requested at TheAlgorithms/JavaScript#142 (comment)

itsvinayak added feature Adds a new feature help wanted Needs to be worked on labels May 4, 2020

itsvinayak assigned itsvinayak, r0hit-gupta, christianbender and ms10398 May 5, 2020

cclauss added a commit that referenced this issue May 12, 2020

BogoSort.js: Simplify Array.isSorted() and add doctests

02585f5

As discussed at #164 (comment) Also related to add doctests as discussed in #142

This was referenced May 12, 2020

BogoSort.js: Simplify Array.isSorted() and add doctests #171

Merged

Added Sleep Sort #109

Merged

cclauss added a commit that referenced this issue Aug 2, 2020

Add doctest to devDependencies of package.json

4cbdc9e

As requested at #142 (comment)

itsvinayak mentioned this issue Oct 1, 2020

more contributors are needed #155

Closed

4 tasks

This was referenced Oct 9, 2020

Improved BubbleSort and added doctests to it #442

Closed

Improved BubbleSort and added Doctests #443

Merged

eugpoloz mentioned this issue Oct 9, 2020

Add Bead Sort (aka Gravity Sort) Algorithm #388

Merged

8 tasks

itsvinayak mentioned this issue Oct 12, 2020

Adding documentation for doctest to help new contributors #461

Closed

marsonya mentioned this issue Oct 12, 2020

Improved CocktailShakerSort and added Doctests #465

Closed

7 tasks

Khez added a commit to Khez/Javascript that referenced this issue Oct 30, 2020

TheAlgorithms#142 TheAlgorithms#461 Adding Doctests to String/Validat…

09d38fe

…eEmail.js

Khez added a commit to Khez/Javascript that referenced this issue Oct 30, 2020

TheAlgorithms#142 TheAlgorithms#461 Adding Doctests to String/Reverse…

50091d2

…Words.js

Khez added a commit to Khez/Javascript that referenced this issue Oct 30, 2020

TheAlgorithms#142 TheAlgorithms#461 Adding Doctests to String/Reverse…

84e4c99

…String.js

marsonya mentioned this issue Nov 2, 2020

Improved CocktailShakerSort and added Doctests #545

Merged

7 tasks

marsonya added a commit that referenced this issue Jan 20, 2021

Merge pull request #534 from Khez/string-reverse-string

9386c29

#142 #461 Adding Doctests to String/ReverseString.js

marsonya added a commit that referenced this issue Jan 20, 2021

Merge pull request #533 from Khez/string-reverse-words

d8395e7

#142 #461 Adding Doctests to String/ReverseWords.js

marsonya added a commit that referenced this issue Jan 22, 2021

Merge pull request #532 from Khez/string-validate-email

71192ab

#142 #461 Adding Doctests to String/ValidateEmail.js

This was referenced Jun 8, 2021

Add doctest at Sudoku.js #623

Closed

Add doctest at KnightTour.js #624

Closed

mhihasan mentioned this issue Jun 9, 2021

Add doctest on quickselect algorithm #625

Merged

8 tasks

defaude mentioned this issue Oct 3, 2021

Consolidating some things #720

Closed

raklaptudirm closed this as completed Oct 5, 2021

raklaptudirm added wontfix Will not be fixed or is a feature and removed feature Adds a new feature help wanted Needs to be worked on labels Oct 5, 2021

Star-dev325 pushed a commit to Star-dev325/allio-javascript-tutorial-algorithm that referenced this issue Apr 1, 2022

Add doctest to devDependencies of package.json

1bd00de

As requested at TheAlgorithms/JavaScript#142 (comment)

mariannepara added a commit to mariannepara/JavaScript that referenced this issue Apr 20, 2022

Add doctest to devDependencies of package.json

3beb7fb

As requested at TheAlgorithms/JavaScript#142 (comment)

ferranm99 added a commit to ferranm99/JavaScript--RWC that referenced this issue May 20, 2022

Add doctest to devDependencies of package.json

4416b6b

As requested at TheAlgorithms/JavaScript#142 (comment)

patrickm68 added a commit to patrickm68/JavaScript that referenced this issue Dec 1, 2022

Add doctest to devDependencies of package.json

9997532

As requested at TheAlgorithms/JavaScript#142 (comment)

vectorcrown pushed a commit to vectorcrown/javascript that referenced this issue Aug 3, 2023

Add doctest to devDependencies of package.json

4508476

As requested at TheAlgorithms/JavaScript#142 (comment)

Uh oh!

Doctest required #142

Doctest required #142

Comments

itsvinayak commented May 4, 2020

cclauss commented May 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

itsvinayak commented May 12, 2020

Uh oh!

cclauss commented May 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Todos:

Uh oh!

itsvinayak commented May 12, 2020

Uh oh!

nandanvasudevan commented Aug 2, 2020

Uh oh!

cclauss commented Aug 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nandanvasudevan commented Aug 3, 2020

Uh oh!

remmaso commented Oct 2, 2020

Uh oh!

marsonya commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cclauss commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marsonya commented Oct 7, 2020

Uh oh!

itsvinayak commented Oct 12, 2020

Uh oh!

marsonya commented Oct 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

itsvinayak commented Oct 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sukhpreetsekhon commented Oct 20, 2020

Uh oh!

Khez commented Oct 31, 2020

Uh oh!

marsonya commented Nov 2, 2020

Uh oh!

mhihasan commented Jun 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cclauss commented Jun 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

raklaptudirm commented Jun 8, 2021

Uh oh!

Ameya101 commented Jul 12, 2021

Uh oh!

defaude commented Oct 5, 2021

Uh oh!

cclauss commented May 12, 2020 •

edited

Loading

cclauss commented May 12, 2020 •

edited

Loading

cclauss commented Aug 2, 2020 •

edited

Loading

marsonya commented Oct 7, 2020 •

edited

Loading

cclauss commented Oct 7, 2020 •

edited

Loading

marsonya commented Oct 12, 2020 •

edited

Loading

itsvinayak commented Oct 12, 2020 •

edited

Loading

mhihasan commented Jun 7, 2021 •

edited

Loading

cclauss commented Jun 8, 2021 •

edited

Loading