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

Btp 26 add git hooks and linter #102

Merged
merged 8 commits into from
Nov 9, 2023

Conversation

nicoalee
Copy link
Collaborator

@nicoalee nicoalee commented Nov 1, 2023

This PR adds code standards to the ezBIDS repo by linting and formatting code. It aims to improve code quality in ezBIDS in two ways:

HOW TO TEST

  1. checkout to this branch
  2. download the recommended extensions (if you haven't yet) by following the readme
  3. run npm install in both the ezbids and UI folders
  4. Go to any .ts file in the api folder and save it. See if it auto formats for you.
  1. Go to .vue file in the ui folder and save it. See if it auto formats for you.
  2. With these two files that have been updated, run git add ... and try and try and git commit them. If either of these files have errors, confirm that the commit fails.

SUMMARY OF CHANGES

  1. Add formatting on save so that it is easy to format code in a standardized fashion.
  2. Add linting so that we can follow best code practices when developing in a given language

@nicoalee nicoalee self-assigned this Nov 2, 2023
Copy link
Member

@anibalsolon anibalsolon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Poor person that will need to edit controller.ts

It is great, we could add to the readme as well to enable the hook in their clone: npx husky install

@nicoalee nicoalee merged commit b52751b into brainlife:master Nov 9, 2023
1 check passed
Copy link
Collaborator

@dlevitas dlevitas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants