【手把手帶你擼一個腳手架】第三步, 獲取 github 項目信息

系列文章:

• 【手把手帶你擼一個腳手架】第一步, 建立第一個命令
• 【手把手帶你擼一個腳手架】第二步, 搭建開發環境
• 【手把手帶你擼一個腳手架】第三步, 獲取 github 項目信息
• 【手把手帶你擼一個腳手架】第四步, 經過擼碼獲取項目信息
• 【手把手帶你擼一個腳手架】第五步, 擼完收工

腳手架, 做爲一個工具, 主要是用來搬運咱們已經準備好的項目模板(webpack 配置, koa 項目雛形等等), 這一步咱們就來建立用於搬運的項目模板. 並經過接口獲取相關信息 github Api 文檔

ps: 這一步基於 github 如有沒使用過的小夥伴, 請加油

建立一個專門用於維護項目模板的項目組

爲了避免和本身平時寫的各類辣雞代碼混雜在一塊兒, 這裏我專門建立了一個 organization 不會建立的兄弟們請 度娘

• 目錄切換到剛剛建立的 organization 上

• 建立一個項目

• 向建立的項目中添加一個文件, 上傳到 github 並打好 tag

準備工做完成 ^_^

經過 github 開放 api 獲取項目信息

baseUrl: api.github.com

做爲一個腳手架, 咱們須要獲取的項目信息包含如下幾個:

=========================== 補充 ==============================================

ps 因爲 github 開放 api 有請求次數限制(未受權每小時 60 次), 因此可能存在下圖的狀況, 解決方法是在請求中加入認證信息(authToken), 詳情參考系列文章下一篇, 本節的臨時處理方案爲執行命令時候添加本身的 github 帳號密碼便可.

獲取組織所屬項目列表文檔

咱們能夠嘗試一下獲取剛剛建立的 organization 下的項目目錄

curl https://api.github.com/orgs/learn-cli-organization/repos

// 若是報了上圖所示錯誤, 在 curl 和接口地址中間加入 -u "你的github帳號:你的github密碼" 中間的冒號不要刪除, 做爲分割
curl -u "你的github帳號:你的github密碼" https://api.github.com/orgs/learn-cli-organization/repos

// 返回的結果
[
  {
    "id": 157579674,
    "node_id": "MDEwOlJlcG9zaXRvcnkxNTc1Nzk2NzQ=",
    "name": "demo",
    "full_name": "learn-cli-organization/demo",
    "private": false,
    "owner": {
      "login": "learn-cli-organization",
      "id": 45043923,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjQ1MDQzOTIz",
      "avatar_url": "https://avatars2.githubusercontent.com/u/45043923?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/learn-cli-organization",
      "html_url": "https://github.com/learn-cli-organization",
      "followers_url": "https://api.github.com/users/learn-cli-organization/followers",
      "following_url": "https://api.github.com/users/learn-cli-organization/following{/other_user}",
      "gists_url": "https://api.github.com/users/learn-cli-organization/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/learn-cli-organization/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/learn-cli-organization/subscriptions",
      "organizations_url": "https://api.github.com/users/learn-cli-organization/orgs",
      "repos_url": "https://api.github.com/users/learn-cli-organization/repos",
      "events_url": "https://api.github.com/users/learn-cli-organization/events{/privacy}",
      "received_events_url": "https://api.github.com/users/learn-cli-organization/received_events",
      "type": "Organization",
      "site_admin": false
    },
    "html_url": "https://github.com/learn-cli-organization/demo",
    "description": null,
    "fork": false,
    "url": "https://api.github.com/repos/learn-cli-organization/demo",
    "forks_url": "https://api.github.com/repos/learn-cli-organization/demo/forks",
    "keys_url": "https://api.github.com/repos/learn-cli-organization/demo/keys{/key_id}",
    "collaborators_url": "https://api.github.com/repos/learn-cli-organization/demo/collaborators{/collaborator}",
    "teams_url": "https://api.github.com/repos/learn-cli-organization/demo/teams",
    "hooks_url": "https://api.github.com/repos/learn-cli-organization/demo/hooks",
    "issue_events_url": "https://api.github.com/repos/learn-cli-organization/demo/issues/events{/number}",
    "events_url": "https://api.github.com/repos/learn-cli-organization/demo/events",
    "assignees_url": "https://api.github.com/repos/learn-cli-organization/demo/assignees{/user}",
    "branches_url": "https://api.github.com/repos/learn-cli-organization/demo/branches{/branch}",
    "tags_url": "https://api.github.com/repos/learn-cli-organization/demo/tags",
    "blobs_url": "https://api.github.com/repos/learn-cli-organization/demo/git/blobs{/sha}",
    "git_tags_url": "https://api.github.com/repos/learn-cli-organization/demo/git/tags{/sha}",
    "git_refs_url": "https://api.github.com/repos/learn-cli-organization/demo/git/refs{/sha}",
    "trees_url": "https://api.github.com/repos/learn-cli-organization/demo/git/trees{/sha}",
    "statuses_url": "https://api.github.com/repos/learn-cli-organization/demo/statuses/{sha}",
    "languages_url": "https://api.github.com/repos/learn-cli-organization/demo/languages",
    "stargazers_url": "https://api.github.com/repos/learn-cli-organization/demo/stargazers",
    "contributors_url": "https://api.github.com/repos/learn-cli-organization/demo/contributors",
    "subscribers_url": "https://api.github.com/repos/learn-cli-organization/demo/subscribers",
    "subscription_url": "https://api.github.com/repos/learn-cli-organization/demo/subscription",
    "commits_url": "https://api.github.com/repos/learn-cli-organization/demo/commits{/sha}",
    "git_commits_url": "https://api.github.com/repos/learn-cli-organization/demo/git/commits{/sha}",
    "comments_url": "https://api.github.com/repos/learn-cli-organization/demo/comments{/number}",
    "issue_comment_url": "https://api.github.com/repos/learn-cli-organization/demo/issues/comments{/number}",
    "contents_url": "https://api.github.com/repos/learn-cli-organization/demo/contents/{+path}",
    "compare_url": "https://api.github.com/repos/learn-cli-organization/demo/compare/{base}...{head}",
    "merges_url": "https://api.github.com/repos/learn-cli-organization/demo/merges",
    "archive_url": "https://api.github.com/repos/learn-cli-organization/demo/{archive_format}{/ref}",
    "downloads_url": "https://api.github.com/repos/learn-cli-organization/demo/downloads",
    "issues_url": "https://api.github.com/repos/learn-cli-organization/demo/issues{/number}",
    "pulls_url": "https://api.github.com/repos/learn-cli-organization/demo/pulls{/number}",
    "milestones_url": "https://api.github.com/repos/learn-cli-organization/demo/milestones{/number}",
    "notifications_url": "https://api.github.com/repos/learn-cli-organization/demo/notifications{?since,all,participating}",
    "labels_url": "https://api.github.com/repos/learn-cli-organization/demo/labels{/name}",
    "releases_url": "https://api.github.com/repos/learn-cli-organization/demo/releases{/id}",
    "deployments_url": "https://api.github.com/repos/learn-cli-organization/demo/deployments",
    "created_at": "2018-11-14T16:41:01Z",
    "updated_at": "2018-11-14T16:42:39Z",
    "pushed_at": "2018-11-14T16:43:18Z",
    "git_url": "git://github.com/learn-cli-organization/demo.git",
    "ssh_url": "git@github.com:learn-cli-organization/demo.git",
    "clone_url": "https://github.com/learn-cli-organization/demo.git",
    "svn_url": "https://github.com/learn-cli-organization/demo",
    "homepage": null,
    "size": 0,
    "stargazers_count": 0,
    "watchers_count": 0,
    "language": "JavaScript",
    "has_issues": true,
    "has_projects": true,
    "has_downloads": true,
    "has_wiki": true,
    "has_pages": false,
    "forks_count": 0,
    "mirror_url": null,
    "archived": false,
    "open_issues_count": 0,
    "license": null,
    "forks": 0,
    "open_issues": 0,
    "watchers": 0,
    "default_branch": "master",
    "permissions": {
      "admin": false,
      "push": false,
      "pull": true
    }
  }
]
複製代碼

拿到這個數組說明咱們已經可以獲取到項目組中的全部項目啦, 一波猝不及防的商業互吹 ^_^

獲取指定項目的版本號 文檔

經過前一個接口, 咱們成功的獲取到了項目組中全部的項目信息, 接下來咱們能夠經過如下接口獲取到指定項目的版本信息(就是 tags)

curl https://api.github.com/repos/learn-cli-organization/demo/tags

// 若是報了上圖所示錯誤, 在 curl 和接口地址中間加入 -u "你的github帳號:你的github密碼" 中間的冒號不要刪除, 做爲分割
curl -u "你的github帳號:你的github密碼" https://api.github.com/repos/learn-cli-organization/demo/tags

// 返回結果
[
  {
    "name": "v0.0.1",
    "zipball_url": "https://api.github.com/repos/learn-cli-organization/demo/zipball/v0.0.1",
    "tarball_url": "https://api.github.com/repos/learn-cli-organization/demo/tarball/v0.0.1",
    "commit": {
      "sha": "00f0dda86e5f922e2ae406c25e19b44b2463f690",
      "url": "https://api.github.com/repos/learn-cli-organization/demo/commits/00f0dda86e5f922e2ae406c25e19b44b2463f690"
    },
    "node_id": "MDM6UmVmMTU3NTc5Njc0OnYwLjAuMQ=="
  }
]
複製代碼

下集預告: 到目前爲止, 咱們已經可以獲取到項目信息. 下一步咱們會將結合 inquirer.js 實現命令行交互式的動態獲取這些信息