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

Don't add markdownlint config to NPM package #3413

Merged
merged 1 commit into from Sep 6, 2022

Conversation

jorrit
Copy link
Contributor

@jorrit jorrit commented Sep 6, 2022

Perhaps a "files" key in package.json is a better idea than expanding the "ignore" list again. But I'll leave that to the maintainer.

@codecov
Copy link

codecov bot commented Sep 6, 2022

Codecov Report

Merging #3413 (2cae464) into master (22c569b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3413   +/-   ##
=======================================
  Coverage   97.58%   97.58%           
=======================================
  Files         123      123           
  Lines        8957     8957           
  Branches     3271     3271           
=======================================
  Hits         8741     8741           
  Misses        216      216           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@ljharb
Copy link
Member

ljharb commented Sep 6, 2022

The files key is dangerous and should never be used; expanding the ignore list is proper.

@jorrit
Copy link
Contributor Author

jorrit commented Sep 6, 2022

Alright, I didn't know that. Do you have some reference where I can read more about the dangers?

@ljharb
Copy link
Member

ljharb commented Sep 6, 2022

No - it's just the way it behaves. If you forget to add a file to "npmignore", the worst consequence is "a file nothing cares about ends up in the package" - iow, harmless, and at worst inconvenient. If you forget to add a file to "files", the worst consequence is "downstream users are broken", which can easily cause millions of dollars of person-hours of work.

(Since credentials should never be stored in an in-repo file anyways, "credentials could be leaked" shouldn't ever be a concern)

@ljharb ljharb merged commit 2cae464 into jsx-eslint:master Sep 6, 2022
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.

None yet

2 participants