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] order: Remove duplicate mention of default #2280

Merged
merged 1 commit into from Nov 19, 2021
Merged

[Docs] order: Remove duplicate mention of default #2280

merged 1 commit into from Nov 19, 2021

Conversation

johnthagen
Copy link
Contributor

Update docs for import rule / newlines-between option. Default value is taken from:

const newlinesBetweenImports = options['newlines-between'] || 'ignore';

docs/rules/order.md Show resolved Hide resolved
docs/rules/order.md Outdated Show resolved Hide resolved
@ljharb ljharb added the docs label Oct 29, 2021
@johnthagen
Copy link
Contributor Author

@ljharb After your feedback, I'm inclined to simply close this PR altogether. Do you concur?

@ljharb
Copy link
Member

ljharb commented Oct 29, 2021

Maybe not; #2280 (comment)

@johnthagen
Copy link
Contributor Author

Hmm, it seems like for bullet-list options the default is given inline:

https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md#alphabetize-order-ascdescignore-caseinsensitive-truefalse

So, I'm back to being unsure about the PR.

@codecov
Copy link

codecov bot commented Oct 29, 2021

Codecov Report

Merging #2280 (34e9023) into main (2c33530) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 34e9023 differs from pull request most recent head 32cae19. Consider uploading reports for the commit 32cae19 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2280      +/-   ##
==========================================
- Coverage   94.64%   94.64%   -0.01%     
==========================================
  Files          65       65              
  Lines        2689     2687       -2     
  Branches      890      889       -1     
==========================================
- Hits         2545     2543       -2     
  Misses        144      144              
Impacted Files Coverage Δ
src/rules/no-import-module-exports.js 100.00% <0.00%> (ø)
src/rules/no-default-export.js 92.30% <0.00%> (+1.39%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c33530...32cae19. Read the comment docs.

@ljharb ljharb changed the title Add default value for newlines-between parameter to order rule [Docs] order: Remove duplicate mention of default Nov 19, 2021
@ljharb ljharb merged commit 32cae19 into import-js:main Nov 19, 2021
@johnthagen johnthagen deleted the patch-3 branch November 19, 2021 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

None yet

2 participants