kup-cli 0.1.1 → 0.1.3

package/README.md

@@ -75,9 +75,11 @@ Kup 会把 `file.md` 文件的内容更新到 `foo/bar` 仓库的编号为 `123`
 
 1. 调用命令行时指定的 `--repo` 参数。
 1. Markdown 文件内的 [元数据](https://github.com/cssmagic/kup/issues/1) 的 `repo` 字段。
-1. 当前项目的 `package.json` 文件内的 `kup.repo` 字段。Kup 会从当前目录向上逐级寻找 `package.json` 文件。
+1. 当前项目的 `package.json` 文件内的 `kup.repo` 字段。Kup 会以 Markdown 文件所在目录为起点逐级向上寻找 `package.json` 文件。
+1. 如果 `package.json` 文件内没有 `kup.repo` 字段，则 Kup 会尝试根据 `repository` 字段来猜测仓库名（在使用前会向用户确认）。
+1. 如果以上方式都没有成功，则 Kup 会继续查找同级或上级目录中的 `.git/config` 文件，并尝试根据其中 `remote "origin"` 的 `url` 字段来猜测仓库名（在使用前会向用户确认）。
 
-如果整个项目的同步目标都是同一个仓库，则可以采用最后一种方式统一指定 `repo` 参数。
+如果整个项目的同步目标都是同一个仓库，则建议采用 `kup.repo` 字段统一指定 `repo` 参数。
 
 ### 如何更方便地指定 `id` 参数？
 

package/lib/main.js

@@ -1,3 +1,5 @@
+import inquirer from 'inquirer'
+
 import { isDebugging } from './util.js'
 import { KupError, errorLine } from './error.js'
 import { readTextFile } from './file.js'
@@ -34,7 +36,11 @@ async function main(argv) {
 	}
 
 	// 通过各种方式获取 repo
-	// 优先级： 命令行参数 > 文件元数据 > 文件所在项目的 package.json 中的 `kup.repo` 字段
+	// 优先级：
+	//   P1 命令行参数
+	//   P2 文件元数据
+	//   P3 package.json 中的 `kup.repo` 字段
+	//   P4 package.json 中的 `repository` 字段（需确认）
 	let repoReal = ''
 	let repoSource = ''
 	if (repo) {
@@ -44,8 +50,24 @@ async function main(argv) {
 		repoReal = fileInfo.meta.repo
 		repoSource = 'meta'
 	} else {
-		repoReal = await getRepo(file)
-		if (repoReal) repoSource = 'package'
+		const repoResult = await getRepo(file)
+		if (repoResult.needsConfirm) {
+			const answer = await inquirer.prompt([
+				{
+					name: 'useGuessedRepo',
+					type: 'confirm',
+					message: `Kup guessed the GitHub repo "${ repoResult.repo }" from ${ getRepoSourceLabel(repoResult.source) }, use it?`,
+					default: true,
+				},
+			])
+			if (answer.useGuessedRepo) {
+				repoReal = repoResult.repo
+				repoSource = repoResult.source
+			}
+		} else if (repoResult.repo) {
+			repoReal = repoResult.repo
+			repoSource = repoResult.source
+		}
 	}
 	if (!repoReal) {
 		throw new KupError([
@@ -69,6 +91,17 @@ async function main(argv) {
 	}
 }
 
+function getRepoSourceLabel(source = '') {
+	switch (source) {
+		case 'package.repository':
+			return 'package.json#repository'
+		case 'git.origin':
+			return '.git/config remote "origin"'
+		default:
+			return 'an inferred source'
+	}
+}
+
 export {
 	main,
 }

package/lib/repo.js

@@ -1,3 +1,4 @@
+import fs from 'fs/promises'
 import { findUp } from 'find-up'
 import path from 'path'
 
@@ -5,21 +6,73 @@ import { readTextFile } from './file.js'
 import { validateRepo } from './validate.js'
 
 async function getRepo(sourceFile = '') {
-	// 目前只实现这一种方式
-	return await _getRepoFromPkgKup(sourceFile)
+	const json = await _getPkg(sourceFile)
+
+	if (json) {
+		const packageRepo = _getRepoFromPkgKup(json)
+		if (packageRepo.repo) {
+			return {
+				repo: packageRepo.repo,
+				source: 'package',
+				needsConfirm: false,
+			}
+		}
+
+		if (!packageRepo.hasKupRepoField) {
+			const guessedRepo = _getRepoFromPkgRepo(json)
+			if (guessedRepo) {
+				return {
+					repo: guessedRepo,
+					source: 'package.repository',
+					needsConfirm: true,
+				}
+			}
+		}
+	}
+
+	const guessedRepo = await _getRepoFromGit(sourceFile)
+	return {
+		repo: guessedRepo,
+		source: guessedRepo ? 'git.origin' : '',
+		needsConfirm: !!guessedRepo,
+	}
 }
 
-async function _getRepoFromPkgKup(sourceFile = '') {
-	const json = await _getPkg(sourceFile)
+function _getRepoFromPkgKup(json) {
+	const hasKupRepoField = !!json?.kup && Object.prototype.hasOwnProperty.call(json.kup, 'repo')
 	const repo = json?.kup?.repo
 	const result = validateRepo(repo)
-	return result.status ? repo : ''
+	return {
+		repo: result.status ? repo : '',
+		hasKupRepoField,
+	}
 }
-async function _getRepoFromPkgRepo() {
-	// TODO
+function _getRepoFromPkgRepo(json) {
+	const repository = json?.repository
+	if (!repository) return ''
+
+	if (typeof repository === 'string') {
+		return normalizeRepositoryToRepo(repository)
+	}
+
+	if (typeof repository === 'object' && repository.url) {
+		return normalizeRepositoryToRepo(repository.url)
+	}
+
+	return ''
 }
-async function _getRepoFromGit() {
-	// TODO
+async function _getRepoFromGit(sourceFile = '') {
+	const configFile = await _getGitConfigFile(sourceFile)
+	if (!configFile) return ''
+
+	let config = ''
+	try {
+		config = await readTextFile(configFile)
+	} catch {
+		return ''
+	}
+
+	return _getRepoFromGitConfig(config)
 }
 
 async function _getPkg(sourceFile = '') {
@@ -45,9 +98,89 @@ async function _getPkg(sourceFile = '') {
 	return json
 }
 
+async function _getGitConfigFile(sourceFile = '') {
+	let cwd = sourceFile ? path.resolve(path.dirname(sourceFile)) : process.cwd()
+	while (true) {
+		const gitPath = path.join(cwd, '.git')
+
+		try {
+			const stats = await fs.stat(gitPath)
+			if (stats.isDirectory()) {
+				const configFile = path.join(gitPath, 'config')
+				try {
+					await fs.access(configFile)
+					return configFile
+				} catch {
+					return ''
+				}
+			}
+			return ''
+		} catch {
+			const parent = path.dirname(cwd)
+			if (parent === cwd) return ''
+			cwd = parent
+		}
+	}
+}
+
+function _getRepoFromGitConfig(config) {
+	if (typeof config !== 'string' || !config.trim()) return ''
+
+	const lines = config.split(/\r?\n/)
+	let inOriginRemote = false
+	for (const line of lines) {
+		const trimmed = line.trim()
+		if (!trimmed || trimmed.startsWith('#') || trimmed.startsWith(';')) continue
+
+		const sectionMatched = /^\[\s*(.*?)\s*\]$/.exec(trimmed)
+		if (sectionMatched) {
+			inOriginRemote = /^remote\s+"origin"$/i.test(sectionMatched[1])
+			continue
+		}
+		if (!inOriginRemote) continue
+
+		const entryMatched = /^([A-Za-z][\w-]*)\s*=\s*(.*?)\s*$/.exec(trimmed)
+		if (!entryMatched) continue
+
+		const key = entryMatched[1].toLowerCase()
+		const value = entryMatched[2]
+		if (key === 'url') return normalizeRepositoryToRepo(value)
+	}
+
+	return ''
+}
+
+function normalizeRepositoryToRepo(repository) {
+	if (typeof repository !== 'string') return ''
+
+	const value = repository.trim()
+	if (!value) return ''
+
+	const candidates = [
+		/^github:([\w.-]+\/[\w.-]+)$/i,
+		/^(?:git\+)?https?:\/\/github\.com\/([\w.-]+\/[\w.-]+?)(?:\.git)?(?:\/)?$/i,
+		/^git@github\.com:([\w.-]+\/[\w.-]+?)(?:\.git)?$/i,
+		/^ssh:\/\/git@github\.com\/([\w.-]+\/[\w.-]+?)(?:\.git)?(?:\/)?$/i,
+		/^([\w.-]+\/[\w.-]+)$/,
+	]
+
+	for (const pattern of candidates) {
+		const matched = pattern.exec(value)
+		if (!matched) continue
+
+		const repo = matched[1]
+		const result = validateRepo(repo)
+		if (result.status) return repo
+	}
+
+	return ''
+}
+
 export {
 	getRepo,
-	// __getRepoFromPkgKup: _getRepoFromPkgKup,
-	// __getRepoFromPkgRepo: _getRepoFromPkgRepo,
-	// __getRepoFromGit: _getRepoFromGit,
+	_getRepoFromPkgKup as __getRepoFromPkgKup,
+	_getRepoFromPkgRepo as __getRepoFromPkgRepo,
+	_getRepoFromGit as __getRepoFromGit,
+	_getRepoFromGitConfig as __getRepoFromGitConfig,
+	normalizeRepositoryToRepo as __normalizeRepositoryToRepo,
 }

package/lib/validate.js

@@ -36,7 +36,7 @@ function validateId(id) {
 	}
 }
 function validateRepo(repo) {
-	const REPO_PATTERN = /^[\w\-]+\/[\w\-]+$/
+	const REPO_PATTERN = /^[\w.-]+\/[\w.-]+$/
 	let errorMsg = ''
 	if (!repo) {
 		errorMsg = '`repo` must be a string!'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "kup-cli",
-	"version": "0.1.1",
+	"version": "0.1.3",
 	"description": "A CLI tool to sync local Markdown files to GitHub issues.",
 	"type": "module",
 	"bin": {