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.

Sign up for GitHub

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

Jump to bottom

add: include and exclude filters for pagination #3103

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

add: include and exclude filters for pagination #3103

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7d8000b
add: include and exclude filters for pagination
Snapstromegon Nov 13, 2023
e4025d2
add: include and exclude filters for pagination
Snapstromegon Nov 13, 2023
d0afc09
Merge branch 'issue-2522-pagination-include-exclude' of github.com:Sn…
Snapstromegon Nov 13, 2023
f11bb2c
fix: readd isfiltered code after loosing it in merge
Snapstromegon Nov 13, 2023
9e0a9cb
Apply suggestions from code review
Snapstromegon Dec 19, 2023
804470e
Update src/Plugins/Pagination.js
Snapstromegon Dec 19, 2023
8095b27
Apply feedback by @uncenter
Snapstromegon Dec 19, 2023
933eb12
switch default for isIncluded to true
Snapstromegon Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/Plugins/Pagination.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ class Pagination {
return false;
}

isFiltered(value) {
isIncluded(value) {
const hasInclude = "include" in this.data.pagination;
const hasExclude = "exclude" in this.data.pagination;
if (hasInclude && hasExclude) {
Expand All @@ -107,27 +107,27 @@ class Pagination {
if (hasInclude) {
let included = this.data.pagination.include;
if (Array.isArray(included)) {
return !included.includes(value);
return included.includes(value);
}
return included !== value;
return included === value;
}
if (hasExclude) {
let excluded = this.data.pagination.exclude;
if (Array.isArray(excluded)) {
return excluded.includes(value);
return !excluded.includes(value);
}
return excluded === value;
return excluded !== value;
}

// Let's keep this code for backwards compatibility to V2.
Copy link
Contributor

@uncenter uncenter Dec 19, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this old filter property logic now I think.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be happy to do so, but I think this should be communicated, since it affects the public API of this plugin. Is there a way to log warnings if someone still uses filters?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we add a warning when someone uses filter that says "The filter Pagination property has been deprecated in Eleventy v3. You can replace it with exclude for the same effect".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, exactly. My question is, if there is a better way than throwing an error or using console.warn for this.

Copy link
Contributor

@uncenter uncenter Dec 19, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see anywhere else where we are throwing an error or console.warn-ing for a deprecation. Seems like those just get tagged as deprecated with JSDoc but aren't removed or changed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @zachleat, how would you want me to handle this here?
Maybe you even have an opinion on doing a breaking change.

// TODO remove in 3.0
if ("filter" in this.data.pagination) {
let filtered = this.data.pagination.filter;
if (Array.isArray(filtered)) {
return filtered.indexOf(value) > -1;
return filtered.indexOf(value) === -1;
}

return filtered === value;
return filtered !== value;
}

return false;
Snapstromegon marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -189,7 +189,7 @@ class Pagination {
this.data.pagination.include ||
this.data.pagination.exclude
) {
result = result.filter((value) => !this.isFiltered(value));
result = result.filter((value) => this.isIncluded(value));
}

return result;
Expand Down