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.

Sign up for GitHub

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

Jump to bottom

[Feature]: eslint markdown, json #1295

Open
manudeli opened this issue Oct 7, 2024 · 3 comments
Open

[Feature]: eslint markdown, json #1295

manudeli opened this issue Oct 7, 2024 · 3 comments
Assignees
@kangju2000

Comments

@manudeli
Copy link
Member

manudeli commented Oct 7, 2024

Package Scope

etc

Description

Lint!

Possible Solution

No response

etc.

No response
@coauthors Coauthors
Copy link

coauthors bot commented Oct 7, 2024 •
edited
Loading

People can be co-author:

Candidate Reasons Count Add this as commit message
@manudeli #1295 (comment) #1295 2 Co-authored-by: manudeli <[email protected]>
@kangju2000 #1295 (comment) 1 Co-authored-by: kangju2000 <[email protected]>

@kangju2000
Copy link
Collaborator

I believe applying @eslint/markdown could help us write code blocks more consistently. Would it be okay if I take a look into this?

@manudeli
Copy link
Member Author

I believe applying @eslint/markdown could help us write code blocks more consistently. Would it be okay if I take a look into this?

Sure!

@kangju2000 kangju2000 mentioned this issue Oct 11, 2024
Merged
1 task
manudeli added a commit that referenced this issue Oct 12, 2024
@kangju2000 @manudeli
@SEOKKAMONI @gwansikk
chore: Add ESLint support for MDX files (#1307)
e7dd6ba 
# Overview

<!--
    A clear and concise description of what this pr is about.
 -->

related to #1295

I have implemented ESLint linting for MDX files in this project.

### Changes

- Integrate `eslint-plugin-mdx` to enable linting for MDX files
- Apply Prettier rules and JavaScript rules to code blocks within MDX
files
- Update existing MDX files to comply with the new linting rules

This enhancement will improve code consistency and readability across
our MDX documentation.

### Additional Notes

- While [mdx/remark
rules](https://github.com/mdx-js/eslint-mdx?tab=readme-ov-file#rules)
offer potential for more diverse rule sets, they are not implemented in
this PR. This could be explored in future iterations.

- `@eslint/markdown` is designed for `md` files. Since the majority of
Suspensive's documentation uses `MDX`, linting for md files was not
considered in this implementation.

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: Jonghyeon Ko <[email protected]>
Co-authored-by: 김석진(poki) <[email protected]>
Co-authored-by: Gwansik Kim <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kangju2000 kangju2000

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kangju2000 @manudeli