chore(docs): eslint config

[ryoppippi]

Summary by CodeRabbit

• Chores

  • Updated documentation linting configuration to use an app profile, aligning tooling with current docs setup.
  • Broadened lint coverage across the docs by removing previous path exclusions.
  • Relaxed specific lint rules in docs tooling to allow top-level await and console usage where needed.

• Documentation

  • No content or runtime behavior changes; improvements are limited to tooling and linting for more consistent and maintainable documentation workflows.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The PR updates docs/eslint.config.js to switch the ESLint preset type from 'lib' to 'app' and removes the ignores array. It also adds two ESLint disable comments to docs/update-api-index.ts to permit top-level await and console usage. No runtime logic changes.

Changes

Cohort / File(s)	Summary
ESLint config (docs) docs/eslint.config.js	Changed ryoppippi config option from type: 'lib' to type: 'app'; removed ignores array ('.vitepress/dist', '.vitepress/cache', 'api/', 'public/', 'update-api-index.ts').
Script lint directives docs/update-api-index.ts	Added ESLint disables: antfu/no-top-level-await and no-console. No code or control-flow changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• docs: improve TypeDoc configuration and build process #642 — Also modifies docs/update-api-index.ts around top-level await/console usage, aligning with the new ESLint disables.
• feat(docs): add ESLint configuration for documentation linting #644 — Touches docs/eslint.config.js; related to changing the export configuration (type and options).

Poem

A nibble of config, a hop through the lint,
I twitch my nose—no ignores in print.
Top-level awaits? Console’s okay!
Thump-thump approval for docs today.
In burrows of code, I stash my cheer—
Carrots for clean rules, crystal and clear. 🥕

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-docs-eslint

---

📜 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 a05be95 and 7a1c7f8.

📒 Files selected for processing (2)

• docs/eslint.config.js (1 hunks)
• docs/update-api-index.ts (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @ryoppippi, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refines the ESLint configuration within the documentation section of the project. It adjusts the eslint.config.js to better suit an application context by changing its type and simplifying ignore rules, and it addresses specific linting issues in a utility script by disabling certain rules to allow for necessary functionality.

Highlights

• ESLint Configuration Update: The eslint.config.js file in the docs directory has been updated to change its type from lib to app and remove a list of ignored files, streamlining the linting process for the documentation.
• ESLint Disable Directives: The update-api-index.ts script now includes eslint-disable directives for antfu/no-top-level-await and no-console to suppress specific linting warnings that are acceptable for this utility script.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the ESLint configuration for the docs package. The configuration type is changed to 'app', and the explicit ignores list is removed. This seems intended to rely on defaults from the shared configuration and to start linting the update-api-index.ts script. The script is also updated with eslint-disable comments to handle rules it violates by design. My review includes a suggestion to explicitly ignore generated documentation and public asset directories to prevent potential issues with linting generated or non-source files.

[gemini-code-assist]

While changing the config type to 'app' and removing most of the ignores makes sense, it might be prudent to keep ignoring the api/** and public/** directories.

• The api/** directory contains documentation generated by TypeDoc. Linting generated files can lead to errors that should be fixed in the generator, not in the output files, and any manual fixes would be overwritten.
• The public/** directory typically contains static assets that don't require linting.

Explicitly ignoring these directories would make the configuration more robust.

	markdown: true,
	ignores: [
		'api/**',
		'public/**',
	],