-
-
Notifications
You must be signed in to change notification settings - Fork 17
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
OO refactoring and git-blame preloading #12
Commits on Mar 1, 2020
-
Create a Git repository abstraction with just what we need. This will be continued with a Book class holding/storing the info about the whole book, its size and its authors.
Configuration menu - View commit details
-
Copy full SHA for b41e299 - Browse repository at this point
Copy the full SHA b41e299View commit details
Commits on Mar 2, 2020
-
Have dedicated objects: - Repo - Author - Page - Commit handle all the data and responsibilities.
Configuration menu - View commit details
-
Copy full SHA for f90ef72 - Browse repository at this point
Copy the full SHA f90ef72View commit details -
This commit creates the Page objects within the on_files MkDocs event. As a result the lines/contribution statistics for the whole book are now available from within *every* Markdown page.
Configuration menu - View commit details
-
Copy full SHA for 558dfc3 - Browse repository at this point
Copy the full SHA 558dfc3View commit details -
Merge remote-tracking branch 'origin/master' into preload-blame
# Conflicts: # mkdocs_git_authors_plugin/plugin.py # mkdocs_git_authors_plugin/util.py
Configuration menu - View commit details
-
Copy full SHA for 7dbec73 - Browse repository at this point
Copy the full SHA 7dbec73View commit details -
The 00000 "commit" shown by git blame for uncommitted lines caused the plugin to crash when trying to execute "git show" on it. Therefore uncommitted stuff is attributed to a fake author whose display characteristics are configurable.
Configuration menu - View commit details
-
Copy full SHA for f37c9f8 - Browse repository at this point
Copy the full SHA f37c9f8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 98bffc3 - Browse repository at this point
Copy the full SHA 98bffc3View commit details
Commits on Mar 3, 2020
-
Add {{ git_authors_list }} (book-level summary)
Inserting {{ git_authors_list }} in any Markdown file will insert a list of all authors along with their contribution to the whole site. Adds configuration options: - show_lines (default: false) also show the line count in the list (but not on a page's summary) - label_lines (for localization) TODO: Provide *real* configurability of the resulting HTML
Configuration menu - View commit details
-
Copy full SHA for 2739240 - Browse repository at this point
Copy the full SHA 2739240View commit details -
Adds configuration options - sort_by (choice: 'name', 'contribution') - sort_reverse (bool, default: False)
Configuration menu - View commit details
-
Copy full SHA for 0869525 - Browse repository at this point
Copy the full SHA 0869525View commit details -
Configuration menu - View commit details
-
Copy full SHA for bc2fa53 - Browse repository at this point
Copy the full SHA bc2fa53View commit details -
There may be users not interested in counting empty lines as content.
Configuration menu - View commit details
-
Copy full SHA for ca06d20 - Browse repository at this point
Copy the full SHA ca06d20View commit details -
Configuration menu - View commit details
-
Copy full SHA for bac88c0 - Browse repository at this point
Copy the full SHA bac88c0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 251adc3 - Browse repository at this point
Copy the full SHA 251adc3View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0da9409 - Browse repository at this point
Copy the full SHA 0da9409View commit details -
Configuration menu - View commit details
-
Copy full SHA for e5c54ed - Browse repository at this point
Copy the full SHA e5c54edView commit details -
Configuration menu - View commit details
-
Copy full SHA for bbba457 - Browse repository at this point
Copy the full SHA bbba457View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7b178dc - Browse repository at this point
Copy the full SHA 7b178dcView commit details -
Configuration menu - View commit details
-
Copy full SHA for 270cc1f - Browse repository at this point
Copy the full SHA 270cc1fView commit details -
Use repo argument directly in Commit.__init__
We don't have to go through the member accessor function when we have the repo reference as a function argument.
Configuration menu - View commit details
-
Copy full SHA for 7f1726c - Browse repository at this point
Copy the full SHA 7f1726cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 422653b - Browse repository at this point
Copy the full SHA 422653bView commit details -
This method is only used once and can easily be avoided by directly passing the sha argument to Commit._populate. Incidentally: Move the handling of uncommitted lines *into* Commit._populate
Configuration menu - View commit details
-
Copy full SHA for acd4506 - Browse repository at this point
Copy the full SHA acd4506View commit details -
Factor out commit_datetime function
This is not related to the actual object but a simple conversion function and therefore an optimal candidate for a generic "util" module
Configuration menu - View commit details
-
Copy full SHA for 71eeae2 - Browse repository at this point
Copy the full SHA 71eeae2View commit details -
Configuration menu - View commit details
-
Copy full SHA for d5f6159 - Browse repository at this point
Copy the full SHA d5f6159View commit details -
Rename Repo.commit() to Repo.get_commit()
The previous name raised concerns about users being worried "commit" might be used as a verb (i.e. creating commits in the actual repository).
Configuration menu - View commit details
-
Copy full SHA for 709b0e0 - Browse repository at this point
Copy the full SHA 709b0e0View commit details -
Remove localization config variables
The configuration variables intended for localization have to be removed because the functionality will at one point be handled by localization. See timvink#14
Configuration menu - View commit details
-
Copy full SHA for e6c6a8b - Browse repository at this point
Copy the full SHA e6c6a8bView commit details
Commits on Mar 4, 2020
-
This is necessary to get a hold on the whole element through CSS, for example to make it invisible (in certain contexts).
Configuration menu - View commit details
-
Copy full SHA for 65d1779 - Browse repository at this point
Copy the full SHA 65d1779View commit details -
Clarify event order in on_files
It should be clear to any future contributor that when the on_page event stage is reached all pages have already been parsed and the repo-wide statistics are available.
Configuration menu - View commit details
-
Copy full SHA for 4a208dc - Browse repository at this point
Copy the full SHA 4a208dcView commit details -
Format repo_authors list in util
This is to separate concerns: Move the formatting of the list of authors to the repo not in the Git classes but separately.
Configuration menu - View commit details
-
Copy full SHA for ba91edd - Browse repository at this point
Copy the full SHA ba91eddView commit details -
Use --porcelain version of git blame
Closes timvink#20 While parsing the --porcelain output of git blame is more complicated than that of git blame -lts * it should be considered more robust * it provides substantially more information: - we can get all information about the commits that we need - this makes it obsolete to call `git show` on the commits The format of the commit timestamp is different in this command, therfore this had to modify the datetime processing functions, which were moved to util.py at the same time.
Configuration menu - View commit details
-
Copy full SHA for 6f5822c - Browse repository at this point
Copy the full SHA 6f5822cView commit details