feat: change file name from .git_consistent to .git_consistent.yaml

isuke · isuke · commit 820e9b02a792 · 2026-01-29T00:04:12.000+09:00
`.git_consistent` file has been replaced by `.git_consistent.yaml`, while the legacy extension-less file remains fully supported.
diff --git a/.git_consistent.yaml b/.git_consistent.yaml
diff --git a/AGENTS.md b/AGENTS.md
@@ -23,14 +23,14 @@ It is intended to be read by both human contributors and AI assistants.
 - Main tech stack:
   - Node.js ESM (`"type": "module"`)
   - CLI: `commander`, `inquirer`, `prompt-sync`
-  - Configuration: `.git_consistent` (YAML) and `.gitcommit_template`
+  - Configuration: `.git_consistent.yaml` (YAML) and `.gitcommit_template`
   - Tests: `ava`
   - Lint / formatting: `eslint` + `prettier`
 
 **Key files / directories**
 
 - `lib/` – CLI implementation
-- `.git_consistent` – sample configuration for user projects
+- `.git_consistent.yaml` – sample configuration for user projects
 - `.gitcommit_template` – commit template
 - `test/` – AVA tests
 - `.github/workflows/main.yml` – CI (lint + test)
@@ -63,7 +63,7 @@ It is intended to be read by both human contributors and AI assistants.
 
 ---
 
-## 5. `.git_consistent` and `.gitcommit_template`
+## 5. `.git_consistent.yaml` and `.gitcommit_template`
 
 - These files directly affect users’ commit workflows, so **prioritize compatibility and clarity**.
 - When changing samples:
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Supported Node.js versions:
 ## Features
 
 - **Interactive & Inline Modes**: Create commits interactively or directly from the command line.
-- **Customizable Commit Format**: Define your own commit message structure with a simple YAML configuration file (`.git_consistent`).
+- **Customizable Commit Format**: Define your own commit message structure with a simple YAML configuration file (`.git_consistent.yaml`).
 - **Validation Rules**: Enforce standards like case rules for the subject, character limits, and more.
 - **Dynamic Variables**: Automatically insert values like issue numbers into your commit messages.
 - **Branch Name Parsing**: Extract information (e.g., issue IDs) directly from your git branch name.
@@ -69,7 +69,7 @@ git consistent --init
 ```
 
 This will ask you a few questions and generate two files:
-- `.git_consistent`: Your configuration file.
+- `.git_consistent.yaml`: Your configuration file.
 - `.gitcommit_template`: The template for your commit messages.
 
 Feel free to edit these files to match your project's conventions.
@@ -107,9 +107,9 @@ Provide all the information using command-line flags.
 git consistent --type="feat" --subject="implement new feature" --body="This is an amazing feature."
 ```
 
-## Configuration (`.git_consistent`)
+## Configuration (`.git_consistent.yaml`)
 
-The `.git_consistent` file allows you to define and customize the structure of your commit messages. It uses a simple YAML-like format.
+The `.git_consistent.yaml` file allows you to define and customize the structure of your commit messages. It uses a simple YAML-like format.
 
 Here is the basic structure:
 
@@ -192,7 +192,7 @@ Create a `githubIssueUrl` variable based on a `githubIssueNum` input.
 <body>
 ```
 
-**`.git_consistent`:**
+**`.git_consistent.yaml`:**
 ```yml
 githubIssueNum:
   type: string
@@ -242,7 +242,7 @@ Automatically generate an issue link from a branch name like `issue/123-feature-
 <body>
 ```
 
-**`.git_consistent`:**
+**`.git_consistent.yaml`:**
 ```yml
 issueLink:
   type: branch
diff --git a/lib/index.js b/lib/index.js
@@ -15,7 +15,15 @@ import genConfig from './gen-config.js'
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 const templateFileName = '.gitcommit_template'
-const definitionsFileName = '.git_consistent'
+const definitionsFileName = '.git_consistent.yaml'
+const definitionsFileNameCandidates = [
+  '.git_consistent.yaml',
+  '.git_consistent.yml',
+  '.git_consistent',
+  'git_consistent.yaml',
+  'git_consistent.yml',
+  'git_consistent',
+]
 
 const program = new Command()
 
@@ -33,10 +41,18 @@ const getGitProjectRootPath = () => {
   }
 }
 
-const getFilePath = (filePaths, fileName) => {
-  const filePath = filePaths.find((filePath) => fs.existsSync(path.join(filePath, fileName)))
+const getFilePath = (filePaths, fileNames) => {
+  const candidates = Array.isArray(fileNames) ? fileNames : [fileNames]
 
-  return filePath ? path.join(filePath, fileName) : undefined
+  for (const basePath of filePaths) {
+    if (!basePath) continue
+    for (const name of candidates) {
+      const fullPath = path.join(basePath, name)
+      if (fs.existsSync(fullPath)) return fullPath
+    }
+  }
+
+  return undefined
 }
 
 const loadYaml = (path) => {
@@ -88,7 +104,7 @@ const runHelp = (program, definitionsFilePath) => {
 //
 const rootPath = getGitProjectRootPath() || '.'
 const templateFilePath = getFilePath([rootPath, process.env.HOME], templateFileName)
-const definitionsFilePath = getFilePath([rootPath, process.env.HOME], definitionsFileName)
+const definitionsFilePath = getFilePath([rootPath, process.env.HOME], definitionsFileNameCandidates)
 
 program
   .option('-d, --duet', 'run git-duet mode')
