Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Restrict comments to 100 characters#4668

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
Tyriar merged 1 commit intoxtermjs:masterfromTyriar:comment_lint
Aug 12, 2023

Conversation

@Tyriar
Copy link
Member

This is a rule I try enforce in PR but it's a bit of a hassle, this will give a lint warning when it happens resulting in:

  • Yellow underline in supported editors when eslint is installed
  • Compilation will succeed since it's a warning not an error
  • CI will fail as it does not allow lint warnings

Special case comments are ignored which includes@vt comments, table comments and commented out code.

This is a rule I try enforce in PR but it's a bit of a hassle, this willgive a lint warning when it happens resulting in:- Yellow underline in supported editors when eslint is installed- Compilation will succeed since it's a warning not an error- CI will fail as it does not allow lint warningsSpecial case comments are ignored which includes@vt comments, tablecomments and commented out code.
@TyriarTyriar added this to the5.3.0 milestoneAug 12, 2023
@TyriarTyriar self-assigned thisAug 12, 2023
@TyriarTyriarenabled auto-mergeAugust 12, 2023 16:06
@TyriarTyriar merged commit519f6a3 intoxtermjs:masterAug 12, 2023
Tyriar added a commit to Tyriar/xterm.js that referenced this pull requestAug 12, 2023
Similar toxtermjs#4668, this brings linting to the API files with a cut downset of rules. One of the bigger ones is comment length is restricted to 80,this was done as opposed to 100 for regular code to reduce the chance ofwrapping or API going off screen regardless of resolution or window/browsersize
@TyriarTyriar mentioned this pull requestAug 12, 2023
@jerch
Copy link
Member

jerch commentedAug 12, 2023
edited
Loading

Hmm yeah the@vt docs clutter the source files to some degree, this is quite obvious when scrolling through inputhandler. Still I find the idea to have that close to source very important, otherwise docs tend to fall behind all the time (also happens to doc strings, but imho to a lesser degree than for completely separate docs).
At least for me the issue is not a biggy, as the display is big enough to still give the right amount of overview on the source, even with those nasty huge markup tables. I also dont know of any good way to shorten those.
Well, at least the@vt lines could be reshaped to store their info vertically instead of horizontally, but I am unsure, if that make anything better?

@Tyriar
Copy link
MemberAuthor

I like the@vt comments, no problems having them and the other exceptions be longer. I just want to automate some consistency so I don't have to call it out in PRs as much

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

Reviewers

No reviews

Assignees

@TyriarTyriar

Labels

None yet

Projects

None yet

Milestone

5.3.0

Development

Successfully merging this pull request may close these issues.

2 participants

@Tyriar@jerch

[8]ページ先頭

©2009-2025 Movatter.jp