RepoSense v1.10
Documentation
Breaking Changes
Previously, all commits are captured and analyzed if a --since
date flag is not specified.
We have modified this default behaviour; only commits made within one month before the date of report generation will be analysed if the --since
date flag is not provided. To analyze the full history of repositories, do include --since d1
or -s d1
.
New Features
Custom Grouping of Files/Folders (NEW)
- Users can now categorize multiple files/folders into groups, by supplying
group-config.csv
as an optional configuration file. - Contributions will then be broken down by groups instead of file formats.
CLI and Behavioral Changes
- Added highlighted tags to warning and error messages in the console display.
- Added progress for the number of repositories analyzed.
- Changed default file formats to all non-binary files if it is not specified within configuration files or command line options.
- The analysis is now inclusive of the until date.
Chart Panel
- CMD-clicking (for Mac OS) or CTRL-clicking (for other OSes) two points in a ramp chart will now show the list of commits made within that duration in the commit panel.
- Added a new button, to displays the list of all commits in the commit panel, next to the title of each ramp chart.
- Added a new button,
reset date range
, to reset both since date and until date controls to their initial values. - Added a new checkbox,
merge group
, to merge all charts within the same group to a single chart when checked. - [For Chrome and Firefox users] Clearing the date controls (by pressing the
X
button) will now resetsince
date to the earliest date or theuntil
date to the latest date.
Commit Panel (NEW)
- A list of commits from a ramp chart and their details can be viewed in the commit panel.
- A subset of the commits based on a selected region in a ramp chart can be viewed in the commit panel. This gives a zoomed-in look at the commits made by an author in the sub-date range.
- The
since
anduntil
dates can be set to that of the selected region by clicking onShow ramp chart for this period
.
UI Changes
Chart Panel
- Modified the chart title of repositories to use the format: organizationName/repoName[branchName].
- Added a prominent message box at the top of the chart panel to display compilation of errors that occurred during the analysis.
- Repositories with no commits made within the analysis time period when authors are not specified in the configuration files will now display a prominent message
NO COMMITS FOUND WITHIN THIS PERIOD OF TIME
in red.
- Repositories with no commits made within the analysis time period when authors are not specified in the configuration files will now display a prominent message
- Number of lines contributed is now displayed beside each group title and chart title.
Code Panel
- Changed the icon that toggles the viewing of untouched codes to a
+
icon to reduce the white-spaces between touched and untouched codes. - Shifted sorting option to be above the radio controls.
- Standardized the font size and gaps between controls (search bar, checkbox, sort).
- Added line numbers to text in code view.
Optimization
- Better optimization of analyzing process for Windows OS.
- Improved code view loading time by load untouched codes in the code panel on demand.
Other Changes
- Binary files are no longer analyzed nor displayed in the report.
Bug Fixes
- Fixed a bug where files not generated by RepoSense are zipped.
- Fixed improper parsing of config csv files when commas or double-quotes are included in the fields.
Report View
- Fixed a bug where ramps that are not within the filtered dates are still visible.
- Fixed a bug where the name of the author/repository is not aligned
- Fixed a bug where the code view cannot be restored when revisited.
- Fixed a bug where the toolbar does not adapt to the changes in width when the chart panel is resized.
- Fixed a bug where no errors are shown to the user when a non
.zip
file is uploaded to the report view. - Fixed a bug where the selected region for the commits panel is not cleared when settings are changed.
- [For Microsoft Edge] Fixed a bug where code view cannot be loaded.
- [For Safari] Fixed a bug where
since
anduntil
date in the toolbar cannot be modified. - [For Safari] Fixed a bug where the search function is broken.