conventional-changelog/commitlint

CommitLint with Yarn v2 (Plug'n'play)

Open

#2637 opened on Jun 7, 2021

View on GitHub
 (17 comments) (3 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
featurehelp wanted

Description

Expected Behavior

In the yarn v1 and yarn v2 (with nodeLinker: node_modules), commitlint work perfectly

Current Behavior

It doesn't work at all. I've tried these command in git-hook (husky):

  • npx --no-install commitlint --edit "$1"
  • yarn --no-install commitlint --edit "$1"
  • yarn run --no-install commitlint --edit "$1"

Here is the pictures of this problem: Screen Shot 2021-06-07 at 12 33 55

Screen Shot 2021-06-07 at 12 34 31

Screen Shot 2021-06-07 at 12 34 51

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Steps to Reproduce (for bugs)

Link for my repo (bypass git hook)

  1. yarn init && yarn set version berry
  2. yarn add -D @commitlint/config-conventional @commitlint/cli husky
  3. yarn husky install
  4. echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
  5. npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
  6. Commit change

Context

Your Environment

Mac OS X 10.11.6 El Captain

Executable Version
commitlint --version bash: commitlint: command not found
yarn run commitlint --version @commitlint/cli@12.1.4 (Need yarn run, see here
git --version git version 2.29.2
node --version v14.15.3

Contributor guide

Tech stack
typescriptnodejsshell
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.
mostly clear
Prerequisites
Basic knowledge of Yarn v2Understanding of commitlint configurationFamiliarity with git hooks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue is about commitlint not working with Yarn v2's Plug'n'play mode. The user reports that commands like 'npx no install commitlint' fail. Investigate how commitlint resolves its dependencies when using Yarn v2 PnP. Check the commitlint CLI entry point and whether it properly loads packages using Node.js's resolver. Look into the Yarn v2 documentation on PnP and how to make packages compatible. Consider adding a Yarn specific resolution or using 'yarn node' to execute. Also review any existing comments in the issue for attempted solutions. Key files to examine: packages/cli/src/cli.js or similar and the package.json for dependencies.