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

userdiff: add userdiff patterns for ts files (TypeScript) #859

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yehee
Copy link

@yehee yehee commented Oct 2, 2020

TypeScript is an open-source language which builds on JavaScript, one of the world's most used tools, by adding static type definitions. In participating this year's Open Source Day hosted as part of the virtual Grace Hopper Conference, the proposed changes aim to address this issue of adding diff chunk header lines to Git for .ts file extension.

The regex patterns match both traditional/arrow function expressions:

const add = (a, b) => a + b
public function add() { ...

Signed-off-by: Alice Kim aliceykim0828@gmail.com

@gitgitgadget-git
Copy link

Welcome to GitGitGadget

Hi @yehee, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that your Pull Request has a good description, as it will be used as cover letter.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the FreeNode IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Freenode. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@gitgitgadget-git
Copy link

There is an issue in commit 2ffe9a5:
Commit checks stopped - the message is too short

@gitgitgadget-git
Copy link

There is an issue in commit a282ef5:
Commit checks stopped - the message is too short

@yehee yehee changed the title userdiff: add patterns for ts files userdiff: add userdiff patterns for ts files (TypeScript) Oct 2, 2020
@dscho
Copy link
Member

dscho commented Oct 2, 2020

/allow

@gitgitgadget-git
Copy link

User yehee is now allowed to use GitGitGadget.

@dscho
Copy link
Member

dscho commented Oct 2, 2020

@yehee Welcome to the Git community! And thank you for your contribution. A quick note:

Commit checks stopped - the message is too short

Please amend the commit and elaborate on the change in the commit message. I would recommend following the example of 75c3b6b for inspiration: the problem to solve (Typescript is not yet supported), some background (link to the Typescript home page, describe that it is a superset of Javascript that allows for static type checking), and finally explain what Typescript constructs your patch supports (and what it was modeled after) and even more importantly what it does not cover.

Finally, the commit message needs to end in a Signed-off-by: line matching your author information.

@jopdE6vovgedsahzux

This comment has been minimized.

@michaelblyons
Copy link

@yehee Are you willing to make the changes requested above?

Copy link

@dougpagani dougpagani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regex correction.

@@ -174,6 +174,8 @@ PATTERNS("bibtex", "(@[a-zA-Z]{1,}[ \t]*\\{{0,1}[ \t]*[^ \t\"@',\\#}{~%]*).*$",
"[={}\"]|[^={}\" \t]+"),
PATTERNS("tex", "^(\\\\((sub)*section|chapter|part)\\*{0,1}\\{.*)$",
"\\\\[a-zA-Z@]+|\\\\.|[a-zA-Z0-9\x80-\xff]+"),
PATTERNS("ts", "^[\t ]*(constructor|public|private|protected).*$",
"^[\t ]*(const|let|var)[^()]*=[\t ]*\\([^()]*\\)[\t ]*=>*$"),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like you intended >.* because otherwise this is saying: "accept any number of > characters"

If you accept this suggestion it will say: "accept rest of line", which will pull in the EOL-context for the hunk-header.

Suggested change
"^[\t ]*(const|let|var)[^()]*=[\t ]*\\([^()]*\\)[\t ]*=>*$"),
"^[\t ]*(const|let|var)[^()]*=[\t ]*\\([^()]*\\)[\t ]*=>.*$"),

@dscho
Copy link
Member

dscho commented May 16, 2022

@yehee is it possible that you became too busy and need to abandon this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants