kup-cli 0.1.0-beta.2 → 0.1.0-beta.3

package/README.md

@@ -1,10 +1,10 @@
 # Kup
 
+<img src="https://user-images.githubusercontent.com/1231359/171321963-e8e73bdf-f9c8-435b-9707-318e92f1805a.png" width="150" height="80" align="right" alt="Kup logo">
+
 > A CLI tool to sync local Markdown files to GitHub issues.
 >
-> 这款命令行工具可以把本地 Markdown 文件同步到 GitHub issue。
-
-![Kup logo](https://user-images.githubusercontent.com/1231359/171189409-4469e2d4-9ff1-4b6b-8a73-d95d3434a5c6.png)
+> 这款命令行工具可以把本地的 Markdown 文件同步到 GitHub issue。
 
 ## 谁需要它
 
@@ -46,9 +46,7 @@ Kup 会把 `file.md` 文件的内容更新到 `foo/bar` 仓库的编号为 `123`
 
 操作 GitHub issue 是需要权限认证的，因此你需要向 Kup 提供 GitHub token，以便 Kup 调用 GitHub API。
 
-1. 进入 [此页面](https://github.com/settings/tokens) 申请 “Personal access tokens”，权限范围需要选中 “repo”。
-
-	> 友情提示：不要把 token 告诉其他人；不要把 token 写进代码。
+1. 在 GitHub 的 “[Personal access tokens](https://github.com/settings/tokens)” 页面生成一个新 token，权限范围需要选中 “repo”。（详细说明参见 [这篇文档](https://github.com/cssmagic/kup/issues/17)。）
 
 2. 把获取到的 token 写入环境变量：
 
@@ -95,7 +93,7 @@ Kup 会把 `file.md` 文件的内容更新到 `foo/bar` 仓库的编号为 `123`
 Kup 通过以下线索来确定 issue 的标题，优先级递减：
 
 1. Markdown 文件内的元数据的 `title` 字段。
-1. Markdown 正文的第一个标记如果是一级标题（`# Title` 格式），则取它的内容。
+1. Markdown 正文的第一个标记如果是一级标题（`# Title` 格式），则取它的内容（在这种情况下，这个一级标题在同步时会从内容中排除）。
 
 如果通过以上方式无法确定 issue 标题，Kup 会怎么处理？
 
@@ -118,6 +116,7 @@ Kup 通过以下线索来确定 issue 的标题，优先级递减：
 ## 文档
 
 * [Markdown 文件内的元数据示例](https://github.com/cssmagic/kup/issues/1)
+* [如何为 Kup 生成合适的 GitHub token](https://github.com/cssmagic/kup/issues/17)
 
 
 ## 其它
@@ -133,10 +132,14 @@ Kup 通过以下线索来确定 issue 的标题，优先级递减：
 
 ### 关于 Logo
 
-* 作者 [Fasil](https://freeicons.io/profile/722)，由 [freeicons.io](https://freeicons.io/free-icons-pack/pickup-truck-icon-26893) 免费提供。
+* 作者 [Fasil](https://freeicons.io/profile/722)，由 [freeicons.io](https://freeicons.io/icon/e-commerce-icons/pickup-truck-icon-26893) 免费提供。
 
 ***
 
 ## License
 
+> Any code contributed to this project is considered authorized for commercial use by the project authors and their affiliated companies and distributed under this project's license.
+>
+> 任何贡献到本项目的代码，均视为授权本项目作者及其名下公司用于商业用途、并按本项目协议分发。
+
 MIT

package/bin/cli.js

@@ -1,17 +1,16 @@
 #!/usr/bin/env node
-'use strict'
-
-const yargs = require('yargs')
-const { isDebugging } = require('../lib/util')
-const { main } = require('../lib/main')
-const { validate } = require('../lib/validate')
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { isDebugging } from '../lib/util.js'
+import { main } from '../lib/main.js'
+import { validate } from '../lib/validate.js'
 
 if (isDebugging()) {
 	console.log('[Kup] [Debug] Debug Mode is ON!')
 	console.log('')
 }
 
-const argv = yargs
+const argv = yargs(hideBin(process.argv))
 	.scriptName('kup')
 	.usage('Kup -- A CLI tool to sync local Markdown files to GitHub issues.')
 	.usage('Usage: $0 <file> [options]')

package/index.js

@@ -1,5 +1,3 @@
-'use strict'
-
-module.exports = function () {
+export default function () {
 	console.warn('Warning: This package is a CLI tool, you should install it globally! See README.md for more information.')
 }

package/lib/file.js

@@ -1,5 +1,4 @@
-'use strict'
-const fsPromises = require('fs').promises
+import fsPromises from 'fs/promises'
 
 function readTextFile(pathname) {
 	return fsPromises.readFile(pathname)
@@ -12,6 +11,11 @@ function readTextFile(pathname) {
 		})
 }
 
-module.exports = {
+function writeTextFile(pathname, content) {
+	fsPromises.writeFile(pathname, content)
+}
+
+export {
 	readTextFile,
+	writeTextFile,
 }

package/lib/main.js

@@ -1,11 +1,9 @@
-'use strict'
-
-const { isDebugging } = require('./util')
-const { readTextFile } = require('./file')
-const { parse } = require('./parse')
-const { getRepo } = require('./repo')
-const { updateIssue, postIssue } = require('./sync')
-const { getToken } = require('./token')
+import { isDebugging } from './util.js'
+import { readTextFile } from './file.js'
+import { parse } from './parse.js'
+import { getRepo } from './repo.js'
+import { updateIssue, postIssue } from './sync.js'
+import { getToken } from './token.js'
 
 async function main(argv) {
 	const {
@@ -36,7 +34,7 @@ async function main(argv) {
 	// 通过各种方式获取 repo
 	// 优先级： 命令行参数 > 文件元数据 > 文件所在项目的 package.json 中的 `kup.repo` 字段
 	let repoReal = repo || fileInfo.meta.repo
-	if (!repoReal) repoReal = await getRepo()
+	if (!repoReal) repoReal = await getRepo(file)
 	if (!repoReal) {
 		console.error('[Kup] [Error] Cannot get `repo` to sync to!')
 		process.exit(1)
@@ -54,6 +52,6 @@ async function main(argv) {
 	}
 }
 
-module.exports = {
+export {
 	main,
 }

package/lib/parse.js

@@ -1,7 +1,6 @@
-'use strict'
-const YAML = require('yaml')
+import YAML from 'yaml'
 
-const { isPlainObject } = require('./util')
+import { isPlainObject } from './util.js'
 
 // parse markdown file:
 // - extract metadata in yaml format
@@ -116,6 +115,6 @@ function _getTitleFromMainBody(firstLine) {
 	return title
 }
 
-module.exports = {
+export {
 	parse,
 }

package/lib/repo.js

@@ -1,16 +1,16 @@
-'use strict'
+import findUp from 'find-up'
+import path from 'path'
 
-const findUp = require('find-up')
-const { readTextFile } = require('./file')
-const { validateRepo } = require('./validate')
+import { readTextFile } from './file.js'
+import { validateRepo } from './validate.js'
 
-async function getRepo() {
+async function getRepo(sourceFile = '') {
 	// 目前只实现这一种方式
-	return await _getRepoFromPkgKup()
+	return await _getRepoFromPkgKup(sourceFile)
 }
 
-async function _getRepoFromPkgKup() {
-	const json = await _getPkg()
+async function _getRepoFromPkgKup(sourceFile = '') {
+	const json = await _getPkg(sourceFile)
 	const repo = json?.kup?.repo
 	const result = validateRepo(repo)
 	return result.status ? repo : ''
@@ -22,8 +22,9 @@ async function _getRepoFromGit() {
 	// TODO
 }
 
-async function _getPkg() {
-	const file = await findUp('package.json')
+async function _getPkg(sourceFile = '') {
+	const cwd = sourceFile ? path.resolve(path.dirname(sourceFile)) : process.cwd()
+	const file = await findUp('package.json', { cwd })
 
 	let pkg = ''
 	try {
@@ -43,7 +44,7 @@ async function _getPkg() {
 	return json
 }
 
-module.exports = {
+export {
 	getRepo,
 	// __getRepoFromPkgKup: _getRepoFromPkgKup,
 	// __getRepoFromPkgRepo: _getRepoFromPkgRepo,

package/lib/sync.js

@@ -1,12 +1,11 @@
-'use strict'
+import ghGot from 'gh-got'
+import inquirer from 'inquirer'
 
-const ghGot = require('gh-got')
-const inquirer = require('inquirer')
-const { isDebugging } = require('../lib/util')
+import { isDebugging } from '../lib/util.js'
 
 let proxyOptionsForGot = {}
 if (isDebugging()) {
-	const HttpsProxyAgent = require('https-proxy-agent')
+	const { HttpsProxyAgent } = await import('https-proxy-agent')
 	const CHARLES_PROXY = 'http://127.0.0.1:8888'
 	const agent = new HttpsProxyAgent(CHARLES_PROXY)
 	proxyOptionsForGot = {
@@ -35,7 +34,7 @@ async function updateIssue(fileInfo, repo, id) {
 	const api = `/repos/${ repo }/issues/${ id }`
 	const method = 'PATCH'
 	let response = null
-	console.log(`[Kup] Updating to "${ repo }#${ id }"...`)
+	console.log(`[Kup] Updating "${ repo }#${ id }"...`)
 	try {
 		response = await ghGot(api, {
 			method,
@@ -50,7 +49,9 @@ async function updateIssue(fileInfo, repo, id) {
 
 	// handle response
 	if (response) {
+		const url = `https://github.com/${ repo }/issues/${ id }`
 		console.log(`[Kup] [Success] Updated to "${ repo }#${ id }"!`)
+		console.log(`[Kup] [Success] URL: ${ url }`)
 	}
 }
 
@@ -99,14 +100,16 @@ async function postIssue(fileInfo, repo) {
 	// handle response
 	if (response) {
 		const id = response?.body?.number
+		const url = `https://github.com/${ repo }/issues/${ id }`
 		console.log(`[Kup] [Success] Posted to "${ repo }#${ id }"!`)
+		console.log(`[Kup] [Success] URL: ${ url }`)
 
 		// write back meta data
 		// TODO
 	}
 }
 
-module.exports = {
+export {
 	updateIssue,
 	postIssue,
 }

package/lib/token.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const inquirer = require('inquirer')
+import inquirer from 'inquirer'
 
 async function getToken() {
 	let token = process.env.GITHUB_TOKEN
@@ -43,6 +41,6 @@ function _validateToken(token) {
 }
 
 
-module.exports = {
+export {
 	getToken,
 }

package/lib/util.js

@@ -1,5 +1,3 @@
-'use strict'
-
 // 考虑到输入源的类型有限，这里只是做了一个简化的实现
 function isPlainObject(obj) {
 	if (!obj) return false
@@ -15,7 +13,7 @@ function isDebugging() {
 	return !!Number(process.env.KUP_DEBUG_MODE)
 }
 
-module.exports = {
+export {
 	isPlainObject,
 	isDebugging,
 }

package/lib/validate.js

@@ -1,5 +1,3 @@
-'use strict'
-
 function validate(argv) {
 	const {
 		id,
@@ -63,7 +61,7 @@ function validateFiles(files) {
 	}
 }
 
-module.exports = {
+export {
 	validate,
 	validateId,
 	validateRepo,

package/package.json

@@ -1,16 +1,20 @@
 {
 	"name": "kup-cli",
-	"version": "0.1.0-beta.2",
+	"version": "0.1.0-beta.3",
 	"description": "A CLI tool to sync local Markdown files to GitHub issues.",
+	"type": "module",
 	"bin": {
-		"kup": "./bin/cli.js"
+		"kup": "bin/cli.js"
 	},
 	"scripts": {
 		"debug": "export KUP_DEBUG_MODE=1",
 		"postpublish": "npx npm-mirror-sync",
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
-	"repository": "cssmagic/kup",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/cssmagic/kup.git"
+	},
 	"keywords": [
 		"cli",
 		"markdown",
@@ -20,7 +24,7 @@
 	"author": "cssmagic <cssmagic.cn@gmail.com>",
 	"license": "MIT",
 	"engines": {
-		"node": ">=12"
+		"node": ">=18"
 	},
 	"dependencies": {
 		"find-up": "^5.0.0",