Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): added --config flag #328

Merged
merged 1 commit into from
May 5, 2018
Merged

docs(cli): added --config flag #328

merged 1 commit into from
May 5, 2018

Conversation

gabemeola
Copy link
Contributor

Referencing this PR: https://github.com/marionebl/commitlint/pull/261 , I updated the docs to include --config / -g flag for passing a custom configuration.
http://marionebl.github.io/commitlint/#/reference-cli

Description

Added --config, -g to docs.

Motivation and Context

Greater visibility for cli options

Usage examples

// path/to/my/custom/config/commitlint.config.js 
module.exports = {
  extends: ['@commitlint/config-conventional'],
    // Disabling scope-case rule
    rules: {
      'scope-case': [0],
  }
};
echo "your commit message here" | commitlint --config path/to/my/custom/config/commitlint.config.js # pass

How Has This Been Tested?

https://github.com/marionebl/commitlint/pull/261

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@marionebl
Copy link
Contributor

Thanks 👍

@marionebl marionebl merged commit 663be67 into conventional-changelog:master May 5, 2018
@gabemeola gabemeola deleted the patch-1 branch November 4, 2018 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants