mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
72 lines
2.5 KiB
JavaScript
72 lines
2.5 KiB
JavaScript
/*
|
|
* Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*/
|
|
|
|
import Abstract from "./Abstract"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Class
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
export default class GitHub extends Abstract {
|
|
|
|
/**
|
|
* Retrieve repository information from GitHub
|
|
*
|
|
* @constructor
|
|
*
|
|
* @property {string} name_ - Name of the repository
|
|
*
|
|
* @param {(string|HTMLAnchorElement)} el - Selector or HTML element
|
|
*/
|
|
constructor(el) {
|
|
super(el)
|
|
|
|
/* Extract user and repository name from URL, as we have to query for all
|
|
repositories, to omit 404 errors for private repositories */
|
|
const [, user, name] = /^.+github\.com\/([^\/]+)\/([^\/]+).*$/
|
|
.exec(this.base_)
|
|
|
|
/* Initialize base URL and repository name */
|
|
this.base_ = `https://api.github.com/users/${user}/repos`
|
|
this.name_ = name
|
|
}
|
|
|
|
/**
|
|
* Fetch relevant repository information from GitHub
|
|
*
|
|
* @return {Promise<Array<string>>} Promise returning an array of facts
|
|
*/
|
|
fetch_() {
|
|
return fetch(this.base_)
|
|
.then(response => response.json())
|
|
.then(data => {
|
|
const repo = data.find(item => item.name === this.name_)
|
|
return repo
|
|
? [
|
|
`${this.format_(repo.stargazers_count)} Stars`,
|
|
`${this.format_(repo.forks_count)} Forks`
|
|
]
|
|
: []
|
|
})
|
|
}
|
|
}
|