[PATCH v2] ls-files: aligin format atoms wtih ls-tree

From: ZheNing Hu <adlternative@gmail.com>

"git ls-files --format" can be used to format the output of multiple file entries in the index, while "git ls-tree --format" can be used to format the contents of a tree object. However, the current set of %(objecttype), "(objectsize)", and "%(objectsize:padded)" atoms supported by "git ls-files --format" is a subset of what is available in "git ls-tree --format".

Users sometimes need to establish a unified view between the index and tree, which can help with comparison or conversion between the two.

Therefore, this patch adds the missing atoms to "git ls-files --format". "%(objecttype)" can be used to retrieve the object type corresponding to a file in the index, "(objectsize)" can be used to retrieve the object size corresponding to a file in the index, and "%(objectsize:padded)" is the same as "(objectsize)", except with padded format.

Signed-off-by: ZheNing Hu <adlternative@gmail.com>
---
    ls-files: align format atoms with git ls-tree
    
    Users sometimes want all format atoms of git ls-files --format to be
    compatible with the format atoms of git ls-tree --format [1]. However,
    git ls-files --format lacks the %(objecttype) and %(objectsize),
    %(objectsize:padded) atoms compared to git ls-tree --format, causing
    incompatibility. Therefore, these atoms are added to the --format of git
    ls-files to resolve the issue of incompatibility.
    
    %(objecttype): get the object type of the file which is recorded in the
    index. %(objectsize): get the object size of the file which is recorded
    in the index, ("-" if the object is a commit or tree).
    %(objectsize:padded): same as %(objectsize), but with a padded format.
    
    v1: add %(objecttype) and %(objectsize) atos to git ls-files --format.
    v2:
    
     1. squash two commit into one.
     2. rewrite commit messages.
    
    [1]:
    https://lore.kernel.org/git/21183ea9-84e2-fd89-eb9b-419556680c07@gnieh.org/T/#u

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1533%2Fadlternative%2Fzh%2Fls-files-formats-expand-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1533/adlternative/zh/ls-files-formats-expand-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1533

Range-diff vs v1:

 1:  3f8884457d3 < -:  ----------- ls-files: add %(objecttype) atom to format option
 2:  95f1d714081 ! 1:  a99618c6048 ls-files: add %(objectsize) atom to format option
     @@ Metadata
      Author: ZheNing Hu <adlternative@gmail.com>
      
       ## Commit message ##
     -    ls-files: add %(objectsize) atom to format option
     +    ls-files: aligin format atoms wtih ls-tree
      
     -    Sometimes users may want to align the feature of
     -    `git ls-files --format` with that of `git ls-tree --format`,
     -    but the %(objectsize) and %(objectsize:padded) are missing
     -    in the format option of git ls-files compared to git ls-tree.
     +    "git ls-files --format" can be used to format the output of
     +    multiple file entries in the index, while "git ls-tree --format"
     +    can be used to format the contents of a tree object. However,
     +    the current set of %(objecttype), "(objectsize)", and
     +    "%(objectsize:padded)" atoms supported by "git ls-files --format"
     +    is a subset of what is available in "git ls-tree --format".
      
     -    Therefore, the %(objecttsize) atom is added to the format
     -    option of git ls-files, which can be used to obtain the
     -    object size of the file which is recorded in the index.
     -    ("-" if the object is a `commit` or `tree`) It also
     -    supports a padded format of size with %(objectsize:padded).
     +    Users sometimes need to establish a unified view between the index
     +    and tree, which can help with comparison or conversion between the two.
     +
     +    Therefore, this patch adds the missing atoms to "git ls-files --format".
     +    "%(objecttype)" can be used to retrieve the object type corresponding
     +    to a file in the index, "(objectsize)" can be used to retrieve the
     +    object size corresponding to a file in the index, and "%(objectsize:padded)"
     +    is the same as "(objectsize)", except with padded format.
      
          Signed-off-by: ZheNing Hu <adlternative@gmail.com>
      
       ## Documentation/git-ls-files.txt ##
     -@@ Documentation/git-ls-files.txt: objecttype::
     - 	The object type of the file which is recorded in the index.
     +@@ Documentation/git-ls-files.txt: interpolated.  The following "fieldname" are understood:
     + 
     + objectmode::
     + 	The mode of the file which is recorded in the index.
     ++objecttype::
     ++	The object type of the file which is recorded in the index.
       objectname::
       	The name of the file which is recorded in the index.
      +objectsize[:padded]::
     @@ builtin/ls-files.c: static void show_submodule(struct repository *superproject,
       	const char *pathname;
       	struct index_state *istate;
      @@ builtin/ls-files.c: static size_t expand_show_index(struct strbuf *sb, const char *start,
     + 		strbuf_addf(sb, "%06o", data->ce->ce_mode);
     + 	else if (skip_prefix(start, "(objectname)", &p))
       		strbuf_add_unique_abbrev(sb, &data->ce->oid, abbrev);
     - 	else if (skip_prefix(start, "(objecttype)", &p))
     - 		strbuf_addstr(sb, type_name(object_type(data->ce->ce_mode)));
     ++	else if (skip_prefix(start, "(objecttype)", &p))
     ++		strbuf_addstr(sb, type_name(object_type(data->ce->ce_mode)));
      +	else if (skip_prefix(start, "(objectsize:padded)", &p))
      +		expand_objectsize(sb, &data->ce->oid, object_type(data->ce->ce_mode), 1);
      +	else if (skip_prefix(start, "(objectsize)", &p))
     @@ builtin/ls-files.c: static size_t expand_show_index(struct strbuf *sb, const cha
       	else if (skip_prefix(start, "(eolinfo:index)", &p))
      
       ## t/t3013-ls-files-format.sh ##
     -@@ t/t3013-ls-files-format.sh: test_expect_success 'git ls-files --format objecttype' '
     +@@ t/t3013-ls-files-format.sh: test_expect_success 'git ls-files --format objectname v.s. -s' '
       	test_cmp expect actual
       '
       
     ++test_expect_success 'git ls-files --format objecttype' '
     ++	git ls-files --format="%(objectname)" o1.txt o4.txt o6.txt >objectname &&
     ++	git cat-file --batch-check="%(objecttype)" >expect <objectname &&
     ++	git ls-files --format="%(objecttype)" o1.txt o4.txt o6.txt >actual &&
     ++	test_cmp expect actual
     ++'
     ++
      +test_expect_success 'git ls-files --format objectsize' '
      +	cat>expect <<-\EOF &&
      +26

 Documentation/git-ls-files.txt |  6 ++++++
 builtin/ls-files.c             | 27 ++++++++++++++++++++++++++
 t/t3013-ls-files-format.sh     | 35 ++++++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+)