A zsh language definition for Ctags wrapped in `tags` Make target by psprint · Pull Request #332 · zdharma-continuum/zinit

psprint · 2022-07-07T02:17:00Z

Just run make tags (or more specific targets: tags-vim, tags-emacs) to
obtain a dictionary of all functions and variables.

This can be very handy, especially with a good editor. Features of Universal Ctags are very heavily utilized, although old Exuberant Ctags is also supported. I've created a Zsh language definition with use of pcre regexps, so be sure to compile this feature into universal ctags.

PS. UPDATE: A recipe to install universal ctags 🤣 zinit has the best support and delivery 😄:

zinit id-as null configure'#' make'install' \
        for universal-ctags/ctags

Update 2: Also a recipe for pcre2-8 which can be used with uni-ctags – easy dizzy – only changed the repo ID 😄:

zinit id-as null configure'#' make'install' \
          for PCRE2Project/pcre2

Update 3: Turns out that the regexes are compatible with regular {extended} regex engine that's almost certainly built with ctags, so no need for pcrer2 to utilize the 1700 symbols that this setup digs out from zinit sources 😆 .

Description

Motivation and Context

Related Issue(s)

Usage examples

How Has This Been Tested?

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

Run `make tags` (or more specific targets: tags-vim, tags-emacs) to obtain a dictionary of all functions and variables.

Universal Ctags – 1500…1700!

psprint · 2022-07-14T09:00:16Z

Here is a presentation of the tags usage in my mcedit fork neomcedit: https://asciinema.org/a/SuGXSc7U0Mx9dhHtcd0DEjRJg

There are 1700 symbols in the index 😄

Makefile

vladdoster · 2022-07-15T22:48:51Z

Makefile

+tags: tags-emacs tags-vim
+
+# Build only the Emacs-style `TAGS` file.
+tags-emacs:
+	@if type ctags >/dev/null 2>&1; then \
+		if ctags --version | grep >/dev/null 2>&1 "Universal Ctags"; then \
+			ctags -e -R --options=share/zsh.ctags --languages=zsh \
+			    --pattern-length-limit=250 --maxdepth=1; \
+		else \
+			ctags -e -R --languages=sh --langmap=sh:.zsh; \
+		fi; \
+		printf "Created the Emacs \`TAGS\` file.\\n"; \
+	else \
+	    printf 'Error: Please install a Ctags (e.g.: either the Exuberant or Universal %b' \
+	    'version) utility first.\n'; \
+	fi
+
+# Build only the Vim-style `tags` file.
+tags-vim:
+	@if type ctags >/dev/null 2>&1; then \
+		if ctags --version | grep >/dev/null 2>&1 "Universal Ctags"; then \
+			ctags -R --options=share/zsh.ctags --languages=zsh \
+			    --pattern-length-limit=250 --maxdepth=1; \
+		else \
+			ctags -R --languages=sh --langmap=sh:.zsh; \
+		fi; \
+		printf "Created the Vim's style \`tags\` file.\\n"; \
+	else \
+	    printf 'Error: Please install a Ctags (e.g.: either the Exuberant or Universal %b' \
+	    'version) utility first.\n'; \
+	fi
+


I feel this would be more appropriate under a zi sub-command.

zi tags (--all|--vim|--emacs)

This lets us utilize zi output formatting and doesn't clutter the Makefile.

this is a misuse of Make, IMHO

There already is tags target in the Makefile that tries to use etags command so I would tell that it's ok to use Makefile for this (hence the duplication probably). But I can change to zi if you want.

Ups, no previous tags target in existing Makefile – what I meant is that Automake projects have such targets (tags, ctags and other) created automatically for C,C++ and Fortran projects, see this page for details. is this a sufficient reassurance that Makefile is the correct place for ctags invocations?

@vladdoster: What do you think, should the zi subcommand be created, or can it be in Makefile?

psprint · 2022-07-20T23:43:32Z

@vladdoster: Check this out – a browsable/searchable TAGS popup-menu, allowing quick jumping to a specific function or variable definition: https://asciinema.org/a/4zNRsZo6saHDu2ImCC5Cziiqq
I've just added commit with the feature. Color flickers a little at startup, but the rest works fine.

psprint · 2022-09-08T15:42:03Z

I've now got time to work on the pr so I reopened it.

psprint · 2022-09-10T00:24:03Z

I've solved the incorrect highlighting, everything works OK (see a cast: https://asciinema.org/a/JaVB2yqHn8RC7nalwYXQu0L1B).

I wonder if such feature, making zinit a part of programmers' stack, have chance of merging? That's the obstacle – do we want to add a subtle, general programming appearance to zinit?

psprint · 2022-09-17T13:28:30Z

Hi guys @vladdoster @pschmitt @alichtman.
I would like to give some motion to this PR. I think that it's interesting to try to give zinit some software engineering rite. With these changes zinit becomes an additional, fairly unexpected tool in dev stack – ability to jump open a symbol right from the command line… What is your opinion?

Here is current state of it: https://asciinema.org/a/4WPnH3shbu7tQoVehpCVNAwid

psprint · 2022-09-18T14:39:15Z

A new sub-feature: ability to switch to a function-only kind listing of the symbols, see: https://asciinema.org/a/Zffgvk1yEevU5GhRzXp8Ig6fg

…OR on enter It's possible to jump directly from the shell to a specific function or variable definition, for example. TAGS from current $PWD is being read. It can hold any symbols for any programming language supported by Exuberant Ctags or Universal Ctags (recommended).

psprint · 2022-09-19T09:38:07Z

@vladdoster, @pschmitt, @alichtman, @jankatins Check this out – a basic synatx highlighting in the symbol popup menu: https://asciinema.org/a/4lG1v1wYMRG8wmA3GMtWZfewY

Does this PR have a chance of merging?

psprint · 2022-09-19T10:43:55Z

thanks! zinit is now also a software engineering aid tool :) I wonder if there are some other such features.

…harma-continuum#332)

github-actions · 2022-11-07T02:50:04Z

🎉 This PR is included in version 3.8.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

…harma-continuum#332)

psprint mentioned this pull request Jul 7, 2022

feat: append ${ZPFX}/lib/pkg-config to $PKG_CONFIG_PATH #333

Closed

7 tasks

psprint added 2 commits July 7, 2022 10:33

A zsh language definition for Ctags wrapped in tags Make target

29516db

Run `make tags` (or more specific targets: tags-vim, tags-emacs) to obtain a dictionary of all functions and variables.

Improve old ctags support. It only produces c.a. 50 symbols, while

1a3a631

Universal Ctags – 1500…1700!

psprint force-pushed the ctags-targets branch from c8eb3b1 to 1a3a631 Compare July 7, 2022 08:37

Recognize basic var=${…}/$(…)/$((…))/(…) in variable definitions

bacb830

vladdoster requested changes Jul 18, 2022

View reviewed changes

Remove duplicate .PHONY definitions

40ddba5

psprint requested review from alichtman and pschmitt as code owners July 20, 2022 06:43

github-actions bot added the zinit label Jul 20, 2022

psprint closed this Aug 13, 2022

psprint reopened this Sep 8, 2022

psprint force-pushed the ctags-targets branch 2 times, most recently from bc85b33 to d9e149c Compare September 10, 2022 07:44

psprint force-pushed the ctags-targets branch 2 times, most recently from 6b31d35 to 0354db0 Compare September 18, 2022 14:34

psprint force-pushed the ctags-targets branch from 0354db0 to abdd91e Compare September 19, 2022 09:18

psprint force-pushed the ctags-targets branch from abdd91e to 098442b Compare September 19, 2022 09:29

vladdoster merged commit 17fd453 into zdharma-continuum:main Sep 19, 2022

psprint added a commit to psprint/.priv-zinit-fork that referenced this pull request Sep 20, 2022

A zsh language definition for Ctags wrapped in tags Make target (zd…

b5d48a5

…harma-continuum#332)

github-actions bot added the released label Nov 7, 2022

psprint added a commit to psprint/.priv-zinit-fork that referenced this pull request Dec 30, 2022

A zsh language definition for Ctags wrapped in tags Make target (zd…

8b765af

…harma-continuum#332)

Conversation

psprint commented Jul 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

Related Issue(s)

Usage examples

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

psprint commented Jul 14, 2022

Uh oh!

Uh oh!

vladdoster Jul 15, 2022

Choose a reason for hiding this comment

Uh oh!

vladdoster Jul 15, 2022

Choose a reason for hiding this comment

Uh oh!

psprint Jul 18, 2022

Choose a reason for hiding this comment

Uh oh!

psprint Jul 20, 2022

Choose a reason for hiding this comment

Uh oh!

psprint Sep 10, 2022

Choose a reason for hiding this comment

Uh oh!

psprint commented Jul 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

psprint commented Sep 8, 2022

Uh oh!

psprint commented Sep 10, 2022

Uh oh!

psprint commented Sep 17, 2022

Uh oh!

psprint commented Sep 18, 2022

Uh oh!

psprint commented Sep 19, 2022

Uh oh!

psprint commented Sep 19, 2022

Uh oh!

github-actions bot commented Nov 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

psprint commented Jul 7, 2022 •

edited

Loading

psprint commented Jul 20, 2022 •

edited

Loading