fischermaen / vuepress-plugin-contributors Goto Github PK

Handling similar to avatarProvider.

Automatic detection can be provided for github and gitlab, as long as the user name used in commits is the username on github / gitlab. Provide an option "userProfileUrlProvider" to specify "gitlab", "github" or a custom function(user) to resolve the profile url.

With cross-spawn in version 7.0.3 the function getGitShortlog always returns an empty result.
The following workaround helped me to get the expected result:

function getGitShortlog(baseDir) {
    let shortlog
    try {
        shortlog = spawn.sync(
            'git', 
            ['shortlog', '-nse', '--no-merges', 'HEAD', '--', baseDir],
            { shell: true }
        ).stdout.toString();
    } catch (e) { console.log(e); }
    return shortlog
}

The further options parameter { shell: true } let the function work as expected.

All should be configurable:

• avatars
  • fetch them from github (default), gitlab or gravatar
  • as an alternative a function could be configured to provide the avatar from other sources.
  • size of avatar (default: 32)
  • default avatar, when no avatar is available
• number of commits
  • switch on or off

There is an error reported while building vuepress documentation. Caused by property _content doesn't exists.