Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve maintainability by adding unit testing and further documentation #44

Open
wants to merge 16 commits into
base: dev
Choose a base branch
from
Open

Improve maintainability by adding unit testing and further documentation #44

wants to merge 16 commits into from

Commits on Jul 3, 2021

  1. Specifies more environments 

    To reduce redundant ESLint warnings.
    @melodicht
    melodicht committed Jul 3, 2021
    Configuration menu
    Copy the full SHA
    23d7192 View commit details
    Browse the repository at this point in the history

  2. Add yarn.lock 

    Yarn manages dependencies.
    @melodicht
    melodicht committed Jul 3, 2021
    Configuration menu
    Copy the full SHA
    0c9d875 View commit details
    Browse the repository at this point in the history

  3. Update dependencies 

    Added further dependencies from Babel, to support Jest JS.

`gaze-run-interrupt` has also been added to support the
test-driven development (tdd) workflow.
    @melodicht
    melodicht committed Jul 3, 2021
    Configuration menu
    Copy the full SHA
    3e8605a View commit details
    Browse the repository at this point in the history

  4. Update dependencies 

    (should have done this with `package.json`, my bad)
    @melodicht
    melodicht committed Jul 3, 2021
    Configuration menu
    Copy the full SHA
    bc417ab View commit details
    Browse the repository at this point in the history

  5. Add support for unit testing with Jest JS

    @melodicht
    melodicht committed Jul 3, 2021
    Configuration menu
    Copy the full SHA
    0b267c2 View commit details
    Browse the repository at this point in the history

  6. Add support for fast tdd 

    Run `./tdd` or `npm run tdd`, and the tests will run as you save.
    @melodicht
    melodicht committed Jul 3, 2021
    Configuration menu
    Copy the full SHA
    7dfdc87 View commit details
    Browse the repository at this point in the history

Commits on Jul 4, 2021

  1. Remove yarn.lock

    @melodicht
    melodicht committed Jul 4, 2021
    Configuration menu
    Copy the full SHA
    0b6b0ab View commit details
    Browse the repository at this point in the history

  2. Changes fast tdd so that only errors are shown 

    Tests that succeed would only clutter the screen.

If one would like to see them, one can run `npm run test`.
    @melodicht
    melodicht committed Jul 4, 2021
    Configuration menu
    Copy the full SHA
    cd1a5af View commit details
    Browse the repository at this point in the history

Commits on Jul 5, 2021

  1. Update dependencies 

    Adding TSDoc and TypeDoc
    @melodicht
    melodicht committed Jul 5, 2021
    Configuration menu
    Copy the full SHA
    7fb3898 View commit details
    Browse the repository at this point in the history

  2. Add TypeDoc website 

    - To view documentation on web.

- ESLint made to ignore js files in `/doc`
    @melodicht
    melodicht committed Jul 5, 2021
    Configuration menu
    Copy the full SHA
    c049850 View commit details
    Browse the repository at this point in the history

Commits on Jul 6, 2021

  1. Remove gaze-run-interrupt

    @melodicht
    melodicht committed Jul 6, 2021
    Configuration menu
    Copy the full SHA
    f2db725 View commit details
    Browse the repository at this point in the history

  2. Add clearMocks as default to jest config 

    To clear all mocks before beginning individual unit tests,
reducing tests leak.
    @melodicht
    melodicht committed Jul 6, 2021
    Configuration menu
    Copy the full SHA
    d181313 View commit details
    Browse the repository at this point in the history

  3. Test client handleCommands and connect 

    - Add helper functions, likely to be stored in new document in the future
    @melodicht
    melodicht committed Jul 6, 2021
    Configuration menu
    Copy the full SHA
    6f40e44 View commit details
    Browse the repository at this point in the history

Commits on Jul 7, 2021

  1. Add hyphens to param definitions 

    To meet TSDoc specifications.
    @melodicht
    melodicht committed Jul 7, 2021
    Configuration menu
    Copy the full SHA
    d4e1fcb View commit details
    Browse the repository at this point in the history

  2. Add tests for handleTriggers and _handleMessage

    @melodicht
    melodicht committed Jul 7, 2021
    Configuration menu
    Copy the full SHA
    1184c10 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into melodicht/maintainability

    @melodicht
    melodicht committed Jul 7, 2021
    Configuration menu
    Copy the full SHA
    7c1d8b3 View commit details
    Browse the repository at this point in the history