fix: `facet` should be `lang:` instead of `language:` #42

JounQin · 2025-05-30T07:15:41Z

Summary by CodeRabbit

Bug Fixes
- Corrected the language filter in search functionality to use the proper filter key, ensuring accurate search results by language.

changeset-bot · 2025-05-30T07:15:45Z

🦋 Changeset detected

Latest commit: 90e64a4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@alauda/doom	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-05-30T07:15:48Z

Walkthrough

The changes correct a facet filter key in the Algolia search configuration, updating it from language to lang in both documentation and code. This ensures that search results are filtered correctly by language using the intended key.

Changes

File(s)	Change Summary
.changeset/icy-sloths-sit.md	Added patch note about correcting filter key from `language` to `lang`.
src/theme.tsx	Updated Algolia facet filter key from `language` to `lang`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Theme
    participant Algolia

    User->>Theme: Initiate search with language selection
    Theme->>Algolia: Send search request with facetFilters: lang:${lang}
    Algolia-->>Theme: Return filtered search results
    Theme-->>User: Display results

Possibly related PRs

feat: add algolia search support #34: Introduced Algolia search support, including configuration and integration of Algolia in the theme and config files, which is directly related to the facet filter key correction.

Poem

In lines of code, a typo found,
"language" swapped for "lang" renowned.
Now Algolia knows just what to seek,
Search results no longer weak!
With every hop, the queries sing,
Corrected keys make searches spring.
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17585ce and 90e64a4.

📒 Files selected for processing (2)

.changeset/icy-sloths-sit.md (1 hunks)
src/theme.tsx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Build and Lint with Node.js 20 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest
GitHub Check: Build and Lint with Node.js 18 on ubuntu-latest

🔇 Additional comments (2)

.changeset/icy-sloths-sit.md (1)

1-6: LGTM! Changeset properly documents the fix.

The changeset correctly documents this as a patch change and accurately describes the facet key correction.
src/theme.tsx (1)

21-21:
Details

❓ Verification inconclusive

Verify the facet attribute name in your Algolia index.

The syntax change from language:${lang} to lang:${lang} looks correct. However, please verify that lang is the correct facet attribute name configured in your Algolia index to ensure search filtering works as expected.

🌐 Web query:
What are the common facet attribute names used for language filtering in Algolia search?
💡 Result:

Based on the search results provided, there is no specific information about common facet attribute names used specifically for language filtering in Algolia search. The search results discuss faceting in general, how to set up facets, and filtering techniques, but don't mention language-specific facet attributes.

In Algolia, you would typically need to declare any attribute you want to use for filtering (including language filtering) in the attributesForFaceting setting. While the search results show examples of attributes like "category", "author", "publisher", "color", and "brand" being used for faceting, there are no explicit mentions of language-specific attributes.

If you were implementing language filtering in Algolia, you would likely:

Create a custom attribute (such as "language" or "locale") in your records

Declare this attribute in your attributesForFaceting setting

Apply filters using the syntax language:en or similar

For implementing language filtering, you would follow the same process described for other facet attributes in the search results, but the specific naming convention for language attributes is not provided in the available information.

Citations:

1: https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filters-and-facetfilters/

2: https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/

3: https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/

4: https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/

5: https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/how-to/declaring-attributes-for-faceting/

6: https://docs.paligo.net/en/algolia-faceted-search.html

7: https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/how-to/declaring-attributes-for-faceting-with-dashboard/

8: https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/how-to/filter-by-attributes/

9: https://www.algolia.com/doc/api-reference/api-parameters/filters/

10: https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/
Please verify that lang is declared as a facet in your Algolia index settings

The change below is syntactically correct, but it will only work if your index’s attributesForFaceting includes lang (instead of language):

• File: src/theme.tsx, line 21
- facetFilters: [`language:${lang}`],
+ facetFilters: [`lang:${lang}`],

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR fixes an issue with the facet filter key in the Algolia search configuration by updating it from "language:" to "lang:". It also updates the changeset file to reflect this modification.

Updated the facet filter key in src/theme.tsx.
Revised the changeset description to match the fix.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
src/theme.tsx	Changed facet filter key from "language:" to "lang:" in search config
.changeset/icy-sloths-sit.md	Updated changeset description to reflect the fix

pkg-pr-new · 2025-05-30T07:16:53Z

Open in StackBlitz

npm i https://pkg.pr.new/@alauda/doom@42

commit: 90e64a4

fix: facet should be lang: instead of language:

90e64a4

JounQin self-assigned this May 30, 2025

Copilot AI review requested due to automatic review settings May 30, 2025 07:15

JounQin added the bug Something isn't working label May 30, 2025

Copilot AI reviewed May 30, 2025

View reviewed changes

JounQin merged commit 2a2edb1 into main May 30, 2025
16 checks passed

JounQin deleted the fix/algolia branch May 30, 2025 07:21

github-actions bot mentioned this pull request May 30, 2025

chore: release @alauda/doom (next) #35

Merged

github-actions bot pushed a commit that referenced this pull request May 30, 2025

fix: facet should be lang: instead of language: (#42)

e13f6d7

github-actions bot mentioned this pull request Jun 5, 2025

chore: release @alauda/doom #66

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: `facet` should be `lang:` instead of `language:` #42

fix: `facet` should be `lang:` instead of `language:` #42

Uh oh!

JounQin commented May 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented May 30, 2025

Uh oh!

coderabbitai bot commented May 30, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

pkg-pr-new bot commented May 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fix: facet should be lang: instead of language: #42

fix: facet should be lang: instead of language: #42

Uh oh!

Conversation

JounQin commented May 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented May 30, 2025

🦋 Changeset detected

Uh oh!

coderabbitai bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

pkg-pr-new bot commented May 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fix: `facet` should be `lang:` instead of `language:` #42

fix: `facet` should be `lang:` instead of `language:` #42

JounQin commented May 30, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)