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

builtin: implement, document and test url-parse #1715

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

builtin: implement, document and test url-parse #1715

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
42eb0cb
url: move helper function to URL header and source
matheusmoreira Apr 27, 2024
13b81b8
urlmatch: define url_parse function
matheusmoreira Apr 27, 2024
e4781b3
builtin: create url-parse command
matheusmoreira Apr 23, 2024
1e08956
url-parse: add URL parsing helper function
matheusmoreira Apr 27, 2024
0bf83ee
url-parse: enumerate possible URL components
matheusmoreira Apr 27, 2024
149c476
url-parse: define component extraction helper fn
matheusmoreira Apr 27, 2024
eb9ef8a
url-parse: define string to component converter fn
matheusmoreira Apr 27, 2024
a2acfdb
url-parse: define usage and options
matheusmoreira Apr 27, 2024
5de0032
url-parse: parse options given on the command line
matheusmoreira Apr 27, 2024
15d355a
url-parse: validate all given git URLs
matheusmoreira Apr 27, 2024
4e93509
url-parse: output URL components selected by user
matheusmoreira Apr 27, 2024
abda074
Documentation: describe the url-parse builtin
matheusmoreira Apr 27, 2024
33e1284
tests: add tests for the new url-parse builtin
matheusmoreira Apr 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Documentation: describe the url-parse builtin 
The new url-parse builtin validates git URLs
and optionally extracts their components.

Signed-off-by: Matheus Afonso Martins Moreira <matheus@matheusmoreira.com>
  • Loading branch information
@matheusmoreira
matheusmoreira committed Apr 28, 2024
commit abda074aeef2ffb20d2156b5f24f47745b6f3134
59 changes: 59 additions & 0 deletions Documentation/git-url-parse.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
git-url-parse(1)
Copy link

Choose a reason for hiding this comment

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

On the Git mailing list, Ghanshyam Thakkar wrote (reply to this):

On Sun, 28 Apr 2024, Matheus Afonso Martins Moreira via GitGitGadget <gitgitgadget@gmail.com> wrote:
> +* Print the path:
> ++
> +------------
> +$ git url-parse --component path https://example.com/user/repo
> +/usr/repo

s/usr/user/

Thanks.

================

NAME
----
git-url-parse - Parse and extract git URL components

SYNOPSIS
--------
[verse]
'git url-parse' [<options>] [--] <url>...

DESCRIPTION
-----------

Git supports many ways to specify URLs, some of them non-standard.
For example, git supports the scp style [user@]host:[path] format.
This command eases interoperability with git URLs by enabling the
parsing and extraction of the components of all git URLs.

OPTIONS
-------

-c <arg>::
--component <arg>::
Extract the `<arg>` component from the given git URLs.
`<arg>` can be one of:
`protocol`, `user`, `password`, `host`, `port`, `path`.

EXAMPLES
--------

* Print the host name:
+
------------
$ git url-parse --component host https://example.com/user/repo
example.com
------------

* Print the path:
+
------------
$ git url-parse --component path https://example.com/user/repo
/usr/repo
$ git url-parse --component path example.com:~user/repo
~user/repo
$ git url-parse --component path example.com:user/repo
/user/repo
------------

* Validate URLs without outputting anything:
+
------------
$ git url-parse https://example.com/user/repo example.com:~user/repo
------------

GIT
---
Part of the linkgit:git[1] suite