gitr 0.0.2

Features 🚀

• Feature upgrade for git_checkout() (#2)
  • you can now checkout either a "branch"
    or a "file". File checkout is commonly
    used to revert local changes to that file
    to the most recent commit state.
  • improved edge-case catches and unit testing

New Functions ✨

• git_current_sha()

  • self explanatory, gets current commit sha

• git_local_br()

  • gets all the local branches

• is_sha()

  • logical, does it look like a SHA-1 hex?

Unit tests (#5) 🦺

• Set up special gitr unit testing fixtures

  • new: local_create_worktree()
  • see:
    https://testthat.r-lib.org/articles/test-fixtures.html
  • special worktree for unit testing
  • cleans up when finished each test-*.R file
  • does the following:
    • sets gitr_echo_cmd = FALSE
    • creates git worktree for testing
    • sets working directory to that worktree
    • returns to testing working directory when complete
    • deletes git worktree when complete

• New unit tests for:

  • get_commit_msgs()
  • get_recent_tag()
  • git_checkout()
  • git_tag_info()
  • git_recent_tag()
  • git_checkout()
  • git_current_br()
  • git_defaults_br()
  • git_current_sha()
  • git_version()

• Updated git() unit tests

  • now more meaningful
  • previously didn't return anything (very bare bones)
  • now actually tests something and uses testthat::snapshot framework

Breaking changes! ⚠️

• gclean()
  • parameter to gclean() is now dry_run (not dry.run)
  • note the move away from . dot notation;
    now underscore to better fit with package convention

Documentation 📖

• Major documentation cleanup
  • updated syntax and spacing of roxygen docs
  • expanded examples
  • collated docs by group

Bug Fixes 🐛

• Make git_recent_tag() more robust (@malcook; #16)

  • allow for asynchronous date tagging, aka
    the most "recent" tag, rather than the
    alpha-numeric sorting
  • thanks @malcook!
  • git_recent_tag() no longer echos command by default
    • small, possibly breaking, change depending on unit tests
    • mostly a UI change at the console

• Fixed a bug in git_diffcommits()

  • indexing is now correct (x - 1)

• Fix bug in get_pr_sha() (@stu.g.field; #10, #11)

  • index the stdout properly in the if-else
    so that the function returns NULL
    rather than "" if there is no SHA to find
  • the presence/absence of NULL can then
    be tested for in downstream code

Improvements 🚧

• New gitr_echo_cmd global option feature (#14)

  • the echo_cmd parameter is now additionally
    controlled by a global option, gitr_echo_cmd
  • this option defaults to TRUE
  • note: the global option is takes precedence over
    passed the echo_cmd = parameter inside git() call
  • added color (blue) to the echoed
    command when echo_cmd = TRUE

• No longer print full diff-commit to the console

  • much too verbose
  • more streamlined now and user friendly

• Fixed pipe | escapes in README

  • some ZSH aliases had '|' in the definition,
    messing up the table tabs in markdown syntax

• Upgrades to the pkgdown 'Git Started' in the navbar

  • for the gitr vignette introduction
  • more vignettes/articles to come

• Minor tweak to trim_sha() (#9)

  • returns char(7) if a sha
  • otherwise no trim occurs (orig string)
  • overall: is_sha() must be TRUE
    for any trimming
  • now vectorized; character(1) -> character(n)