15 add function to set up precommit

[oadetayo]

Brief overview of changes

This PR introduces pre-commit hook functionality to the dfeshiny package. It includes:

• A new script R/pre_commit.R containing all pre-commit functions.
• Corresponding test cases in testthat/test_precommit.R.

Why are these changes being made?

• To ensure automated checks before committing code, improving code quality and consistency.
• To prevent accidental commits of improperly formatted or untracked files.
• To introduce structured validation steps, including data validation, analytics key checks, and code styling enforcement.

Detailed description of changes

1. Added pre_commit.R in R/ directory

• pre_commit_innit(skip_analytics = FALSE)

  • Creates a Git pre-commit hook that runs commit_hooks().
  • Saves the hook in .git/hooks/pre-commit and makes it executable.

• commit_hooks(skip_analytics = FALSE)

  • Runs a series of checks before commit:
    • data_checker(): Validates .gitignore and tracked files.
    • check_analytics_key(): Ensures no sensitive Google Analytics keys exist (can be skipped).
    • style_code(): Formats R code in the repository.

2. Added unit tests in testthat/test_precommit.R

• Tests for pre_commit_innit():
  • Ensures the pre-commit hook is created and contains the correct script reference.
• Tests for commit_hooks():
  • Ensures data validation, analytics checks, and styling enforcement function correctly.

Fixes #15.

[rmbielby]

Looks nice, got a few revisions, mainly just to tweak the functionality a little.

[codecov]

Codecov Report

Attention: Patch coverage is 5.00000% with 133 lines in your changes missing coverage. Please review.

Project coverage is 66.45%. Comparing base (5c3bad0) to head (7249bea).

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #92      +/-   ##
==========================================
- Coverage   74.21%   66.45%   -7.76%     
==========================================
  Files          12       13       +1     
  Lines        1109     1249     +140     
==========================================
+ Hits          823      830       +7     
- Misses        286      419     +133     

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5c3bad0...7249bea. Read the comment docs.

[rmbielby]

Few extra things on this one.

[rmbielby]

Few more ideas around the data file validation side.