fix(ts): Suppress ts errors on Editor.tsx #11275

pinakipb2 · 2024-08-30T12:43:00Z

Checklist

The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
Links to related issues (if applicable)
Tests for the changes have been added/updated (if applicable)
Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

coderabbitai · 2024-08-30T12:43:07Z

Important

Review skipped

Auto reviews are disabled on this repository.

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.

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>, please review it.
- 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 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 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 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.

jjoyce0510 · 2024-09-20T22:05:13Z

Where are these TS errors coming from?

I am not seeing these errors locally. Once we understand where this is coming from, we can decide whether to accept.

Cheers
John

jjoyce0510 · 2024-09-20T22:06:01Z

datahub-web-react/src/app/entity/shared/tabs/Documentation/components/editor/Editor.tsx

            new ImageExtension({ enableResizing: !readOnly }),
            new ItalicExtension(),
            new LinkExtension({ autoLink: true, defaultTarget: '_blank' }),
-            new ListItemExtension(),
+            new ListItemExtension({}),
            new MarkdownExtension({ htmlSanitizer: DOMPurify.sanitize, htmlToMarkdown, markdownToHtml }),
            new OrderedListExtension(),
            new UnderlineExtension(),


Why not do this for all of these?

Errors did not come for others.

jjoyce0510 · 2024-09-20T22:07:16Z

datahub-web-react/src/app/entity/shared/tabs/Documentation/components/editor/Editor.tsx

@@ -50,26 +50,26 @@ export const Editor = forwardRef((props: EditorProps, ref) => {
    const { manager, state, getContext } = useRemirror({
        extensions: () => [
            new BlockquoteExtension(),
-            new BoldExtension(),
-            new BulletListExtension(),
+            new BoldExtension({}),


Even in the Remirror docs, they are not using an empty in constructor for these extensions: https://remirror.io/docs/extensions/bold-extension

Here is the link of an online editor, using the same version of packages. Showing the error:

https://stackblitz.com/edit/vitejs-vite-z3rg1l?file=src%2FEditor.tsx
(You need to wait till yarn install is complete, then the tsx error will start showing)

pinakipb2 · 2024-09-21T01:09:11Z

Where are these TS errors coming from?

I am not seeing these errors locally. Once we understand where this is coming from, we can decide whether to accept.

Cheers John

Hi @jjoyce0510,

This is the snap of the error from my local.

Thanks !

rtekal · 2024-09-30T16:36:38Z

@pinakipb2, @jjoyce0510
Wondering if the IDE or Lint cannot figure out the empty initialization. Charles and myself did some exploration and found the following:

From: https://github.com/remirror/remirror/blob/main/packages/remirror__types/src/types.ts#L106

An alternative to usage of `{}` as a type.

export type EmptyShape = Record<never, never>;

... from: https://github.com/remirror/remirror/blob/main/packages/remirror__core/src/extension/extension.ts#L519
... from: https://github.com/remirror/remirror/blob/main/packages/remirror__extension-bold/src/bold-extension.ts#L57

pinakipb2 · 2024-10-01T03:48:30Z

Checked the Type declaration files and found:

https://github.com/remirror/remirror/blob/main/packages/remirror__extension-bold/src/bold-extension.ts#L57

Passing BoldOptions as generic to MarkExtension is causing the issue. When the generic is removed. The issue seem to resolve.

The error is not coming for some of the other types because:

https://github.com/remirror/remirror/blob/main/packages/remirror__extension-blockquote/src/blockquote-extension.ts#L21

In some places, remirror is using MarkExtension or a similar type NodeExtension but without any generic.

An alternative to usage of {} as a type.

This is working as expected, as this is the default value and when generic is not passed, no ts errors are seen. But when a generic type is passed (even an empty interface), ts gives error for required constructor.

Maybe its an issue with remirror types with how they are inferring the generic or as @rtekal mentioned, IDE or Lint is not able to figure out types.

Update Editor.tsx

d0606b7

github-actions bot added product PR or Issue related to the DataHub UI/UX community-contribution PR or Issue raised by member(s) of DataHub Community labels Aug 30, 2024

vercel bot deployed to Preview August 30, 2024 13:01 View deployment

Merge branch 'master' into patch-1

77ca4ad

vercel bot deployed to Preview September 19, 2024 10:49 View deployment

jjoyce0510 reviewed Sep 20, 2024

View reviewed changes

pinakipb2 requested a review from jjoyce0510 September 30, 2024 02:41

Merge branch 'master' into patch-1

d7504da

vercel bot deployed to Preview September 30, 2024 02:59 View deployment

Merge branch 'master' into patch-1

9342689

vercel bot deployed to Preview October 1, 2024 04:07 View deployment

Merge branch 'master' into patch-1

d852784

vercel bot deployed to Preview October 3, 2024 05:02 View deployment

Merge branch 'master' into patch-1

e9d713f

vercel bot deployed to Preview October 6, 2024 07:06 View deployment

Merge branch 'master' into patch-1

6b46a22

vercel bot deployed to Preview October 8, 2024 04:25 View deployment

Merge branch 'master' into patch-1

1e07a94

vercel bot deployed to Preview October 12, 2024 12:41 View deployment

Merge branch 'master' into patch-1

23ffd28

vercel bot deployed to Preview October 16, 2024 16:33 View deployment

Merge branch 'master' into patch-1

3c06d26

vercel bot deployed to Preview October 31, 2024 08:52 View deployment

Merge branch 'master' into patch-1

fedc277

vercel bot deployed to Preview November 2, 2024 10:28 View deployment

Merge branch 'master' into patch-1

622e5e6

vercel bot deployed to Preview November 9, 2024 13:01 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(ts): Suppress ts errors on Editor.tsx #11275

fix(ts): Suppress ts errors on Editor.tsx #11275

pinakipb2 commented Aug 30, 2024

coderabbitai bot commented Aug 30, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

jjoyce0510 commented Sep 20, 2024

jjoyce0510 Sep 20, 2024

pinakipb2 Sep 21, 2024

jjoyce0510 Sep 20, 2024

pinakipb2 Sep 23, 2024

pinakipb2 commented Sep 21, 2024

rtekal commented Sep 30, 2024

pinakipb2 commented Oct 1, 2024

fix(ts): Suppress ts errors on Editor.tsx #11275

Are you sure you want to change the base?

fix(ts): Suppress ts errors on Editor.tsx #11275

Conversation

pinakipb2 commented Aug 30, 2024

Checklist

coderabbitai bot commented Aug 30, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

jjoyce0510 commented Sep 20, 2024

jjoyce0510 Sep 20, 2024

Choose a reason for hiding this comment

pinakipb2 Sep 21, 2024

Choose a reason for hiding this comment

jjoyce0510 Sep 20, 2024

Choose a reason for hiding this comment

pinakipb2 Sep 23, 2024

Choose a reason for hiding this comment

pinakipb2 commented Sep 21, 2024

rtekal commented Sep 30, 2024

An alternative to usage of {} as a type.

pinakipb2 commented Oct 1, 2024

Checked the Type declaration files and found:

An alternative to usage of {} as a type.

coderabbitai bot commented Aug 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

An alternative to usage of `{}` as a type.