kk-git 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e2ef1f50e051f8167139fae0478f01da4a0cae6ea6401a73cdf67765ad13936
-  data.tar.gz: 71d53513506ebff53f091a7d10c9ab41e0e6b3b60e393d783061aa2f19072288
+  metadata.gz: bf8344aceea8482a3025d31bbcc1293cd6a4fd6aaa3235c3907cf173538e83e5
+  data.tar.gz: 553a278a015110d0205d9da2e2df75d83429b169428c23fb1d75ca40a139c140
 SHA512:
-  metadata.gz: c25c845bb90eae62b73feff52b0a0043e20004b20bec670460fa90ba6bb09e53fa468986c960305787a311622b30947eda805c1dc9395e7294a3bca663d877b5
-  data.tar.gz: 0534a91d78bef3ddbd34f85cdc5f7e9392a68d771a2c940a1d435151fe28910b925164c8277e08e2addfa5faf085af0fe27a0375e4900a1ea2f5468e8dd4f966
+  metadata.gz: f9a2764f0d336ef4ce214133e63d9b8cad0c68d481d95b88ff0f00feca8d358199a1687c37e95bc563eea8758f85c46ee90f9826621cfe5db168cd75087a46e3
+  data.tar.gz: 58e748e4640395c28e9e27c805e36d3b5ed1fc997e55fcfc9c0d4649fdbe593aaf3c22e39d3d25f82acca5408e71516211118691690a288b6181bc8f01a758c6

data/exe/kk-git

@@ -25,45 +25,51 @@ parser = OptionParser.new do |opts|
   opts.banner = "Usage:\n" \
                 "  kk-git --version\n" \
                 "  kk-git commit-message [options]\n\n" \
-                "根据当前 Git repo 变更生成 Conventional Commit 信息。"
+                "Generate Conventional Commits messages from git changes."
 
-  opts.on('--repo DIR', '指定 repo 目录（默认当前目录）') { |v| options[:repo_dir] = v }
+  opts.on('--repo DIR', 'Git repo directory (default: current dir)') { |v| options[:repo_dir] = v }
 
-  opts.on('--staged', '仅基于暂存区变更（默认）') { options[:mode] = :staged }
-  opts.on('--worktree', '仅基于工作区变更（含 untracked）') { options[:mode] = :worktree }
-  opts.on('--all', '合并暂存区与工作区变更') { options[:mode] = :all }
+  opts.on('--staged', 'Use staged changes only (default)') { options[:mode] = :staged }
+  opts.on('--worktree', 'Use working-tree changes only (includes untracked)') { options[:mode] = :worktree }
+  opts.on('--all', 'Combine staged + working-tree changes') { options[:mode] = :all }
 
-  opts.on('--[no-]body', '多文件时输出/不输出 body（默认输出）') { |v| options[:include_body] = v }
+  opts.on('--[no-]body', 'Include body for multi-file changes (default: yes)') { |v| options[:include_body] = v }
 
-  opts.on('--type TYPE', '覆盖自动推断的 type（如 feat/fix/docs）') { |v| options[:type] = v }
-  opts.on('--scope SCOPE', '覆盖自动推断的 scope') { |v| options[:scope] = v }
-  opts.on('--subject SUBJECT', '覆盖自动推断的 subject') { |v| options[:subject] = v }
-  opts.on('--[no-]detect-breaking', '是否检测 BREAKING 标记（默认检测）') { |v| options[:detect_breaking] = v }
+  opts.on('--type TYPE', 'Override inferred type (feat/fix/docs/...)') { |v| options[:type] = v }
+  opts.on('--scope SCOPE', 'Override inferred scope') { |v| options[:scope] = v }
+  opts.on('--subject SUBJECT', 'Override inferred subject') { |v| options[:subject] = v }
+  opts.on('--[no-]detect-breaking', 'Detect BREAKING markers (default: yes)') { |v| options[:detect_breaking] = v }
 
-  opts.on('--format FORMAT', '输出格式：text/json（默认 text）') do |v|
+  opts.on('--format FORMAT', 'Output format: text/json (default: text)') do |v|
     options[:format] = v.to_s.downcase.to_sym
   end
 
-  opts.on('-h', '--help', '显示帮助') do
+  opts.on('-h', '--help', 'Show help') do
     puts opts
     exit 0
   end
 
-  opts.on('-v', '--version', '显示版本号') do
+  opts.on('-v', '--version', 'Show version') do
     puts KKGit::VERSION
     exit 0
   end
 end
 
-# 支持 `kk-git --version` 这种无子命令形式
+# Support `kk-git --version` without subcommand
 if ['--version', '-v'].include?(ARGV[0])
   puts KKGit::VERSION
   exit 0
 end
 
+# Support `kk-git --help` without subcommand
+if ['--help', '-h'].include?(ARGV[0])
+  puts parser
+  exit 0
+end
+
 subcommand = ARGV.shift
 if subcommand != 'commit-message'
-  warn "未知命令: #{subcommand}\n\n#{parser}"
+  warn "Unknown command: #{subcommand}\n\n#{parser}"
   exit 2
 end
 
@@ -72,8 +78,8 @@ parser.parse!(ARGV)
 def to_utf8(str)
   return nil if str.nil?
   s = str.to_s.dup
-  # ARGV 在不同 locale 下可能被标记为 ASCII-8BIT/US-ASCII，但字节本身通常是 UTF-8。
-  # 这里优先按 UTF-8 解释字节，并对非法序列做 scrub。
+  # In some locales ARGV may be tagged as ASCII-8BIT/US-ASCII, but bytes are usually UTF-8.
+  # Prefer interpreting bytes as UTF-8 and scrub invalid sequences.
   s.force_encoding(Encoding::UTF_8)
   s.scrub('�')
 end

data/lib/kk/git/commit_message.rb

@@ -4,13 +4,13 @@ require 'json'
 require 'open3'
 
 module KKGit
-  # 根据当前 repo 的变更生成 Conventional Commits 信息。
+  # Generate Conventional Commits messages from git changes.
   #
-  # - 支持暂存区（staged）和工作区（working tree）变更
-  # - 支持识别 untracked 文件
-  # - 输出格式："<type>(<scope>): <subject>\n\n<body>"
+  # - Supports staged and working-tree changes
+  # - Supports untracked files
+  # - Output format: "<type>(<scope>): <subject>\n\n<body>"
   class CommitMessage
-    # 变更条目（支持 rename/copy 的 old/new）
+    # Change entry (supports rename/copy old/new paths)
     Change = Struct.new(:status, :path, :old_path, :source, keyword_init: true)
 
     TYPE_PRIORITY = {
@@ -25,19 +25,19 @@ module KKGit
       'chore' => 9
     }.freeze
 
-    # 生成 commit message。
+    # Generate a commit message.
     #
-    # @param repo_dir [String] Git 仓库目录（默认当前目录）
-    # @param mode [Symbol] :staged（仅暂存区）/:worktree（仅工作区）/:all（两者合并）
-    # @param include_body [Boolean] 多文件时是否输出 body（文件列表）
-    # @param fallback_scope [String] 无法推断 scope 时的默认值
-    # @param type_override [String, nil] 强制指定 type（如 feat/fix/docs）
-    # @param scope_override [String, nil] 强制指定 scope
-    # @param subject_override [String, nil] 强制指定 subject
-    # @param detect_breaking [Boolean] 是否从 diff 中检测 BREAKING 标记并生成 "type(scope)!:"（默认 true）
-    # @param max_diff_bytes [Integer] diff 检测的最大字节数（防止超大仓库导致变慢）
+    # @param repo_dir [String] git repo directory (default: current dir)
+    # @param mode [Symbol] :staged / :worktree / :all
+    # @param include_body [Boolean] include body for multi-file changes
+    # @param fallback_scope [String] scope used when inference can't decide
+    # @param type_override [String, nil] force type (feat/fix/docs/...)
+    # @param scope_override [String, nil] force scope
+    # @param subject_override [String, nil] force subject
+    # @param detect_breaking [Boolean] detect "BREAKING" markers and emit "type(scope)!:" (default: true)
+    # @param max_diff_bytes [Integer] cap diff size for breaking detection
     #
-    # @return [String, nil] 无变更时返回 nil
+    # @return [String, nil] returns nil when there are no changes
     def self.generate(
       repo_dir: '.',
       mode: :staged,
@@ -69,7 +69,7 @@ module KKGit
       message
     end
 
-    # 生成结构化信息（便于脚本/CI 消费）。
+    # Generate structured data (useful for scripts/CI).
     #
     # @return [Hash]
     def self.generate_hash(
@@ -169,7 +169,7 @@ module KKGit
     end
 
     def self.normalize_and_dedup(changes)
-      # key 维度：new_path；同一路径可能在 staged + worktree 都出现
+      # Keyed by new_path; same path can show up in staged + worktree.
       dedup = {}
       changes.each do |c|
         next if c.path.nil? || c.path.strip.empty?
@@ -181,10 +181,10 @@ module KKGit
           next
         end
 
-        # 优先级：
-        # - staged 覆盖 worktree（更贴近即将提交的内容）
-        # - rename/copy 优先于普通修改
-        # - A(新增) 优先于 M
+        # Priority:
+        # - staged wins over worktree (closer to what will be committed)
+        # - rename/copy wins over plain modifications
+        # - A(add) wins over M(modify)
         priority = change_priority(c)
         existing_priority = change_priority(existing)
         dedup[key] = c if priority < existing_priority
@@ -212,16 +212,16 @@ module KKGit
 
     def self.run_git(args, repo_dir:)
       stdout, stderr, status = Open3.capture3('git', *args, chdir: repo_dir)
-      # Open3 返回的 stdout/stderr 可能是 ASCII-8BIT（BINARY），统一转为 UTF-8 避免拼接时报编码错误。
+      # Open3 stdout/stderr may be ASCII-8BIT (BINARY). Normalize to UTF-8 to avoid concat errors.
       stdout = stdout.to_s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: '�')
       stderr = stderr.to_s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: '�')
 
-      raise "git #{args.join(' ')} 失败: #{stderr.strip}" unless status.success?
+      raise "git #{args.join(' ')} failed: #{stderr.strip}" unless status.success?
 
       stdout
     end
 
-    # 推断 type/scope/subject（含 breaking 检测）
+    # Infer type/scope/subject (with optional breaking detection)
     #
     # @return [Hash] {:type,:scope,:subject,:breaking}
     def self.infer(changes:, repo_dir:, mode:, detect_breaking:, max_diff_bytes:, fallback_scope:)
@@ -243,14 +243,14 @@ module KKGit
       return fallback_scope if uniq.empty?
       return uniq.first if uniq.length == 1
 
-      # 多 scope 的时候，尽量选 repo；否则 fallback
+      # When multiple scopes exist, prefer "repo"; otherwise fallback.
       return 'repo' if uniq.include?('repo')
 
       fallback_scope
     end
 
     def self.infer_scope(paths, fallback_scope:)
-      # 工具/脚本类变更：尽量统一 scope 为 tools
+      # Tooling/script/build changes: prefer a stable scope
       if paths.any? && paths.all? { |p| tooling_path?(p) || doc_path?(p) || ci_path?(p) }
         return 'tools'
       end
@@ -261,7 +261,7 @@ module KKGit
       return uniq.first if uniq.length == 1
       return 'repo' if uniq.include?('repo')
 
-      # 多个顶层目录：统一落到 repo（避免 scope 过长/不稳定）
+      # Multiple top-level dirs: use repo to keep scope stable/short.
       'repo'
     end
 
@@ -277,7 +277,7 @@ module KKGit
     def self.infer_type(changes)
       paths = changes.map(&:path)
 
-      # 快速类别判断
+      # Fast paths
       only_docs = paths.all? { |p| doc_path?(p) }
       return 'docs' if only_docs
 
@@ -290,12 +290,12 @@ module KKGit
       only_deps = paths.all? { |p| deps_path?(p) }
       return 'chore' if only_deps
 
-      # 工具/脚本/构建相关：倾向 chore（即便新增代码文件）
+      # Tooling/script/build related: prefer chore (even if code is added)
       if paths.any? && paths.all? { |p| tooling_path?(p) || doc_path?(p) || ci_path?(p) || deps_path?(p) }
         return 'chore'
       end
 
-      # 代码变更的启发式：新增更偏 feat；否则若命中 fix 关键词则 fix；否则 refactor/chore
+      # Heuristics for code changes
       has_code = paths.any? { |p| code_path?(p) }
       has_new_code = changes.any? { |c| c.status == 'A' && code_path?(c.path) }
       has_fix_keyword = paths.any? { |p| p.match?(/fix|bug|error|issue/i) }
@@ -305,7 +305,7 @@ module KKGit
       return 'fix' if has_code && has_fix_keyword
       return 'refactor' if has_code && has_delete
 
-      # 混合场景：按优先级聚合
+      # Mixed: aggregate by priority
       types = changes.map { |c| type_by_path(c.path) }
       pick_main_type(types)
     end
@@ -321,7 +321,7 @@ module KKGit
 
       return 'chore' unless code_path?(path)
 
-      # 默认：代码修改更接近 fix（更保守）；新增则在 infer_type 中处理为 feat
+      # Default: treat code changes as fix (conservative). Adds are handled as feat by infer_type.
       'fix'
     end
 
@@ -409,11 +409,11 @@ module KKGit
         c = changes.first
         action =
           case c.status
-          when 'A' then '新增'
-          when 'D' then '删除'
-          when 'R' then '重命名'
-          when 'C' then '复制'
-          else '更新'
+          when 'A' then 'Add'
+          when 'D' then 'Remove'
+          when 'R' then 'Rename'
+          when 'C' then 'Copy'
+          else 'Update'
           end
 
         if %w[R C].include?(c.status) && c.old_path
@@ -424,21 +424,21 @@ module KKGit
 
       label =
         case scope
-        when 'repo' then '项目'
-        when 'tools' then '工具'
+        when 'repo' then 'project'
+        when 'tools' then 'tools'
         else scope
         end
 
       case type
-      when 'feat' then "添加#{label}功能"
-      when 'fix' then "修复#{label}问题"
-      when 'docs' then "更新#{label}文档"
-      when 'refactor' then "重构#{label}代码"
-      when 'style' then "调整#{label}代码格式"
-      when 'perf' then "优化#{label}性能"
-      when 'test' then "更新#{label}测试"
-      when 'ci' then "更新#{label}CI配置"
-      else "维护#{label}"
+      when 'feat' then "Add #{label} features"
+      when 'fix' then "Fix #{label} issues"
+      when 'docs' then "Update #{label} docs"
+      when 'refactor' then "Refactor #{label}"
+      when 'style' then "Format #{label}"
+      when 'perf' then "Improve #{label} performance"
+      when 'test' then "Update #{label} tests"
+      when 'ci' then "Update #{label} CI"
+      else "Update #{label}"
       end
     end
 
@@ -458,12 +458,12 @@ module KKGit
       end
 
       lines = []
-      append_group(lines, '新增', groups['A'])
-      append_group(lines, '修改', groups['M'])
-      append_group(lines, '删除', groups['D'])
-      append_group(lines, '重命名', groups['R'])
-      append_group(lines, '复制', groups['C'])
-      append_group(lines, '其他', groups['?'])
+      append_group(lines, 'Added', groups['A'])
+      append_group(lines, 'Changed', groups['M'])
+      append_group(lines, 'Removed', groups['D'])
+      append_group(lines, 'Renamed', groups['R'])
+      append_group(lines, 'Copied', groups['C'])
+      append_group(lines, 'Other', groups['?'])
       lines.join("\n")
     end
 

data/lib/kk/git/rake_tasks.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'kk/git'
+require_relative '../git'
 require 'open3'
 require 'tempfile'
 
 module KKGit
-  # Rake 集成：在任意项目的 Rakefile 中 `require 'kk/git/rake_tasks'` 即可注册任务。
+  # Rake integration: `require 'kk/git/rake_tasks'` to register tasks.
   #
-  # 说明：
-  # - 这些任务**不会 exit/abort**，以便在其它 task 中被 invoke。
-  # - 会把生成结果写入 `ENV['KK_GIT_COMMIT_MESSAGE']`，方便上层 task 复用。
+  # Notes:
+  # - These tasks do NOT exit/abort so they can be invoked by other tasks.
+  # - The generated message is stored in `ENV['KK_GIT_COMMIT_MESSAGE']`.
   module RakeTasks
     def self.run_cmd(*cmd)
       stdout, stderr, status = Open3.capture3(*cmd)
@@ -20,7 +20,7 @@ module KKGit
     def self.ensure_ok!(ok, title, stdout: nil, stderr: nil)
       return if ok
 
-      msg = +"#{title} 失败"
+      msg = +"#{title} failed"
       msg << "\n#{stderr}" unless stderr.to_s.strip.empty?
       msg << "\n#{stdout}" unless stdout.to_s.strip.empty?
       raise msg
@@ -28,13 +28,13 @@ module KKGit
 
     def self.current_branch
       out, err, ok = run_cmd('git', 'rev-parse', '--abbrev-ref', 'HEAD')
-      ensure_ok!(ok, '获取当前分支', stdout: out, stderr: err)
+      ensure_ok!(ok, 'Get current branch', stdout: out, stderr: err)
       out.strip
     end
 
     def self.working_tree_clean?
       out, err, ok = run_cmd('git', 'status', '--porcelain')
-      ensure_ok!(ok, '检查 git 状态', stdout: out, stderr: err)
+      ensure_ok!(ok, 'Check git status', stdout: out, stderr: err)
       out.strip.empty?
     end
 
@@ -42,31 +42,31 @@ module KKGit
       extend Rake::DSL
 
       namespace :git do
-        desc '根据暂存区变更生成 commit message（Conventional Commits）'
+        desc 'Generate commit message from staged changes (Conventional Commits)'
         task :commit_message do
           msg = KKGit::CommitMessage.generate(mode: :staged)
           ENV['KK_GIT_COMMIT_MESSAGE'] = msg.to_s
           puts msg if msg
         end
 
-        desc '根据工作区变更生成 commit message（含 untracked）'
+        desc 'Generate commit message from working-tree changes (includes untracked)'
         task :commit_message_worktree do
           msg = KKGit::CommitMessage.generate(mode: :worktree)
           ENV['KK_GIT_COMMIT_MESSAGE'] = msg.to_s
           puts msg if msg
         end
 
-        desc '合并暂存区+工作区变更生成 commit message'
+        desc 'Generate commit message from staged + working-tree changes'
         task :auto_commit do
           msg = KKGit::CommitMessage.generate(mode: :all)
           ENV['KK_GIT_COMMIT_MESSAGE'] = msg.to_s
           puts msg if msg
         end
 
-        desc '自动 add/commit/pull/push（基于 git:auto_commit）'
+        desc 'Auto add/commit/pull/push (uses git:auto_commit)'
         task :auto_commit_push do
           if working_tree_clean?
-            puts '没有变更需要提交'
+            puts 'No changes to commit'
             next
           end
 
@@ -77,28 +77,28 @@ module KKGit
           out, err, ok = run_cmd('git', 'add', '.')
           ensure_ok!(ok, 'git add', stdout: out, stderr: err)
 
-          # 2) 生成 commit message（允许重复 invoke）
+          # 2) generate commit message (allow re-invoke)
           Rake::Task['git:auto_commit'].reenable
           Rake::Task['git:auto_commit'].invoke
           commit_message = ENV['KK_GIT_COMMIT_MESSAGE'].to_s.strip
-          commit_message = "chore(repo): 更新项目文件\n\n#{Time.now}" if commit_message.empty?
+          commit_message = "chore(repo): update project files\n\n#{Time.now}" if commit_message.empty?
 
-          # 3) commit（用临时文件避免转义问题）
+          # 3) commit (use a tempfile to avoid escaping issues)
           Tempfile.create('commit_message') do |f|
             f.write(commit_message)
             f.flush
             out, err, ok = run_cmd('git', 'commit', '-F', f.path)
-            # 没有 staged 变更时 git commit 会失败；这里给出更友好的提示
+            # If there are no staged changes, git commit fails; show a friendlier message.
             unless ok
               if err.include?('nothing to commit') || out.include?('nothing to commit')
-                puts '没有暂存变更需要提交'
+                puts 'No staged changes to commit'
                 next
               end
             end
             ensure_ok!(ok, 'git commit', stdout: out, stderr: err)
           end
 
-          # 4) pull（默认使用 --ff-only，避免非交互环境进入合并流程）
+          # 4) pull (default: --ff-only to avoid interactive merges)
           pull_args = ENV.fetch('KK_GIT_PULL_ARGS', '--ff-only').split
           out, err, ok = run_cmd('git', 'pull', *pull_args)
           ensure_ok!(ok, 'git pull', stdout: out, stderr: err)
@@ -107,7 +107,7 @@ module KKGit
           out, err, ok = run_cmd('git', 'push', remote, branch)
           ensure_ok!(ok, 'git push', stdout: out, stderr: err)
 
-          puts "✅ 已推送: #{remote} #{branch}"
+          puts "Pushed: #{remote} #{branch}"
         end
       end
     end

data/lib/kk/git/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module KKGit
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: kk-git
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - kk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-24 00:00:00.000000000 Z
+date: 2026-01-25 00:00:00.000000000 Z
 dependencies: []
-description: 根据当前 Git repo 的变更（暂存/工作区）自动生成 Conventional Commits 格式的 commit message，便于
-  Rake/脚本调用。
+description: Generate Conventional Commits commit messages from current git changes
+  (staged/worktree), designed for Rake/script usage.
 email:
 - ''
 executables:
@@ -47,5 +47,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Git 辅助工具：自动生成 Conventional Commit 信息
+summary: 'Git helper: generate Conventional Commits messages'
 test_files: []