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

feat: allow configuration to be overridden #25

Merged
merged 2 commits into from
Jan 3, 2020
Merged

Conversation

mattcan
Copy link
Contributor

@mattcan mattcan commented Jan 3, 2020

itshappening

This PR enables the (long awaited) ability to override the telus-standard linting configuration. For some users, this will be a BREAKING change.

How do I know if this will be a breaking change for my project?

  • You have already migrated to telus-standard and your project has a .eslintrc.* file
  • You are migrating to telus-standard and keeping your *.eslintrc.* file

If you meet one of these criteria then when you upgrade to the latest version of telus-standard, your existing configuration will come into play and you may fail linting.

Please, how do I bring back semicolons?

If you don't have an .eslintrc.* file, create a new .eslintrc.js and add this:

module.exports = {
  rules: {
    semi: ['error', 'always']
  }
}

@mattcan
Copy link
Contributor Author

mattcan commented Jan 3, 2020

Probably should merge as a breaking change? If anyone left their .eslintrc in the directory after adopting this project, it will suddenly come back to life.

I'll add some documentation.

@mattcan
Copy link
Contributor Author

mattcan commented Jan 3, 2020

  • Added a CHANGELOG.md that points to this PR
  • Updated the PR description to better inform what this change is and help developers determine how they will be affected
  • Changed migration steps in README.md

@maumercado maumercado merged commit 266b046 into master Jan 3, 2020
mattcan added a commit that referenced this pull request Jan 9, 2020
@mattcan mattcan deleted the allow-overrides branch January 9, 2020 18:34
@github-actions
Copy link

github-actions bot commented Jan 9, 2020

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

2 participants