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.

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

423-fix: Add ESLint rules for formatting import-export long strings #424

Merged
merged 7 commits into from
Jul 25, 2024

Conversation

ansivgit
Copy link
Collaborator

@ansivgit ansivgit commented Jul 23, 2024

What type of PR is this? (select all that apply)

  • πŸ• Feature
  • πŸ› Bug Fix
  • 🚧 Breaking Change
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ“ Documentation Update

Description

Related Tickets & Documents

Screenshots, Recordings

Added/updated tests?

  • πŸ‘Œ Yes
  • πŸ™…β€β™‚οΈ No, because they aren't needed
  • πŸ™‹β€β™‚οΈ No, because I need help

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Summary by CodeRabbit

  • New Features

    • Introduced a new linting command to enhance error reporting during code checks.
    • Added a new dependency to improve management of import statement formatting.
  • Bug Fixes

    • Enhanced error handling readability in data fetching hooks.
  • Style

    • Improved formatting of import statements across various files for better readability.
    • Reformatted text in the Requirements component for clarity.
    • Updated ESLint configuration for improved stability in development environments.
  • Refactor

    • Refactored control flow in components for improved code structure and maintainability.

@ansivgit ansivgit self-assigned this Jul 23, 2024
Copy link

github-actions bot commented Jul 23, 2024

Qodana for JS

It seems all right πŸ‘Œ

No new problems were found according to the checks applied

πŸ’‘ Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Detected 174 dependencies

Third-party software list

This page lists the third-party software dependencies used in project

Dependency Version Licenses
@eslint-community/eslint-utils 4.4.0 MIT
@eslint-community/regexpp 4.11.0 MIT
@eslint/eslintrc 2.1.4 MIT
@eslint/js 8.57.0 MIT
@humanwhocodes/config-array 0.11.14 Apache-2.0
@humanwhocodes/module-importer 1.0.1 Apache-2.0
@humanwhocodes/object-schema 2.0.3 BSD-3-Clause
@next/env 14.2.4 MIT
@next/swc-linux-x64-gnu 14.2.4 MIT
@next/swc-linux-x64-musl 14.2.4 MIT
@nodelib/fs.scandir 2.1.5 MIT
@nodelib/fs.stat 2.0.5 MIT
@nodelib/fs.walk 1.2.8 MIT
@playwright/test 1.45.1 Apache-2.0
@remix-run/router 1.17.1 MIT
@swc/counter 0.1.3 Apache-2.0
@swc/helpers 0.5.5 Apache-2.0
@ungap/structured-clone 1.2.0 ISC
acorn-jsx 5.3.2 MIT
acorn 8.12.1 MIT
ajv 6.12.6 MIT
ansi-regex 5.0.1 MIT
ansi-styles 4.3.0 MIT
anymatch 3.1.3 ISC
balanced-match 1.0.2 MIT
binary-extensions 2.3.0 MIT
brace-expansion 1.1.11 MIT
braces 3.0.3 MIT
brcast 3.0.2 MIT
busboy 1.6.0 MIT
callsites 3.1.0 MIT
caniuse-lite 1.0.30001640 CC-BY-4.0
chalk 4.1.2 MIT
chokidar 3.6.0 MIT
class-variance-authority 0.7.0 Apache-2.0
classnames 2.5.1 MIT
client-only 0.0.1 MIT
clsx 2.0.0 MIT
color-convert 2.0.1 MIT
color-name 1.1.4 MIT
concat-map 0.0.1 MIT
cross-spawn 7.0.3 MIT
css-vendor 0.3.8 MIT
dayjs 1.11.11 MIT
debug 4.3.5 MIT
deep-is 0.1.4 MIT
doctrine 3.0.0 Apache-2.0
escape-string-regexp 4.0.0 MIT
eslint-plugin-import-newlines 1.4.0 MIT
eslint-scope 7.2.2 BSD-2-Clause
eslint-visitor-keys 3.4.3 Apache-2.0
eslint 8.57.0 MIT
espree 9.6.1 BSD-2-Clause
esquery 1.5.0 BSD-3-Clause
esrecurse 4.3.0 BSD-2-Clause
estraverse 5.3.0 BSD-2-Clause
esutils 2.0.3 BSD-2-Clause
fast-deep-equal 3.1.3 MIT
fast-levenshtein 2.0.6 MIT
fastq 1.17.1 ISC
file-entry-cache 6.0.1 MIT
fill-range 7.1.1 MIT
find-up 5.0.0 MIT
flat-cache 3.2.0 MIT
flatted 3.3.1 ISC
fs.realpath 1.0.0 ISC
glob-parent 5.1.2 ISC
glob-parent 6.0.2 ISC
glob 7.2.3 ISC
globals 13.24.0 MIT
graceful-fs 4.2.11 ISC
graphemer 1.4.0 MIT
has-flag 4.0.0 MIT
hoist-non-react-statics 2.5.5 BSD-3-Clause
hyphenate-style-name 1.1.0 BSD-3-Clause
ignore 5.3.1 MIT
immutable 4.3.6 MIT
import-fresh 3.3.0 MIT
imurmurhash 0.1.4 MIT
inflight 1.0.6 ISC
inherits 2.0.4 ISC
is-binary-path 2.1.0 MIT
is-function 1.0.2 MIT
is-glob 4.0.3 MIT
is-in-browser 1.1.3 MIT
is-number 7.0.0 MIT
is-path-inside 3.0.3 MIT
is-plain-object 2.0.4 MIT
isexe 2.0.0 ISC
isobject 3.0.1 MIT
js-tokens 4.0.0 MIT
js-yaml 4.1.0 MIT
json-buffer 3.0.1 MIT
json-stable-stringify-without-jsonify 1.0.1 MIT
jss-camel-case 6.1.0 MIT
jss-compose 5.0.0 MIT
jss-default-unit 8.0.2 MIT
jss-expand 5.3.0 MIT
jss-extend 6.2.0 MIT
jss-global 3.0.0 MIT
jss-nested 6.0.1 MIT
jss-preset-default 4.5.0 MIT
jss-props-sort 6.0.0 MIT
jss-template 1.0.1 MIT
jss-vendor-prefixer 7.0.0 MIT
jss 9.8.7 MIT
keyv 4.5.4 MIT
levn 0.4.1 MIT
locate-path 6.0.0 MIT
lodash.merge 4.6.2 MIT
loose-envify 1.4.0 MIT
minimatch 3.1.2 ISC
nanoid 3.3.7 MIT
natural-compare 1.4.0 MIT
next 14.2.4 MIT
nextjs-toploader 1.6.12 MIT
normalize-path 3.0.0 MIT
nprogress 0.2.0 MIT
object-assign 4.1.1 MIT
once 1.4.0 ISC
optionator 0.9.4 MIT
p-limit 3.1.0 MIT
p-locate 5.0.0 MIT
parent-module 1.0.1 MIT
path-exists 4.0.0 MIT
path-is-absolute 1.0.1 MIT
path-key 3.1.1 MIT
picocolors 1.0.1 ISC
picomatch 2.3.1 MIT
playwright-core 1.45.1 Apache-2.0
playwright 1.45.1 Apache-2.0
postcss 8.4.31 MIT
prelude-ls 1.2.1 MIT
prop-types 15.8.1 MIT
queue-microtask 1.2.3 MIT
react-dom 16.14.0 MIT
react-dom 18.3.1 MIT
react-double-marquee 1.1.0 MIT
react-easy-swipe 0.0.21 MIT
react-is 16.13.1 MIT
react-json-pretty 2.2.0 MIT
react-jss 8.6.1 MIT
react-responsive-carousel 3.2.23 MIT
react-router-dom 6.24.1 MIT
react-router 6.24.1 MIT
react 16.14.0 MIT
react 18.3.1 MIT
readdirp 3.6.0 MIT
resolve-from 4.0.0 MIT
reusify 1.0.4 MIT
rimraf 3.0.2 ISC
run-parallel 1.2.0 MIT
sass 1.77.6 MIT
scheduler 0.19.1 MIT
scheduler 0.23.2 MIT
shebang-command 2.0.0 MIT
shebang-regex 3.0.0 MIT
source-map-js 1.2.0 BSD-3-Clause
streamsearch 1.1.0 MIT
strip-ansi 6.0.1 MIT
strip-json-comments 3.1.1 MIT
styled-jsx 5.1.1 MIT
supports-color 7.2.0 MIT
text-table 0.2.0 MIT
theming 1.3.0 MIT
to-regex-range 5.0.1 MIT
tslib 2.6.3 0BSD
type-check 0.4.0 MIT
type-fest 0.20.2 MIT
warning 3.0.0 BSD-3-Clause
which 2.0.2 ISC
word-wrap 1.2.5 MIT
wrappy 1.0.2 ISC
yocto-queue 0.1.0 MIT
Contact Qodana team

Contact us at [email protected]

@ansivgit ansivgit changed the title add ESLint rules for formatting import-export long strings 423-fix: Add ESLint rules for formatting import-export long strings Jul 23, 2024
Copy link

Lighthouse Report:

  • Performance: 44 / 100
  • Accessibility: 91 / 100
  • Best Practices: 93 / 100
  • SEO: 100 / 100

View detailed report

@ansivgit ansivgit marked this pull request as ready for review July 24, 2024 15:43
Copy link

coderabbitai bot commented Jul 24, 2024

Walkthrough

Walkthrough

The recent changes enhance the ESLint configuration to improve code quality, emphasizing the formatting of import statements and enforcing curly braces for control statements. Updates include new linting rules, refinements across multiple files for better readability, and adherence to team conventions regarding multi-line statements.

Changes

File Change Summary
eslint.config.js Added rules for import formatting and enforced curly braces. Adjusted max line length to 100.
package.json Introduced lint:err script and added eslint-plugin-import-newlines dependency.
src/.../scroll-to-hash.test.tsx Reformatted import statements for improved readability.
src/.../api/index.ts Reformatted import statements to multi-line for clarity.
src/.../use-data-by-name.ts Enhanced error handling structure with curly braces.
src/.../use-title.test.tsx Improved readability without changing logic.
src/.../convertToWebp.ts Enhanced readability of conditional return statements.
src/.../widget-title.tsx Reformatted WidgetTitleProps type declaration for clarity.
src/.../about.data.ts Reformatted conditional block structure for better readability.
src/.../community.tsx Reformatted import statements for clarity.
src/.../courses-school/courses.test.tsx Reformatted imports to multi-line for better readability.
src/.../courses/ui/courses.tsx Refactored control flow for loading and error states using block statements.
src/.../requirements.tsx Minor text formatting change for readability.
src/.../study-path/ui/stages.tsx Reformatted return statement for stages prop handling.

Assessment against linked issues

Objective Addressed Explanation
Add multiline rules for long import/export strings (#423) βœ…
Avoid using single-line if statements (#423) βœ…

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c6cfa4d and 0721495.

Files selected for processing (1)
  • .vscode/settings.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • .vscode/settings.json

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
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>.
    • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

Lighthouse Report:

  • Performance: 77 / 100
  • Accessibility: 91 / 100
  • Best Practices: 93 / 100
  • SEO: 100 / 100

View detailed report

@ansivgit ansivgit requested a review from SpaNb4 July 25, 2024 07:02
Copy link

Lighthouse Report:

  • Performance: 61 / 100
  • Accessibility: 91 / 100
  • Best Practices: 93 / 100
  • SEO: 100 / 100

View detailed report

@ansivgit ansivgit merged commit 775150a into main Jul 25, 2024
6 checks passed
@ansivgit ansivgit deleted the feat/423-add-eslint-rules-formatting-import-export branch July 25, 2024 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ESLint rules for formatting import-export long strings
4 participants