feat: add option number (gitalk#168)

Author: 张德明

readme-cn.md

@@ -88,6 +88,12 @@ gitalk.render('gitalk-container')
  Default: `location.href`.
 
  页面的唯一标识。长度必须小于50。
+ 
+- **number** `Number` 
+ 
+ Default: `null`.
+
+ 页面的 issue ID 标识，若未定义`number`属性则会使用`id`进行定位。
 
 - **labels** `Array` 
 

readme-zh.md

@@ -90,6 +90,12 @@ gitalk.render('gitalk-container')
 
  頁面的唯一標識。長度必須小於50。
 
+- **number** `Number` 
+ 
+ Default: `null`.
+
+ 頁面的 issue ID，若未定義`number`屬性則會使用`id`進行定位。 
+
 - **labels** `Array`
 
  Default: `['Gitalk']`.

readme.md

@@ -92,6 +92,12 @@ gitalk.render('gitalk-container')
 
  The unique id of the page. Length must less than 50.
 
+- **number** `Number` 
+ 
+ Default: `location.href`.
+
+ The issue ID of the page, if the `number` attribute is not defined, issue will be located using `id`.
+
 - **labels** `Array` 
 
  Default: `['Gitalk']`.

src/gitalk.jsx

@@ -51,6 +51,7 @@ class GitalkComponent extends Component {
  super(props)
  this.options = Object.assign({}, {
  id: location.href,
+ number: -1,
  labels: ['Gitalk'],
  title: document.title,
  body: '', // location.href + header.meta[description]
@@ -187,13 +188,36 @@ class GitalkComponent extends Component {
  this.logout()
  })
  }
- getIssue () {
- const { issue } = this.state
- if (issue) {
- this.setState({ isNoInit: false })
- return Promise.resolve(issue)
- }
+ getIssueById () {
+ const { owner, repo, number, clientID, clientSecret } = this.options
+ const getUrl = `/repos/${owner}/${repo}/issues/${number}`
+
+ return new Promise((resolve, reject) => {
+ axiosGithub.get(getUrl, {
+ params: {
+ client_id: clientID,
+ client_secret: clientSecret,
+ t: Date.now()
+ }
+ })
+ .then(res => {
+ let issue = null
+
+ if (res && res.data && res.data.number === number) {
+ issue = res.data
 
+ this.setState({ issue, isNoInit: false })
+ }
+ resolve(issue)
+ })
+ .catch(err => {
+ // When the status code is 404, promise will be resolved with null
+ if (err.response.status === 404) resolve(null)
+ reject(err)
+ })
+ })
+ }
+ getIssueByLabels () {
  const { owner, repo, id, labels, clientID, clientSecret } = this.options
 
  return axiosGithub.get(`/repos/${owner}/${repo}/issues`, {
@@ -220,6 +244,21 @@ class GitalkComponent extends Component {
  return issue
  })
  }
+ getIssue () {
+ const { number, issue } = this.options
+ if (issue) {
+ this.setState({ isNoInit: false })
+ return Promise.resolve(issue)
+ }
+
+ if (typeof number === 'number' && number > 0) {
+ return this.getIssueById().then(resIssue => {
+ if (!resIssue) return this.getIssueByLabels()
+ return resIssue
+ })
+ }
+ return this.getIssueByLabels()
+ }
  createIssue () {
  const { owner, repo, title, body, id, labels, url } = this.options
  return axiosGithub.post(`/repos/${owner}/${repo}/issues`, {