{"id":25103,"library":"commitlint-circle","title":"commitlint-circle","description":"Convenience wrapper around @commitlint/cli for linting all relevant commits for a change or PR on Circle CI, version 1.0.0. This package is specifically for Circle CI, providing zero-configuration linting. Its key differentiator is the automatic detection of the commit range based on Circle CI environment variables (e.g., CIRCLE_PULL_REQUESTS, CIRCLE_SHA1). It requires @commitlint/cli ^7.0.0 as a peer dependency. Ship TypeScript types. One of the few commitlint integrations tailored to Circle CI, but note it is not actively maintained (last release in 2019).","status":"maintenance","version":"1.0.0","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","typescript"],"install":[{"cmd":"npm install commitlint-circle","lang":"bash","label":"npm"},{"cmd":"yarn add commitlint-circle","lang":"bash","label":"yarn"},{"cmd":"pnpm add commitlint-circle","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required for linting logic","package":"@commitlint/cli","optional":false}],"imports":[{"note":"This is a CLI tool, not a library to import. Use it via `npx commitlint-circle` in your Circle CI config.","wrong":"import commitlintCircle from 'commitlint-circle'","symbol":"commitlint-circle","correct":"library is a CLI tool, intended to be run via `npx commitlint-circle` or as a yarn script; no import in source code"}],"quickstart":{"code":"// .circleci/config.yml\nversion: 2.1\norbs:\n  node: circleci/node@5.0.0\njobs:\n  build:\n    executor:\n      name: node/default\n    steps:\n      - checkout\n      - node/install-packages:\n          pkg-manager: yarn\n      - run:\n          name: Lint commits\n          command: npx commitlint-circle","lang":"typescript","description":"Configures Circle CI to run commitlint-circle, which lints all commits in the current build or PR."},"warnings":[{"fix":"Consider using @commitlint/config-conventional directly with commitlint's built-in Circle CI support, or use commitlint GitHub action.","message":"Package has not been updated since 2019 and may not work with newer versions of @commitlint/cli.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Only run in Circle CI environment; for local testing, set environment variables like CIRCLE_SHA1, CIRCLE_PULL_REQUESTS manually.","message":"The package relies on Circle CI environment variables; it will fail silently or with unclear errors if run outside Circle CI.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Ensure @commitlint/cli version satisfies the peer dependency range (^7.0.0).","message":"Requires @commitlint/cli@^7.0.0 as peer dependency, which may conflict with newer commitlint versions.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `npm install @commitlint/cli@^7.0.0 --save-dev` or `yarn add @commitlint/cli@^7.0.0 --dev`","cause":"Missing peer dependency @commitlint/cli","error":"Error: Cannot find module '@commitlint/cli'"},{"fix":"Ensure you are running inside a Circle CI job, or set the necessary environment variables for testing.","cause":"Missing required Circle CI environment variables (e.g., CIRCLE_PULL_REQUESTS, CIRCLE_SHA1)","error":"Error: No commit range found. Are you running on Circle CI?"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}