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.

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

Introduce Lint, Test and Pre-Commit Hook to JS Client #38

Open
openrijal opened this issue Aug 1, 2023 · 2 comments
Open

Introduce Lint, Test and Pre-Commit Hook to JS Client #38

openrijal opened this issue Aug 1, 2023 · 2 comments
Assignees
Labels
New Feature A feature addition not currently in the library

Comments

@openrijal
Copy link
Contributor

Is your feature request related to a problem? Please describe.

The JS client is being created, and there is some code being produced. Most of the PR Review comments at this early stage can be addressed through following a proper style guide. Enforcing a standard lint library along with test with coverage and pre-commit hooks helps developer productivity and maintains high standard in code.

Describe the outcome you'd like:

Enable support for:

  • ESLint, with Prettify plugin (for code style and lint)
  • Jest (for testings)
  • Husky (for pre-commit hooks)
@openrijal openrijal added the New Feature A feature addition not currently in the library label Aug 1, 2023
@openrijal
Copy link
Contributor Author

Discussion with @taylorfturner and @ksneab7 about what rules should be enforced.

We decided it made most sense to look at what does currently the Python Client enforce with Black, and then look at most used external facing Javascript projects (eg: Ease Web, Creditwise, etc).

I will compile a list of equivalent rules, and we can have discussion on those as we move along.

@openrijal
Copy link
Contributor Author

openrijal commented Aug 7, 2023

Python: Flake8 (lint, code) ; Black (extension on top of Flake8)
JS/TS: ESLint (lint, code) ; Prettier (extension on top of ESLint)

Python Rule TS Rule Status
Wrap Line Prettier Plugin :enabled:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Feature A feature addition not currently in the library
Projects
None yet
Development

No branches or pull requests

6 participants