enzonotario / vitepress-openapi

Generate VitePress API Docs from OpenAPI specifications
https://vitepress-openapi.vercel.app
MIT License
36 stars 8 forks source link

chore(repo): eslint #40

Closed enzonotario closed 3 weeks ago

enzonotario commented 3 weeks ago

Summary by CodeRabbit

vercel[bot] commented 3 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vitepress-theme-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 15, 2024 3:08pm
coderabbitai[bot] commented 3 weeks ago

Walkthrough

Los cambios en este pull request incluyen una reconfiguración significativa del archivo eslint.config.js, donde se ha simplificado la configuración de ESLint mediante la adopción del paquete @antfu/eslint-config. En el archivo package.json, se han eliminado varias dependencias relacionadas con ESLint y se han agregado nuevas, reflejando un enfoque más modular. Además, se han realizado ajustes menores en varios componentes de Vue, principalmente en la sintaxis y el formato, sin alterar la funcionalidad subyacente.

Changes

Archivo Resumen de cambios
eslint.config.js Se simplificó la configuración de ESLint al adoptar @antfu/eslint-config, deshabilitando unocss y habilitando formateadores.
package.json Se eliminaron dependencias como @eslint/js, eslint-plugin-vue, y se añadieron @antfu/eslint-config, eslint-plugin-cypress, y eslint-plugin-format. Se actualizó la versión de eslint a ^9.9.1 y se añadió un campo resolutions para @typescript-eslint/utils.
src/components/Common/OACodeBlock.vue Se eliminaron puntos y comas innecesarios en las declaraciones de importación y se ajustó el uso del componente VueJsonPretty para seguir la convención de nombres de Vue.
src/components/Common/OAHeading.vue Se mejoró el control de flujo en la función getSlotChildrenText mediante la adición de llaves para mayor claridad.
src/components/Path/OAPath.vue Se consolidaron las declaraciones de importación para OpenApi y useOpenapi en una sola línea.
src/components/Request/OARequestBody.vue Se eliminó una línea en blanco en la sección de plantilla, sin afectar la funcionalidad.
src/components/Sample/OACodeSamples.vue Se eliminaron puntos y comas al final de las declaraciones de variables, manteniendo la funcionalidad.
src/components/Schema/OASchemaProperty.vue Se corrigió la sintaxis de la condición de renderizado para OASchemaBody, utilizando la sintaxis de arreglo correcta.
src/components/Schema/OASchemaPropertyAttributes.vue Se ajustó la sintaxis de la declaración del arreglo keysToIgnore para mejorar la legibilidad.
src/components/Schema/OASchemaTabs.vue Se expandieron las declaraciones de propiedades computadas en bloques multilineales para mejorar la claridad del código.
src/components/Try/OARequestParameterInput.vue Se mejoró la legibilidad en la función inputType mediante la adición de llaves en las declaraciones condicionales.
src/components/Try/OARequestSecurityInput.vue Se reordenaron las declaraciones de importación sin afectar la funcionalidad.
src/components/Try/OATryItButton.vue Se eliminaron saltos de línea innecesarios en las funciones tryIt y trackTryIt, sin alterar la lógica.
src/components/Try/OATryWithVariables.vue Se eliminaron puntos y comas en las declaraciones de importación, alineándose con un estilo más consistente.
src/composables/useOpenapi.ts Se eliminó un punto y coma al final de la declaración de importación, sin afectar la funcionalidad.
src/composables/useShiki.ts Se utilizó la sintaxis import type para mejorar la seguridad de tipos y se reformateó la destructuración de parámetros en la función renderShiki.
src/composables/useSidebar.ts Se consolidaron las declaraciones de importación y se mejoró la legibilidad en la función generateSidebarGroup.
src/index.ts Se reorganizaron las declaraciones de importación y se eliminó una importación redundante de VueI18n.
src/lib/OpenApi.ts Se realizaron ajustes estilísticos en las declaraciones de funciones y se estandarizó el uso de comillas simples.
src/lib/fetchToCurl.ts Se estandarizó el uso de comillas simples y se simplificaron las declaraciones de retorno.
src/lib/generateCodeSamples.ts Se eliminó un punto y coma en la declaración de jsFetchOptions, manteniendo la lógica intacta.
src/lib/generateMissingOperationIds.ts Se ajustó la posición de un paréntesis en la declaración de retorno de una función de mapeo, sin afectar la funcionalidad.
src/lib/generateMissingSummary.ts Se ajustó la posición de un paréntesis en la declaración de retorno de una función de mapeo, sin afectar la funcionalidad.
src/lib/generateSchemaJson.ts Se alinearon los parámetros en la función JSON.stringify para mejorar la legibilidad.
src/lib/generateSchemaXml.ts Se eliminaron puntos y comas, manteniendo la lógica y el flujo de control intactos.
src/lib/hasExample.ts Se eliminaron puntos y comas en las declaraciones de retorno, sin afectar la lógica.
src/style.css Se realizaron ajustes estilísticos, incluyendo la eliminación de líneas en blanco y la estandarización de códigos de color hexadecimal.

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
pkg-pr-new[bot] commented 3 weeks ago

Open in Stackblitz

pnpm add https://pkg.pr.new/vitepress-theme-openapi@40
pnpm add https://pkg.pr.new/vitepress-theme-openapi@40

commit: 24b7eb4