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.

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

Add Remark config #3318

Merged
merged 5 commits into from
Mar 17, 2020
Merged

Add Remark config #3318

merged 5 commits into from
Mar 17, 2020

Conversation

MegaApplePi
Copy link
Contributor

@MegaApplePi MegaApplePi commented Mar 16, 2020

part of #3310

After looking at Codacy's patterns page, some options don't even prompt what exactly we want to use (e.g. using ATX headings, not Setext (it might actually be confusing itself with the frontmatter/YAML stuff)). This should also enable the frontmatter plugin which should allow it to check for YAML and ignore it whatever's in it.

Things to do:

  • Check if codacy actually uses the YAML plugin
    • it looks like it does
  • Make some more adjustments to the config file ... the docs was giving me a headache.

@MegaApplePi MegaApplePi added the area:meta non-article files label Mar 16, 2020
.remarkrc Outdated Show resolved Hide resolved
.remarkrc Outdated Show resolved Hide resolved
.remarkrc Outdated Show resolved Hide resolved
@MegaApplePi
Copy link
Contributor Author

MegaApplePi commented Mar 17, 2020

Some random things I found while looking through:


emphasis-marker might not work as intended. strong-marker has a similar issue as well.

| [\_WWWWWW_WWWWWW_](https://osu.ppy.sh/users/1981781)   | Portuguese, Spanish, Japanese|

It's warning that this line should be using * for emphasis, maybe all of the underscores need to be escaped?


list-item-spacing might not be working as intended.

- Item 1
  - Item 2
- Item 3

It is warning that there should be an empty space after item 2.


no-missing-blank-lines warns if an HTML comment don't have have a blank line in-between itself and something else. Probably not an issue, just pointing it out.


The NSC has a rule regarding filenames, but it looks like some of them have been ignored. Not sure what to set no-file-name-irregular-characters to or if we should disable it. (setting it to \\.a-zA-Z0-9-_! for now)


code-block-style might get confused with HTML indenting with 4 spaces.


some no-blockquote-without-marker warnings may actually be lists/paragraphs missing an empty space before the blockquote (they are not supposed to be part of the blockquote)


no-literal-urls appears to give false positives. Not exactly sure what causes it, but I think other symbols inside the link syntax causes this or emphasizing.

@MegaApplePi MegaApplePi marked this pull request as ready for review March 17, 2020 04:16
@peppy
Copy link
Member

peppy commented Mar 17, 2020

Thanks for this! Let's merge as-is and see how it adjusts inspections (we can make further changes post-merge).

@peppy peppy merged commit 1d7d01f into ppy:master Mar 17, 2020
@MegaApplePi MegaApplePi deleted the remark-config branch March 17, 2020 05:28
@peppy peppy mentioned this pull request Mar 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:meta non-article files size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants