conventional-changelog/commitlint

prompt-cli does not work with custom config file paths

Open

#340 opened on May 9, 2018

View on GitHub
 (5 comments) (1 reaction) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
featurehelp wanted

Description

Following #100, there is no way to run prompt-cli with a specific config file path. It just assumes the default which is commitlint.config.js under the repository's root.

Expected Behavior

Either:

  1. npm run commit --config </path/to/config.js>
  2. COMMITLINT_CONFIG=/path/to/config.js npm run commit
  3. { config: { '@commitlint/prompt-cli': { config: '/path/to/config.js' } } } in package.json

Current Behavior

prompt-cli runs with no customizations in place (no type/scope enums loaded etc.)

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Your Environment

Executable Version
commitlint --version 6.2.0
git --version 2.17.0
node --version 8.9.0

Contributor guide

Tech stack
typescriptnodejs
Domain
clitooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with commitlintNode.jsCLI development basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Review issue #100 for context on config file handling. Examine the prompt cli source code (likely in packages/prompt) to understand how the default config path is set. Implement one of the suggested approaches: accept a config flag, an environment variable COMMITLINT CONFIG, or a package.json config field. Ensure the solution integrates with the existing config resolution logic.