git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/1] userdiff: extend Bash pattern to cover more shell function forms

From
Junio C Hamano <gitster@pobox.com>
Date
Feb 18, 2025, 19:30 UTC
Message-ID
<xmqqy0y3jbjk.fsf@gitster.g>
In-Reply-To
<20250218153537.16320-2-dhar61595@gmail.com>
Moumita <dhar61595@gmail.com> writes:
>  PATTERNS("bash",
> -	 /* Optional leading indentation */
> +     /* Optional leading indentation */
What is this change about?
Show 9 quoted lines
>  	 "^[ \t]*"
> -	 /* Start of captured text */
> +	 /* Start of captured function name */
>  	 "("
>  	 "("
> -	     /* POSIX identifier with mandatory parentheses */
> -	     "[a-zA-Z_][a-zA-Z0-9_]*[ \t]*\\([ \t]*\\))"
> +		 /* POSIX identifier with mandatory parentheses (allow spaces inside) */
> +		 "[a-zA-Z_][a-zA-Z0-9_]*[ \t]*\\([ \t]*\\)"
Is indentation-change intended and required for this patch to work correctly?
Show 5 quoted lines
>  	 "|"
> -	     /* Bashism identifier with optional parentheses */
> -	     "(function[ \t]+[a-zA-Z_][a-zA-Z0-9_]*(([ \t]*\\([ \t]*\\))|([ \t]+))"
> +		 /* Bash-style function definitions, allowing optional `function` keyword */
> +		 "(?:function[ \t]+(?=[a-zA-Z_]))?[a-zA-Z_][a-zA-Z0-9_]*(([ \t]*\\([ \t]*\\))|([ \t]+))?"
Ditto.

Regular expressions are write-only language; please make sure that you do not add any unnecessary changes to distract eyes of reviewers from spotting the _real_ changes that improves the current codebase.

Show 10 quoted lines
>  	 ")"
>  	 /* Optional whitespace */
>  	 "[ \t]*"
> -	 /* Compound command starting with `{`, `(`, `((` or `[[` */
> -	 "(\\{|\\(\\(?|\\[\\[)"
> -	 /* End of captured text */
> +	 /* Allow function body to start with `{`, `(` (subshell), `[[` */
> +	 "(\\{|\\(|\\[\\[)"
> +	 /* End of captured function name */
>  	 ")",
>  	 /* -- */
> -	 /* Characters not in the default $IFS value */
> -	 "[^ \t]+"),

We used to pretty-much use "a run of non-whitespace characters is a token". Now we are a bit more picky.

Which may or may not be good, but it is hard to tell if it is an improvement.

Show 14 quoted lines
> +	 /* Identifiers: variable and function names */
> +	 "[a-zA-Z_][a-zA-Z0-9_]*"
> +	 /* Numeric constants: integers and decimals */
> +	 "|[-+]?[0-9]+(\\.[0-9]*)?|[-+]?\\.[0-9]+"
> +	 /* Shell variables: `$VAR`, `${VAR}` */
> +	 "|\\$[a-zA-Z_][a-zA-Z0-9_]*|\\$\\{[^}]+\\}"
> +	 /* Logical and comparison operators */
> +	 "|\\|\\||&&|<<|>>|==|!=|<=|>="
> +	 /* Assignment and arithmetic operators */
> +	 "|[-+*/%&|^!=<>]=?"
> +	 /* Command-line options (to avoid splitting `-option`) */
> +	 "|--?[a-zA-Z0-9_-]+"
> +	 /* Brackets and grouping symbols */
> +	 "|\\(|\\)|\\{|\\}|\\[|\\]"),

The fact that this patch does not have any changes to "t/" hierarchy suggests me that we do not have existing tests to see how sample text files in the supported languages are tokenized (otherwise the above changes would require adjusting such existing tests), so I think it should be left outside of this topic, but I wonder if adding such tests gives us a good way to demonstrate the effect of these changes to userdiff patterns.

Thanks.
Previous: MoumitaNext: Johannes Sixt
Message 6 of 37 in “[GSOC 2025] [Newbie] userdiff: add built-in pattern for shell scripts”
  1. 0/1 [GSOC 2025] [Newbie] userdiff: add built-in pattern for shell scriptsMoumita, Feb 11, 2025
  2. 1/1 Added built in function recognition for shellMoumita, Feb 11, 2025
  3. Johannes SixtFeb 15, 2025
  4. 0/1 [PATCH v2 0/1] [GSOC 2025] [Newbie] userdiff: add built-in pattern for shell scriptsMoumita, Feb 18, 2025
  5. 1/1 userdiff: extend Bash pattern to cover more shell function formsMoumita, Feb 18, 2025
  6. Junio C HamanoFeb 18, 2025
  7. Johannes SixtFeb 22, 2025
  8. Junio C HamanoFeb 24, 2025
  9. Junio C HamanoFeb 18, 2025
  10. Johannes SixtFeb 22, 2025
  11. Eric SunshineFeb 18, 2025
  12. 0/1 userdiff: improve Bash function and word regex patternsMoumita, Mar 28, 2025
  13. 1/1 userdiff: extend Bash pattern to cover more shell function formsMoumita, Mar 28, 2025
  14. Junio C HamanoMar 29, 2025
  15. MOUMITA DHARMar 30, 2025
  16. 0/1 [GSOC] userdiff:Added newlines at the end of the test casesMoumita, Mar 30, 2025
  17. 1/1 [GSOC] userdiff: extend Bash pattern to cover more shell function formsMoumita, Mar 30, 2025
  18. Junio C HamanoMay 2, 2025
  19. Johannes SixtMay 6, 2025
  20. MOUMITA DHARMay 10, 2025
  21. Johannes SixtMay 10, 2025
  22. 0/1 Added the closing ")" to make sure is not unbalanced and corrected the tests for word diffMoumita, May 11, 2025
  23. 1/1 userdiff: extend Bash pattern to cover more shell function formsMoumita, May 11, 2025
  24. Moumita, May 11, 2025
  25. Moumita, May 11, 2025
  26. Moumita, May 11, 2025
  27. 0/1 Added the newline after the test in t/4018Moumita, May 11, 2025
  28. 1/1 userdiff: extend Bash pattern to cover more shell function formsMoumita, May 11, 2025
  29. Junio C HamanoMay 13, 2025
  30. MOUMITA DHARMay 14, 2025
  31. Johannes SixtMay 16, 2025
  32. Junio C HamanoMay 17, 2025
  33. Johannes SixtMay 18, 2025
  34. 0/1 Updated the word diff regex for Bash scriptsMoumita, May 16, 2025
  35. 1/1 userdiff: extend Bash pattern to cover more shell function formsMoumita, May 16, 2025
  36. Johannes SixtMay 16, 2025
  37. Junio C HamanoMay 16, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.