refactor: eslint #1053

kellyjosephprice · 2025-02-04T19:14:02Z

	Fix RM-11916

🧰 Changes

Gets eslint working in the repo again.

There's some code changes, but hopefully the behavior is the same. I've also moved test only docs from ./docs/ to ./__tests/fixtures/ to make it clearer.

TODO

There's still a ton of old tests that need to either be updated or removed.

🧬 QA & Testing

kellyjosephprice · 2025-02-12T19:26:22Z

__tests__/compilers.test.ts

-  it.skip('Variables', () => {
-    expect(mdx(mdast('<<variable:user>>'))).toMatchInlineSnapshot(`
-      "<<variable:user>>
-      "
-    `);
-  });
-
-  it.skip('Glossary Items', () => {
-    expect(mdx(mdast('<<glossary:owl>>'))).toMatchInlineSnapshot(`
-      "<<glossary:owl>>
-      "
-    `);
-  });
-


Obsolete syntax

kellyjosephprice · 2025-02-12T19:26:42Z

__tests__/compilers/break.test.js

@@ -1,17 +0,0 @@
-import { mdast, mdx } from '../..';
-
-describe.skip('break compiler', () => {


This node type doesn't exist anymore.

kellyjosephprice · 2025-02-12T19:28:02Z

__tests__/components/__snapshots__/index.test.ts.snap

@@ -10,4 +10,4 @@ exports[`Components > Embed 3`] = `"<div class="embed embed_hasImg"><a class="em

 exports[`Components > Embed 4`] = `"<div class="embed "><a class="embed-link" href="https://www.nytimes.com/2020/05/03/us/politics/george-w-bush-coronavirus-unity.html" rel="noopener noreferrer" target="_blank"><div class="embed-body"><small class="embed-provider">nytimes.com</small><div class="embed-title">rdmd</div></div></a></div>"`;

-exports[`Components > Image 1`] = `"<span aria-label="Expand image" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img src="https://files.readme.io/6f52e22-man-eating-pizza-and-making-an-ok-gesture.jpg" width="auto" height="auto" title="Pizza Face" class="img  " alt="Bro eats pizza and makes an OK gesture." loading="lazy"></span></span>"`;
+exports[`Components > Image 1`] = `"<span aria-label="Expand image" class="img lightbox closed" role="button" tabindex="0"><span class="lightbox-inner"><img alt="Bro eats pizza and makes an OK gesture." class="img  " height="auto" loading="lazy" src="https://files.readme.io/6f52e22-man-eating-pizza-and-making-an-ok-gesture.jpg" title="Pizza Face" width="auto"></span></span>"`;


The attributes are sorted now.

kellyjosephprice · 2025-02-12T19:28:50Z

__tests__/helpers.ts

-      spy = vi.spyOn(console, prop).mockImplementation(impl);
+      spy = vi.spyOn(console, prop);
+      // @ts-expect-error - spy is a spy
+      spy.mockImplementation(impl);


I'm not sure what's going on here with the types.

It's partially because of the undefined type on spy and also because the spyOn is being done in a try-catch. This diff will fix it up.

diff --git a/__tests__/helpers.ts b/__tests__/helpers.ts index 71fdd9f8..0fa9507d 100644 --- a/__tests__/helpers.ts +++ b/__tests__/helpers.ts @@ -1,3 +1,5 @@ +import type { MockInstance } from 'vitest'; + import * as rdmd from '@readme/markdown-legacy'; import { vi } from 'vitest'; @@ -7,13 +9,10 @@ import { run, compile, migrate as baseMigrate } from '../index'; export const silenceConsole = (prop: keyof Console = 'error', impl = () => {}) => fn => { - let spy: ReturnType<typeof vi.spyOn> | undefined; + const spy: MockInstance = vi.spyOn(console, prop); try { - spy = vi.spyOn(console, prop); - // @ts-expect-error - spy is a spy spy.mockImplementation(impl); - return fn(spy); } finally { spy?.mockRestore(); ``

kellyjosephprice · 2025-02-12T19:29:25Z

__tests__/index.test.js

@@ -210,52 +210,6 @@ test.skip('should render nothing if nothing passed in', () => {
  expect(_html('')).toBeNull();
 });

-test.skip('`correctnewlines` option', () => {


These options aren't used any more.

kellyjosephprice · 2025-02-12T19:30:49Z

__tests__/migration/html-blocks.test.ts

@@ -31,7 +31,7 @@ describe('migrating html blocks', () => {
    const mdx = migrate(md);
    expect(mdx).toMatchInlineSnapshot(`
      "<HTMLBlock>{\`
-      <a href="example.com">${'\\`example.com\\`'}</a>


Nested levels of string parsing twists my brain.

erunion · 2025-02-14T00:30:46Z

__tests__/helpers.ts

-      spy = vi.spyOn(console, prop).mockImplementation(impl);
+      spy = vi.spyOn(console, prop);
+      // @ts-expect-error - spy is a spy
+      spy.mockImplementation(impl);


It's partially because of the undefined type on spy and also because the spyOn is being done in a try-catch. This diff will fix it up.

diff --git a/__tests__/helpers.ts b/__tests__/helpers.ts index 71fdd9f8..0fa9507d 100644 --- a/__tests__/helpers.ts +++ b/__tests__/helpers.ts @@ -1,3 +1,5 @@ +import type { MockInstance } from 'vitest'; + import * as rdmd from '@readme/markdown-legacy'; import { vi } from 'vitest'; @@ -7,13 +9,10 @@ import { run, compile, migrate as baseMigrate } from '../index'; export const silenceConsole = (prop: keyof Console = 'error', impl = () => {}) => fn => { - let spy: ReturnType<typeof vi.spyOn> | undefined; + const spy: MockInstance = vi.spyOn(console, prop); try { - spy = vi.spyOn(console, prop); - // @ts-expect-error - spy is a spy spy.mockImplementation(impl); - return fn(spy); } finally { spy?.mockRestore(); ``

erunion · 2025-02-14T00:41:50Z

__tests__/lib/hast.test.ts

+    // @ts-expect-error - the custom matcher types are not being set up
+    // correctly


This appears to be happening because the expect here is coming from @types/jest and the custom matcher is being set up on the expect that Vitest offers. We can clean this up when we excise Jest from this after moving puppeteer tests over to Vitest browser testing.

erunion · 2025-02-14T00:42:59Z

example/Doc.tsx

        const code = await mdx.compile(doc, { ...opts, components: componentsByExport, useTailwind: true });
        const content = await mdx.run(code, { components: executedComponents, terms, variables });

        setError(() => null);
        setContent(() => content);
      } catch (e) {
+        // eslint-disable-next-line no-console
        console.error(e);


would love if the markdown library had a pluggable logging system

What are you imagining?

## Version 8.3.0 ### ✨ New & Improved * eslint ([#1053](#1053)) ([e93a1f6](e93a1f6)) ### 🛠 Fixes & Updates * pass through props ([#1057](#1057)) ([613ae3c](613ae3c))

rafegoldberg · 2025-02-18T21:27:19Z

This PR was released!

🚀 Changes included in v8.3.0

kellyjosephprice added 9 commits February 4, 2025 09:57

test: move files around + ts

96a7d5e

chore: get eslint working

d4f96c1

chore: list explicit deps

96d2926

chore: more lint

3872c11

Merge branch 'next' into refactor/docs-and-tests

c62dbfd

chore: lint

ab8e86c

fix: wip

62e719e

test: wip

bae36ce

tests: fix more

45646ae

kellyjosephprice commented Feb 12, 2025

View reviewed changes

chore: remove focus test

40ea34d

kellyjosephprice commented Feb 12, 2025

View reviewed changes

kellyjosephprice changed the title ~~refactor: docs and tests~~ refactor: eslint Feb 12, 2025

kellyjosephprice added 6 commits February 12, 2025 11:47

Merge branch 'next' into refactor/docs-and-tests

f2ee891

fix: migrate

714807c

chore: lint

3b5b22c

chore: types

2ee1375

test: fixtures

6215e9b

fix: type

030cc59

kellyjosephprice requested review from erunion, rafegoldberg and davinhazard February 13, 2025 23:59

kellyjosephprice marked this pull request as ready for review February 13, 2025 23:59

erunion approved these changes Feb 14, 2025

View reviewed changes

kellyjosephprice added 2 commits February 14, 2025 09:21

chore: lint review

041b116

Merge branch 'next' into refactor/docs-and-tests

96fc71c

kellyjosephprice added 2 commits February 14, 2025 10:16

fix: update type

2e045f3

chore: more types

3221ad7

kellyjosephprice merged commit e93a1f6 into next Feb 14, 2025
14 checks passed

kellyjosephprice deleted the refactor/docs-and-tests branch February 14, 2025 18:43

rafegoldberg added the released label Feb 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: eslint #1053

refactor: eslint #1053

kellyjosephprice commented Feb 4, 2025 •

edited

Loading

kellyjosephprice Feb 12, 2025

kellyjosephprice Feb 12, 2025

kellyjosephprice Feb 12, 2025

kellyjosephprice Feb 12, 2025

erunion Feb 14, 2025

kellyjosephprice Feb 12, 2025

kellyjosephprice Feb 12, 2025 •

edited

Loading

erunion Feb 14, 2025

erunion Feb 14, 2025

erunion Feb 14, 2025

kellyjosephprice Feb 14, 2025

rafegoldberg commented Feb 18, 2025

		@@ -1,17 +0,0 @@
		import { mdast, mdx } from '../..';

		describe.skip('break compiler', () => {

		// @ts-expect-error - the custom matcher types are not being set up
		// correctly

refactor: eslint #1053

refactor: eslint #1053

Conversation

kellyjosephprice commented Feb 4, 2025 • edited Loading

🧰 Changes

TODO

🧬 QA & Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kellyjosephprice Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafegoldberg commented Feb 18, 2025

This PR was released!

kellyjosephprice commented Feb 4, 2025 •

edited

Loading

kellyjosephprice Feb 12, 2025 •

edited

Loading