Skip to content

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Jan 3, 2025

DISCLAIMER: this is a work in progress and subject to force push

This mainly implies using specific signature for functions instead of using the generic "Function" type.

BREAKING CHANGES: TODO

Tasks

This PR initially tried to bump all eslint plugins and to fix all eslint errors/warnings. As this was a too large task, it has been split:

@tbouffard tbouffard added dependencies skip-changelog Do not include in Changelog and Release Notes javascript Pull requests that update Javascript code labels Jan 3, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jan 3, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
🪧 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

@tbouffard tbouffard changed the title chore/bump_eslint_dependencies chore(deps-dev): bump eslint dependencies Jan 3, 2025
@tbouffard tbouffard changed the title chore(deps-dev): bump eslint dependencies chore(deps-dev): bump lint dependencies Jan 3, 2025

// Invokes the function on the editor using the args
action.apply(this, args);
action(this, cell, evt);
Copy link
Member Author

@tbouffard tbouffard Jan 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: check if removing the binding to this may not introduce regression.
We probably should revert this change as it is out of the scope of this PR.

return (<Editor>this.editor).graph.cloneCell(ptype);
}
return null;
return (<Editor>this.editor).graph.cloneCell(ptype);
Copy link
Member Author

@tbouffard tbouffard Jan 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: check if this simplification doesn't introduce regression.
We should revert it, as it is out of the scope of this PR

@tbouffard tbouffard force-pushed the chore/bump_eslint_dependencies branch 2 times, most recently from ab8db8d to f8c0ee5 Compare January 10, 2025 13:00
@tbouffard tbouffard force-pushed the chore/bump_eslint_dependencies branch from f8c0ee5 to fbc885b Compare January 17, 2025 14:41
@sonarqubecloud
Copy link

@tbouffard tbouffard changed the title chore(deps-dev): bump lint dependencies refactor!(type): use explicit parameters in all functions Mar 18, 2025
@tbouffard tbouffard added refactor Code refactoring and removed dependencies skip-changelog Do not include in Changelog and Release Notes javascript Pull requests that update Javascript code labels Mar 18, 2025
@tbouffard tbouffard changed the title refactor!(type): use explicit parameters in all functions refactor(type)!: use explicit parameters in all functions May 7, 2025
*/
send(
// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type -- require a generic function type
onload: Function | null = null,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Onload" specific signature can be inferred because it is used in this method .

This applies to onLoad parameters of all methods and functions of this file.

@sonarqubecloud
Copy link


// Invokes the function on the editor using the args
action.apply(this, args);
action(this, cell, evt);
Copy link
Member Author

@tbouffard tbouffard Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may have changes the behavior here by removing the binding to this.

To be reviewed.
Otherwise keep the former implementation

import type { AbstractGraph } from '../view/AbstractGraph';
import EventObject from '../view/event/EventObject';
import type { DropHandler } from '../view/other/DragSource';
import { EventListenerFunction } from '../types';
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "type" import

): MarkerFunction | null;
}

// TODO rename to EventListener?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the name and remove todo

eventObject: EventObject
) => void;

// TODO rename to EditorAction?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the name and remove todo

import { applyGraphMixins } from './mixins/_graph-mixins-apply';
import { isNullish } from '../internal/utils';
import { isI18nEnabled } from '../internal/i18n-utils';
import AbstractCanvas2D from './canvas/AbstractCanvas2D';
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use type import


import GraphHierarchyNode from '../datatypes/GraphHierarchyNode';
import GraphHierarchyEdge from '../datatypes/GraphHierarchyEdge';
import GraphAbstractHierarchyCell from '../datatypes/GraphAbstractHierarchyCell';
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use type import

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactor Code refactoring

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant