feat: 🎸 support for gitee

Author: zWingz

README.md

@@ -17,12 +17,17 @@ plugin for [PicGo](https://github.com/Molunerfinn/PicGo)
 - token: github `access token`
 - path: file path
 - customUrl: used to insead of `https://raw.githubusercontent.com/:owner/:repo/:branch/:path/:filename`, eg: `${customUrl}/path/filename.jpg`
+- origin: `github` or `gitee`, default `github`
 
 makesure the `customUrl` can access your `repo`
 
 ![](https://zwing.site/imgur/57566062-a7752000-73fa-11e9-99c1-e3a0562bc41d.png)
 
 ### Menu
 
-- Sync github: Just sync `data.json` (use latest updated)
-- Pull github: Pull all `img` info from github (**force** and **override** local `data.json`)
+- Sync origin: Just sync `data.json` (use latest updated)
+- Pull origin: Pull all `img` info from origin (**force** and **override** local `data.json`)
+
+## Support gitee
+
+由于`gitee`文件大小有`1mb`限制, 所以超过`1mb`的文件无法通过外链获取

index.ts

@@ -22,10 +22,10 @@ function notic (showNotification: Function, title: string, body?: string) {
 }
 
 const SyncGithubMenu = {
-  label: 'Sync github',
+  label: 'Sync origin',
   async handle (ctx: picgo, { showNotification }) {
     const octokit = initOcto(ctx)
-    notic(showNotification, 'Sync github...')
+    notic(showNotification, 'Sync origin...')
     const githubDataJson = await octokit.getDataJson().catch(e => {
       ctx.log.error(e)
       notic(showNotification, 'Error at load dataJson', e.message)
@@ -49,7 +49,7 @@ const SyncGithubMenu = {
         }
       } catch (e) {
         ctx.log.error(e)
-        notic(showNotification, 'Error at sync github', e.message)
+        notic(showNotification, 'Error at sync origin', e.message)
         throw e
       }
     } else {
@@ -70,15 +70,15 @@ const SyncGithubMenu = {
         }
       })
     }
-    notic(showNotification, 'Sync successful', 'Succeed to sync github')
+    notic(showNotification, 'Sync successful', 'Succeed to sync origin')
   }
 }
 
 const PullGithubMenu = {
-  label: 'Pull github',
+  label: 'Pull origin',
   handle: async (ctx: picgo, { showNotification }) => {
     const octokit = initOcto(ctx)
-    notic(showNotification, 'Pull img from github...')
+    notic(showNotification, 'Pull img from origin...')
     try {
       const { tree } = await octokit.getPathTree()
       const imgList: ImgType[] = tree
@@ -104,10 +104,10 @@ const PullGithubMenu = {
           lastSync: getNow()
         }
       })
-      notic(showNotification, 'Pull successful', 'Succeed to pull from github')
+      notic(showNotification, 'Pull successful', 'Succeed to pull from origin')
     } catch (e) {
       ctx.log.error(e)
-      notic(showNotification, 'Error at pull from github', e.message)
+      notic(showNotification, 'Error at pull from origin', e.message)
     }
   }
 }
@@ -226,6 +226,19 @@ const config = (ctx: picgo): PluginConfig[] => {
       type: 'input',
       default: userConfig.customUrl || '',
       required: false
+    },
+    {
+      name: 'origin',
+      type: 'list',
+      default: userConfig.type || 'github',
+      required: true,
+      choices: [{
+        name: 'github',
+        value: 'github'
+      }, {
+        name: 'gitee',
+        value: 'gitee'
+      }]
     }
   ]
   return conf

lib/interface.ts

@@ -4,6 +4,7 @@ export interface PluginConfig {
   path?: string,
   token: string,
   customUrl?: string
+  origin?: 'github' | 'gitee'
 }
 
 export type ImgType = {

lib/octokit.ts

@@ -3,6 +3,8 @@ import { getNow, pathJoin } from './helper'
 import { PluginConfig, ImgType } from './interface'
 import urlJoin from 'url-join'
 import { ImgInfo } from 'picgo/dist/utils/interfaces'
+const GithubUrl = 'https://api.github.com'
+const GiteeUrl = 'https://gitee.com/api/v5'
 
 export class Octo {
   owner: string = ''
@@ -12,12 +14,14 @@ export class Octo {
   token: string = ''
   customUrl: string = ''
   octokit: Octokit = null
+  origin: PluginConfig['origin']
   constructor ({
     repo,
     branch,
     path = '',
     token,
-    customUrl = ''
+    customUrl = '',
+    origin = 'github'
   }: PluginConfig) {
     const [owner, r] = repo.split('/')
     if (!r) throw new Error('Error in repo name')
@@ -27,11 +31,15 @@ export class Octo {
     this.path = path
     this.token = token
     this.customUrl = customUrl
+    this.origin = origin
     this.octokit = new Octokit({
+      baseUrl: origin === 'github' ? GithubUrl : GiteeUrl,
       auth: token ? `token ${token}` : undefined
     })
   }
-
+  get isGithub() {
+    return this.origin === 'github'
+  }
   async getTree (sha): Promise<{ path: string; sha: string }[]> {
     const { owner, repo } = this
     const d = await this.octokit.git.getTree({
@@ -55,6 +63,14 @@ export class Octo {
     }
     return { sha, tree }
   }
+  createFile(params) {
+    const { isGithub } = this
+    const request = this.octokit.request(`/repos/:owner/:repo/contents/:path`, {
+      method: isGithub ? 'PUT' : 'POST',
+      ...params
+    })
+    return request
+  }
   async getDataJson (): Promise<{
     lastSync: string
     data: any[]
@@ -97,7 +113,7 @@ export class Octo {
   }
   createDataJson (data) {
     const { owner, repo, branch, path } = this
-    return this.octokit.repos.createFile({
+    return this.createFile({
       owner,
       repo,
       branch,
@@ -110,7 +126,7 @@ export class Octo {
     /* istanbul ignore next */
     const { owner, repo, branch, path = '' } = this
     const { fileName } = img
-    const d = await this.octokit.repos.createFile({
+    const d = await this.createFile({
       owner,
       repo,
       path: pathJoin(path, fileName),
@@ -139,18 +155,19 @@ export class Octo {
     })
   }
   parseUrl (fileName) {
-    const { owner, repo, path, customUrl, branch } = this
+    const { origin, owner, repo, path, customUrl, branch } = this
     if (customUrl) {
       return urlJoin(customUrl, path, fileName)
     }
-    return urlJoin(
+    return origin === 'github' ? urlJoin(
       `https://raw.githubusercontent.com/`,
       owner,
       repo,
       branch,
       path,
       fileName
-    )
+    ) : urlJoin(`https://gitee.com`, owner, repo, 'raw', branch, path, fileName)
+    // https://gitee.com/zwing/test/raw/master/57566062-a7752000-73fa-11e9-99c1-e3a0562bc41d.png
   }
 }