visit-github 0.0.2 → 0.0.3

package/Readme.md

@@ -1,25 +1,32 @@
-## 访问GitHub
-
-
-### 注意
-> 1. windows 使用时请时使用`管理员权限`打开命令行工具
-> 2. 如果您的hosts文件特别重要，请自己手动备份
-> 3. mac 电脑上要使用`sudo zx-github`命令，需要管理员权限
-
-#### 介绍
-> 当前项目已经在mac与windows电脑运行成功，余下linux
-
-#### 安装
-```
-npm install visit-github -g
-```
-
-#### 使用
-
-> visit-github 两条功能命令
-1. `zx-github`      更新备份hosts文件，只备份第一次的hosts文件
-2. `zx-github -r`   恢复备份的hosts文件
-
-
-#### 感谢
+## 访问GitHub
+
+
+### 注意
+> 1. windows 使用时请时使用`管理员权限`打开命令行工具
+> 2. 如果您的hosts文件特别重要，请自己手动备份
+> 3. mac 电脑上要使用`sudo zx-github`命令，需要管理员权限
+
+#### 介绍
+> 当前项目已经在mac与windows电脑运行成功，余下linux
+
+
+#### windows 
+> 使用windows系统的同学可以通过exe下的`修改hosts.exe`来操作，这个软件是一个绿色免安装的软件，操作十分简单只用两个按钮，一个修改，一个恢复。`注意：要使用管理员的方式打开，不然没有效果`
+
+#### 安装
+```
+npm install visit-github -g
+```
+
+#### 使用
+
+> visit-github 两条功能命令
+1. `zx-github`      更新备份hosts文件，只备份第一次的hosts文件
+2. `zx-github -r`   恢复备份的hosts文件
+
+#### github
+[项目github地址](https://github.com/HouDiZhong/visit-github)
+
+
+#### 感谢
 使用了[GitHub520](https://github.com/521xueweihan/GitHub520)提供的更新的hosts接口

package/bin/index.js

@@ -1,12 +1,12 @@
-#! /usr/bin/env node
-
-const os = require('os'),
-    platform = os.platform(),
-    program = require('../util/commander')()
-
-const platforms = {
-    win32: require('../lib/win'),
-    darwin: require('../lib/darwin')
-}
-
+#! /usr/bin/env node
+
+const os = require('os'),
+    platform = os.platform(),
+    program = require('../util/commander')()
+
+const platforms = {
+    win32: require('../lib/win'),
+    darwin: require('../lib/darwin')
+}
+
 platforms[platform](program.opts().reset)

package/lib/darwin.js

@@ -1,11 +1,11 @@
-const { init, reset } = require('../util/darwin')
-
-const darwin = function (isReset) {
-    if(isReset) {
-        reset('/etc/', 'hosts_zx_backups')
-    }else {
-        init('/etc/', 'hosts_zx_temporary')
-    }
-}
-
+const { init, reset } = require('../util/darwin')
+
+const darwin = function (isReset) {
+    if(isReset) {
+        reset('/etc/', 'hosts_zx_backups')
+    }else {
+        init('/etc/', 'hosts_zx_temporary')
+    }
+}
+
 module.exports = darwin

package/lib/win.js

@@ -1,12 +1,12 @@
-const { init, reset } = require('../util/win'),
-    MIN_DEFAULT_PATH = 'C:/Windows/System32/drivers/etc/'
-
-const win = function (isReset) {
-    if(isReset) {
-        reset(MIN_DEFAULT_PATH, 'hosts_zx_backups')
-    }else {
-        init(MIN_DEFAULT_PATH, 'hosts_zx_temporary')
-    }
-}
-
+const { init, reset } = require('../util/win'),
+    MIN_DEFAULT_PATH = 'C:/Windows/System32/drivers/etc/'
+
+const win = function (isReset) {
+    if(isReset) {
+        reset(MIN_DEFAULT_PATH, 'hosts_zx_backups')
+    }else {
+        init(MIN_DEFAULT_PATH, 'hosts_zx_temporary')
+    }
+}
+
 module.exports = win

package/package.json

@@ -1,19 +1,19 @@
-{
-  "name": "visit-github",
-  "version": "0.0.2",
-  "description": "替换系统中的hosts文件",
-  "main": "index.js",
-  "bin": {
-    "zx-github": "bin/index.js"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "zxhou",
-  "license": "ISC",
-  "dependencies": {
-    "commander": "^9.3.0",
-    "iconv-lite": "^0.6.3"
-  }
-}
+{
+  "name": "visit-github",
+  "version": "0.0.3",
+  "description": "替换系统中的hosts文件",
+  "main": "bin/index.js",
+  "bin": {
+    "zx-github": "bin/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "zxhou",
+  "license": "ISC",
+  "dependencies": {
+    "commander": "^9.3.0",
+    "iconv-lite": "^0.6.3"
+  }
+}

package/util/commander.js

@@ -1,17 +1,17 @@
-module.exports = function () {
-    const { program } = require('commander'),
-        op = require('../package.json')
-
-    program
-        .version(op.version, '-v, --version', '输出当前版本')
-        .option('-r, --reset', '恢复原来的hosts文件')
-        .helpOption('-h, --help', '显示命令帮助')
-        .addHelpText('after', `
-示例:
-    $ zx-github             备份原来hosts文件，替换hosts
-    $ zx-github -r, --rest  恢复原来的hosts文件`
-    )
-    .parse(process.argv)
-
-    return program
+module.exports = function () {
+    const { program } = require('commander'),
+        op = require('../package.json')
+
+    program
+        .version(op.version, '-v, --version', '输出当前版本')
+        .option('-r, --reset', '恢复原来的hosts文件')
+        .helpOption('-h, --help', '显示命令帮助')
+        .addHelpText('after', `
+示例:
+    $ zx-github             备份原来hosts文件，替换hosts
+    $ zx-github -r, --rest  恢复原来的hosts文件`
+    )
+    .parse(process.argv)
+
+    return program
 }

package/util/darwin.js

@@ -1,29 +1,29 @@
-const { isExists, rename, runShellFlushDns, download, delFile } = require('./index')
-
-const init = async (path, n) => {
-    if(!isExists(path + 'hosts_zx_backups')) {
-        rename(
-            path, 
-            'hosts',
-            'hosts_zx_backups', 
-            '备份系统hosts文件时出错'
-        )
-    }
-    await download(path, n) && runShellFlushDns('sudo killall -HUP mDNSResponder')
-}
-
-const reset = (path, n) => {
-    const isOk = isExists(path + n)
-    if(isOk) {
-        if(isExists(path + 'hosts')) {
-            delFile(path + 'hosts')
-        }
-        rename(path, 'hosts_zx_backups', 'hosts', '还原系统hosts文件时出错')
-        console.log('还原系统hosts文件成功')
-        runShellFlushDns('sudo killall -HUP mDNSResponder')
-    }else {
-        console.log('没有找到备份文件，无法恢复')
-    }
-}
-
+const { isExists, rename, runShellFlushDns, download, delFile } = require('./index')
+
+const init = async (path, n) => {
+    if(!isExists(path + 'hosts_zx_backups')) {
+        rename(
+            path, 
+            'hosts',
+            'hosts_zx_backups', 
+            '备份系统hosts文件时出错'
+        )
+    }
+    await download(path, n) && runShellFlushDns('sudo killall -HUP mDNSResponder')
+}
+
+const reset = (path, n) => {
+    const isOk = isExists(path + n)
+    if(isOk) {
+        if(isExists(path + 'hosts')) {
+            delFile(path + 'hosts')
+        }
+        rename(path, 'hosts_zx_backups', 'hosts', '还原系统hosts文件时出错')
+        console.log('还原系统hosts文件成功')
+        runShellFlushDns('sudo killall -HUP mDNSResponder')
+    }else {
+        console.log('没有找到备份文件，无法恢复')
+    }
+}
+
 module.exports = { init, reset }

package/util/index.js

@@ -1,60 +1,57 @@
-const fs = require('fs'),
-    https = require('https'),
-    iconv = require('iconv-lite'),
-    process = require('child_process')
-
-const isExists = path => {
-    try {
-        const o = fs.statSync(path)
-        return o.isFile()
-    }catch(err) {
-        return false
-    }
-}
-
-const download = (path, n) => {
-    return new Promise((resolve, reject) => {
-        https.get('https://raw.hellogithub.com/hosts', res => {
-            let str = ''
-            res.on('data', chunk => (str += chunk))
-            res.on('end', () => {
-                fs.writeFile(path + n, str, err => {
-                    if(err){
-                        reject(false)
-                        console.log('写入临时文件出错')
-                        return
-                    } 
-                    rename(path, n, 'hosts', '替换下载hosts文件时出错')
-                    console.log('替换hosts文件成功')
-                    resolve(true)
-                })
-            })
-        }).on('error', (e) => {
-            console.error(`Got error: ${e.message}`)
-        })
-    })
-}
-
-const rename = (root, path, nPath, info) => {
-    const isOk = isExists(root + path)
-    if(isOk) {
-        try {
-            fs.renameSync(root + path, root + nPath)
-        }catch (err) {
-            console.log(info)
-        }
-    }else {
-        console.log(path + '文件不存在')
-    }
-}
-
-const delFile = path => fs.unlinkSync(path)
-
-const runShellFlushDns = shell => {
-    process.exec(shell, { encoding: 'binary' }, (err, stdout) => {
-        if(err) return
-        console.log(iconv.decode(Buffer.from(stdout, 'binary'), 'cp936'))
-    })
-}
-
+const fs = require('fs'),
+    https = require('https'),
+    iconv = require('iconv-lite'),
+    process = require('child_process')
+
+const isExists = path => {
+    try {
+        const o = fs.statSync(path)
+        return o.isFile()
+    }catch(err) {
+        return false
+    }
+}
+
+const download = (path, n) => {
+    return new Promise((resolve, reject) => {
+        https.get('https://raw.hellogithub.com/hosts', res => {
+            try {
+                res.pipe(fs.createWriteStream(path + n))
+                res.on('end', _ => {
+                    rename(path, n, 'hosts', '替换下载hosts文件时出错')
+                    console.log('替换hosts文件成功')
+                    resolve(true)
+                })
+            }catch {
+                reject(false)
+                console.log('写入临时文件出错')
+            }
+        }).on('error', (e) => {
+            console.error(`Got error: ${e.message}`)
+        })
+    })
+}
+
+const rename = (root, path, nPath, info) => {
+    const isOk = isExists(root + path)
+    if(isOk) {
+        try {
+            fs.renameSync(root + path, root + nPath)
+        }catch (err) {
+            console.log(info)
+        }
+    }else {
+        console.log(path + '文件不存在')
+    }
+}
+
+const delFile = path => fs.unlinkSync(path)
+
+const runShellFlushDns = shell => {
+    process.exec(shell, { encoding: 'binary' }, (err, stdout) => {
+        if(err) return
+        console.log(iconv.decode(Buffer.from(stdout, 'binary'), 'cp936'))
+    })
+}
+
 module.exports = { isExists, rename, runShellFlushDns, download, delFile }

package/util/win.js

@@ -1,30 +1,30 @@
-const { isExists, rename, runShellFlushDns, download, delFile } = require('./index')
-
-const init = async (path, n) => {
-    if(!isExists(path + 'hosts_zx_backups')) {
-        rename(
-            path, 
-            'hosts', 
-            'hosts_zx_backups', 
-            '备份系统hosts文件时出错'
-        )
-    }
-    await download(path, n) && runShellFlushDns('ipconfig /flushdns')
-}
-
-const reset = (path, n) => {
-    const isOk = isExists(path + n)
-    if(isOk) {
-        if(isExists(path + 'hosts')) {
-            delFile(path + 'hosts')
-        }
-        rename(path, 'hosts_zx_backups', 'hosts', '还原系统hosts文件时出错')
-        console.log('还原系统hosts文件成功')
-        runShellFlushDns('ipconfig /flushdns')
-    }else {
-        console.log('没有找到备份文件，无法恢复')
-    }
-}
-
-
+const { isExists, rename, runShellFlushDns, download, delFile } = require('./index')
+
+const init = async (path, n) => {
+    if(!isExists(path + 'hosts_zx_backups')) {
+        rename(
+            path, 
+            'hosts', 
+            'hosts_zx_backups', 
+            '备份系统hosts文件时出错'
+        )
+    }
+    await download(path, n) && runShellFlushDns('ipconfig /flushdns')
+}
+
+const reset = (path, n) => {
+    const isOk = isExists(path + n)
+    if(isOk) {
+        if(isExists(path + 'hosts')) {
+            delFile(path + 'hosts')
+        }
+        rename(path, 'hosts_zx_backups', 'hosts', '还原系统hosts文件时出错')
+        console.log('还原系统hosts文件成功')
+        runShellFlushDns('ipconfig /flushdns')
+    }else {
+        console.log('没有找到备份文件，无法恢复')
+    }
+}
+
+
 module.exports = { init, reset }