Fix eslint issues

[Idrinth]

Summary by CodeRabbit

• New Features

  • Introduced a GitHub Actions workflow to automate ESLint checks.
  • Added a new function to check translations in specified folders and identify discrepancies.

• Enhancements

  • Updated package details including name, version, and repository URL along with adding a homepage and bug tracking URL.
  • Enhanced code generation logic in the TypeScript object export function.
  • Improved file handling and content generation logic in the translation file generation process.

• Bug Fixes

  • Adjusted the export statements and removed unnecessary commas in several functions to streamline code.

• Refactor

  • Consolidated translation checking logic into a new function for better maintainability.
  • Refactored file handling in the translation generation process.

• Documentation

  • Updated ESLint configuration to support Node.js environment checks.

• Chores

  • Modified imports in a tool script to align with current functionality.

[coderabbitai]

Walkthrough

This update enhances the project's Node.js environment compatibility and ESLint configurations, refines the TypeScript script handling, and integrates a GitHub Actions workflow for automated ESLint checks. It also includes updates to package.json for better project identification and dependency management, along with new functionalities for handling YAML files and generating TypeScript code from them.

Changes

Files	Change Summary
.eslintrc.yml, package.json	Updated ESLint environment settings and package details.
.github/workflows/eslint.yml	Added GitHub Actions workflow for ESLint checks.
src/build-translation-file.ts, src/check-folder.ts, src/check.ts, src/config.ts, src/find-yaml-files.ts, src/generate.ts, src/should-split.ts	Introduced and refined TypeScript functionalities for handling and generating code from YAML files.
tools/clear-js-files-from-src.js	Updated imports to enhance file handling.

🐰✨
Hoppity hop, code non-stop,
Changes galore, open the door,
To cleaner code, on Node's abode,
ESLint's watch, errors we swat!
🌟📜

---

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
• Mastodon
• Reddit
• LinkedIn

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 10

Out of diff range and nitpick comments (1)

src/generate.ts (1)

Line range hint 21-119: Ensure consistent use of trailing commas in function parameters and calls.

- export default (logger: Logger, config: Config,) => {
+ export default (logger: Logger, config: Config) => {

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dcc2af1 and 80c0599.

Files selected for processing (11)

• .eslintrc.yml (1 hunks)
• .github/workflows/eslint.yml (1 hunks)
• package.json (1 hunks)
• src/build-translation-file.ts (1 hunks)
• src/check-folder.ts (1 hunks)
• src/check.ts (1 hunks)
• src/config.ts (1 hunks)
• src/find-yaml-files.ts (1 hunks)
• src/generate.ts (4 hunks)
• src/should-split.ts (1 hunks)
• tools/clear-js-files-from-src.js (1 hunks)

Files skipped from review due to trivial changes (5)

• .eslintrc.yml
• .github/workflows/eslint.yml
• package.json
• src/config.ts
• tools/clear-js-files-from-src.js

Additional comments not posted (5)

src/should-split.ts (1)

3-12: Review the logic for splitting data. Currently, it returns false if any property is a string, which might not be the intended behavior if mixed data types are expected.

Please confirm if the current logic aligns with the intended use cases for data splitting.

src/check.ts (1)

6-16: The function correctly aggregates errors and warnings from folder checks. Ensure that the checkFolder function is robust and handles all edge cases as expected.

src/build-translation-file.ts (1)

4-15: The function dynamically generates TypeScript code based on configuration settings. Ensure that the toTypescriptObject function correctly handles all data types expected in data.

Please confirm that toTypescriptObject has comprehensive unit tests covering various data scenarios.

src/check-folder.ts (1)

13-71: The function performs comprehensive checks for translation consistency, logging errors and warnings as appropriate. Ensure that the findYamlFiles, parse, and loadKeys functions are robust and handle all edge cases.

src/generate.ts (1)

Line range hint 21-119: The function effectively handles the generation of TypeScript files from YAML data, including conditional logic for splitting data and handling different file types. Ensure that all helper functions (findYamlFiles, parse, shouldSplit, buildTranslationFile, toTypescriptObjectType, loadKeys) are robust and well-tested.