chore(docs): use shared linter config #1458
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request is a comprehensive code formatting and consistency update across the documentation project. The changes primarily involve standardizing code style, such as converting quotes from single to double, adding semicolons, adjusting indentation, and updating import statements. The modifications span multiple files including TypeScript, MDX, configuration files, and CSS, focusing on improving code readability and maintaining a uniform coding style without altering the underlying functionality. Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (26)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (25)
docs/app/[[...mdxPath]]/page.tsx(1 hunks)docs/app/analytics.tsx(1 hunks)docs/app/layout.tsx(1 hunks)docs/content/_meta.ts(1 hunks)docs/content/docs/_meta.ts(1 hunks)docs/content/docs/community.mdx(2 hunks)docs/content/docs/getting-started/_meta.ts(1 hunks)docs/content/docs/help.mdx(2 hunks)docs/content/docs/index.mdx(2 hunks)docs/content/docs/reference/_meta.ts(1 hunks)docs/content/docs/reference/deploy/_meta.ts(1 hunks)docs/content/docs/reference/features/_meta.ts(1 hunks)docs/content/docs/walkthrough/_meta.ts(1 hunks)docs/content/docs/walkthrough/fields.md(1 hunks)docs/content/docs/walkthrough/introduction.md(1 hunks)docs/content/index.mdx(1 hunks)docs/content/index.module.css(1 hunks)docs/content/overrides.css(1 hunks)docs/eslint.config.js(1 hunks)docs/mdx-components.tsx(1 hunks)docs/next-sitemap.config.js(1 hunks)docs/next.config.mjs(1 hunks)docs/package.json(1 hunks)docs/tsconfig.json(1 hunks)docs/vercel.json(1 hunks)
✅ Files skipped from review due to trivial changes (24)
- docs/eslint.config.js
- docs/content/docs/walkthrough/fields.md
- docs/tsconfig.json
- docs/content/index.mdx
- docs/content/docs/getting-started/_meta.ts
- docs/content/docs/index.mdx
- docs/next-sitemap.config.js
- docs/vercel.json
- docs/content/docs/reference/deploy/_meta.ts
- docs/next.config.mjs
- docs/content/docs/community.mdx
- docs/content/_meta.ts
- docs/content/docs/reference/features/_meta.ts
- docs/mdx-components.tsx
- docs/content/index.module.css
- docs/app/[[...mdxPath]]/page.tsx
- docs/content/docs/walkthrough/introduction.md
- docs/content/overrides.css
- docs/content/docs/reference/_meta.ts
- docs/app/analytics.tsx
- docs/content/docs/walkthrough/_meta.ts
- docs/content/docs/help.mdx
- docs/content/docs/_meta.ts
- docs/app/layout.tsx
🧰 Additional context used
🪛 GitHub Actions: lint all
docs/package.json
[error] 2-30: Wrong indent style found (tabs instead of spaces)
🔇 Additional comments (4)
docs/package.json (4)
7-8: LGTM: Good addition of lint and format scripts.The addition of standardized lint and format scripts will help maintain consistent code style across the documentation.
11-11: LGTM: Good use of shared Prettier config.Using a shared Prettier configuration (
@steebchen/prettier-config) aligns with the PR's objective of standardizing code style.
21-29: Consider pinning exact versions of development tools.While you've pinned exact versions for most devDependencies, consider doing the same for all of them to ensure consistent development environments. Also, some versions appear unusually high:
- TypeScript 5.7.3 (current stable is ~5.3.x)
- ESLint 9.18.0 (current stable is ~8.x)
Let's verify the available versions:
13-18: Verify package versions - these seem incorrect.Several dependency versions appear to be future versions that don't exist:
- Next.js 15.1.5 (current stable is ~14.x)
- React 19.0.0 (current stable is ~18.x)
Let's verify the available versions:
| "scripts": { | ||
| "dev": "next dev --turbopack", | ||
| "start": "next start", | ||
| "test": "npm run build", | ||
| "build": "npx next build && next-sitemap", | ||
| "lint": "eslint . && prettier --check .", | ||
| "format": "eslint --fix . && prettier --write .", | ||
| "postbuild": "pagefind --site .next/server/app --output-path public/_pagefind" | ||
| }, |
There was a problem hiding this comment.
Fix indentation to use spaces instead of tabs.
The CI pipeline is failing due to the use of tabs for indentation. According to the lint errors, the project standard is to use spaces.
Convert all tabs to spaces in the JSON file to fix the pipeline failure.
🧰 Tools
🪛 GitHub Actions: lint all
[error] 2-30: Wrong indent style found (tabs instead of spaces)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/package.json (1)
2-10:⚠️ Potential issueFix indentation to use spaces instead of tabs.
The indentation still uses tabs instead of spaces, which is causing CI pipeline failures.
Convert all tabs to 2 spaces for consistency with project standards.
🧹 Nitpick comments (1)
docs/package.json (1)
7-8: Consider combining lint and format scripts.The lint and format scripts could be optimized by running prettier first and then eslint, as eslint can also handle some formatting rules.
- "lint": "eslint . && prettier --check .", - "format": "eslint --fix . && prettier --write .", + "lint": "prettier --check . && eslint .", + "format": "prettier --write . && eslint --fix ."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (26)
.editorconfig(1 hunks)docs/app/[[...mdxPath]]/page.tsx(1 hunks)docs/app/analytics.tsx(1 hunks)docs/app/layout.tsx(1 hunks)docs/content/_meta.ts(1 hunks)docs/content/docs/_meta.ts(1 hunks)docs/content/docs/community.mdx(2 hunks)docs/content/docs/getting-started/_meta.ts(1 hunks)docs/content/docs/help.mdx(2 hunks)docs/content/docs/index.mdx(2 hunks)docs/content/docs/reference/_meta.ts(1 hunks)docs/content/docs/reference/deploy/_meta.ts(1 hunks)docs/content/docs/reference/features/_meta.ts(1 hunks)docs/content/docs/walkthrough/_meta.ts(1 hunks)docs/content/docs/walkthrough/fields.md(1 hunks)docs/content/docs/walkthrough/introduction.md(1 hunks)docs/content/index.mdx(1 hunks)docs/content/index.module.css(1 hunks)docs/content/overrides.css(1 hunks)docs/eslint.config.js(1 hunks)docs/mdx-components.tsx(1 hunks)docs/next-sitemap.config.js(1 hunks)docs/next.config.mjs(1 hunks)docs/package.json(1 hunks)docs/tsconfig.json(1 hunks)docs/vercel.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (24)
- docs/vercel.json
- docs/content/docs/walkthrough/fields.md
- docs/eslint.config.js
- docs/tsconfig.json
- docs/next-sitemap.config.js
- docs/content/docs/getting-started/_meta.ts
- docs/content/docs/walkthrough/introduction.md
- docs/content/docs/reference/features/_meta.ts
- docs/content/docs/_meta.ts
- docs/content/index.mdx
- docs/mdx-components.tsx
- docs/next.config.mjs
- docs/content/docs/reference/_meta.ts
- docs/content/_meta.ts
- docs/content/overrides.css
- docs/content/index.module.css
- docs/content/docs/index.mdx
- docs/app/analytics.tsx
- docs/app/layout.tsx
- docs/content/docs/reference/deploy/_meta.ts
- docs/content/docs/help.mdx
- docs/content/docs/community.mdx
- docs/content/docs/walkthrough/_meta.ts
- docs/app/[[...mdxPath]]/page.tsx
🔇 Additional comments (4)
docs/package.json (4)
11-11: LGTM! Good use of shared configuration.Using a shared prettier configuration will help maintain consistency across projects.
20-30: Verify TypeScript version.The TypeScript version
5.7.3seems incorrect as it's beyond the current stable release.Let's verify the latest stable version:
13-18: Verify dependency versions.Several dependency versions seem incorrect:
next: 15.1.5(current stable is ~14.x)react: 19.0.0(current stable is ~18.x)react-dom: 19.0.0(should match react version)Let's verify the latest stable versions:
3-3: Consider removing the turbopack flag.The
--turbopackflag enables experimental features that might not be stable. Consider removing it unless there's a specific need for turbopack.Let's check the Next.js version compatibility:
✅ Verification successful
Remove redundant
--turbopackflagThe
--turbopackflag is redundant in Next.js 15.x as Turbopack is already the default compiler for development mode. You can safely remove it from thedevscript.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify if turbopack is stable in the specified Next.js version curl -s https://registry.npmjs.org/next/15.1.5 | jq -r '.dist-tags'Length of output: 161
Script:
#!/bin/bash # Check Next.js version and any Turbopack related documentation echo "=== Next.js Version ===" cat docs/package.json | jq -r '.dependencies.next' echo -e "\n=== Looking for Turbopack documentation ===" rg -i turbopack --type mdLength of output: 245
Updated various files in the `docs` folder to correct inconsistent indentation, formatting, and quotes. This includes changes to `vercel.json`, `_meta.ts`, `introduction.md`, `tsconfig.json`, `analytics.tsx`, and `pnpm-lock.yaml` to ensure consistent coding standards and improved readability.
Updated various files in the
docsfolder to correct inconsistent indentation, formatting, and quotes. This includes changes tovercel.json,_meta.ts,introduction.md,tsconfig.json,analytics.tsx, andpnpm-lock.yamlto ensure consistent coding standards and improved readability.Summary by CodeRabbit
Chores
Documentation
Dependencies
These changes focus on improving code quality and maintaining consistent documentation formatting without introducing new features or functional modifications.