Include Github https repository getter utility #243
新建议题
Have a question about this project? 注册 for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “注册 for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? 登录 to your account
Open
alwell-kevin
wants to merge
1
commit into
master
Choose a base branch
from
repo-getter
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
提交
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # github-repo-getter | ||
|
|
||
| * Download Enterprise 仓库 from GitHub through the CLI using HTTPS; | ||
|
|
||
| * Command Line utility that automatically downloads a 仓库 @branch from your enterprise organization. | ||
|
|
||
| * This package uses HTTPS instead of GIT to retrieve repositories. This allows you to retrieve projects securely from within restricted networks by whitelisting a machine IP egress at the network firewall level after SSHing into that machine. | ||
|
|
||
| ## USAGE | ||
|
|
||
| **Installation** | ||
|
|
||
| * npm i -g github-repo-getter | ||
|
|
||
| **Prompts** | ||
|
|
||
| * <user>$: `github-repo-getter` | ||
|
|
||
| * Enter GitHub username. | ||
|
|
||
| * Enter 组织 name. | ||
|
|
||
| * Enter 仓库 name. | ||
|
|
||
| * Enter Branch name. | ||
|
|
||
| * Enter personal access token | ||
|
|
||
| > You should now have that repository in your local filesystem. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| const chalk = require('chalk'); | ||
| const clear = require('clear'); | ||
| const figlet = require('figlet'); | ||
|
|
||
| const files = require('./lib/files'); | ||
| const inquirer = require('./lib/inquirer'); | ||
| const github = require('./lib/github'); | ||
| const CLI = require('clui'); | ||
| var Spinner = CLI.Spinner; | ||
|
|
||
| const run = async () => { | ||
| clear(); | ||
|
|
||
| console.log( | ||
| chalk.yellow( | ||
| figlet.textSync('GitHub Repo Getter', { | ||
| horizontalLayout: 'full' | ||
| }) | ||
| ) | ||
| ); | ||
|
|
||
| const gitHubMeta = await inquirer.askGithubMeta(); | ||
| const spiner = new Spinner('Retrieving your Project, please wait...'); | ||
| spiner.start(); | ||
|
|
||
| github.getRepo(gitHubMeta, spiner).then(function(repo) { | ||
| console.log("Got Project: ", gitHubMeta.repo) | ||
| spiner.stop(); | ||
| }) | ||
| } | ||
|
|
||
| run(); | ||
19 changes: 19 additions & 0 deletions
19
api/javascript/github-https-repository-getter/lib/files.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
|
|
||
|
|
||
| const getCurrentDirectoryBase = () => { | ||
| return path.basename(process.cwd()); | ||
| } | ||
|
|
||
| const directoryExists = (filePath) => { | ||
| try { | ||
| return fs.statSync(filePath).isDirectory(); | ||
| } catch (err) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
|
|
||
| module.exports.getCurrentDirectoryBase = getCurrentDirectoryBase; | ||
| module.exports.directoryExists = directoryExists; |
32 changes: 32 additions & 0 deletions
32
api/javascript/github-https-repository-getter/lib/github.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,32 @@ | ||||||
| var download = require("download"); | ||||||
| var request = require('request'); | ||||||
|
|
||||||
| var getRepo = (inputs, spiner) => { | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| return new Promise(function(resolve, reject) { | ||||||
| var auth = "Bearer " + inputs.pat; | ||||||
|
|
||||||
| const options = { | ||||||
| "headers": { | ||||||
| "authorization": auth, | ||||||
| "accept": "application/zip", | ||||||
| "User-Agent": inputs.userAgent | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| var uri = "https://github.com/" + inputs.org + "/" + inputs.repo + "/archive/" + inputs.branch + ".zip" | ||||||
|
|
||||||
| download(uri, './', options, function(err) { | ||||||
| console.log(err) | ||||||
|
|
||||||
| reject(err); | ||||||
| }).then(data => { | ||||||
| console.log("Success!"); | ||||||
|
|
||||||
| resolve(data); | ||||||
| }); | ||||||
| }); | ||||||
| } | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| module.exports.getRepo = getRepo; | ||||||
70 changes: 70 additions & 0 deletions
70
api/javascript/github-https-repository-getter/lib/inquirer.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| const inquirer = require('inquirer'); | ||
| const files = require('./files'); | ||
|
|
||
|
|
||
|
|
||
| const askGithubMeta = () => { | ||
| const metaInput = [{ | ||
| name: 'userAgent', | ||
| type: 'input', | ||
| message: 'Enter your GitHub Username.', | ||
| validate: function(value) { | ||
| if (value.length) { | ||
| return true; | ||
| } else { | ||
| return 'Enter your GitHub Username.'; | ||
| } | ||
| } | ||
| }, { | ||
| name: 'org', | ||
| type: 'input', | ||
| message: 'Enter the name of your GitHub 组织. (Found in the url)', | ||
| validate: function(value) { | ||
| if (value.length) { | ||
| return true; | ||
| } else { | ||
| return 'Enter the name of your GitHub 组织. (Found in the url)'; | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| name: 'repo', | ||
| type: 'input', | ||
| message: 'Enter the name of your GitHub 仓库. (Found in the url)', | ||
| validate: function(value) { | ||
| if (value.length) { | ||
| return true; | ||
| } else { | ||
| return 'Enter the name of your GitHub 仓库. (Found in the url)'; | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| name: 'branch', | ||
| type: 'input', | ||
| message: 'Enter the branch name of your GitHub 仓库.', | ||
| validate: function(value) { | ||
| if (value.length) { | ||
| return true; | ||
| } else { | ||
| return 'Enter the branch name of your GitHub 仓库.'; | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| name: 'pat', | ||
| type: 'password', | ||
| message: 'Enter your valid GitHub Personal Access Token.', | ||
| validate: function(value) { | ||
| if (value.length) { | ||
| return true; | ||
| } else { | ||
| return 'Enter your valid GitHub Personal Access Token.'; | ||
| } | ||
| } | ||
| } | ||
| ]; | ||
| return inquirer.prompt(metaInput); | ||
| } | ||
|
|
||
| module.exports.askGithubMeta = askGithubMeta; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.