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

feature(cli): removes the necessity to pass --config to read the default configuration file BREAKING #771

Merged
merged 1 commit into from
Apr 2, 2023

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Apr 2, 2023

Description

  • removes the necessity to pass --config on the cli
  • adjusts the documentation accordingly (including help in error messages)
  • updates the run scripts that used the default configuration file name accordingly

Motivation and Context

As dependency-cruiser is likely used 99.9% of the time with a configuration file, it is more user friendly to be able to run it without having to specify where the configuration file lives, especially if it's on the default location.

This is a 🚨 BREAKING change for the few folks who run dependency-cruiser without a configuration file. Those will have to use the (already existing) --no-config command line option in stead.

How Has This Been Tested?

  • green ci
  • manual checks with and without --config present on the command line

Types of changes

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

Checklist

  • 📖

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • ⚖️

    • The contribution will be subject to The MIT license, and I'm OK with that.
    • The contribution is my own original work.
    • I am ok with the stuff in CONTRIBUTING.md.

@sverweij sverweij changed the title feature(cli): removes the necessity to pass --config to read the deafult configuration file BREAKING feature(cli): removes the necessity to pass --config to read the default configuration file BREAKING Apr 2, 2023
@sverweij sverweij merged commit 2ac8fad into v13 Apr 2, 2023
@sverweij sverweij deleted the feature/automatically-read-config-files branch April 2, 2023 09:55
sverweij added a commit that referenced this pull request Apr 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant