Skip to content

Add iterm2-shell-integration #1733

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

Merged
merged 1 commit into from
Jun 5, 2023

Conversation

decayofmind
Copy link
Contributor

Description

Some time ago I created a Zsh plugin to install iterm2 utilities. Now the author of iTerm2 moved those utilities and shell integration to a dedicated repository, naturally making my plugin not needed anymore.

Type of changes

  • A link to an external resource like a blog post
  • Add/remove/update a link to a framework
  • Add/remove/update a link to a plugin
  • Add/remove/update a link to a tab completion
  • Add/remove/update a link to a theme
  • Text cleanups/typo fixes

Copyright Assignment

  • This document is covered by the BSD License, and I agree to contribute this PR under the terms of the license. This is for the list submission, not for the project(s) you're adding, I don't care what license the plugins have as long as they have something.

Checklist:

  • I have read the CONTRIBUTING document.
  • All new and existing tests passed.
  • I have confirmed that the link(s) in my PR is valid.
  • I have signed off my commits. You can use git commit --amend --no-edit --signoff to amend an existing commit, and you can find more details about signing off commits on the DCO GitHub action page here.
  • My entries are single lines and are in the appropriate (plugins, themes, or completions) section, and in alphabetical order in their section.
  • The completion/plugin/theme has a plugin file in the repository, it is not just bare instructions to be added to .zshrc
  • Any added completions have a readme and a license file in their repository.
  • Any added frameworks have a readme and a license file in their repository.
  • Any added plugins have a readme and a license file in their repository.
  • Any added themes have a screenshot, a readme, and a license file in their repository.
  • I have stripped any leading and/or trailing zsh-, zsh-plugin and/or oh-my-zsh- substrings from the link name. This makes it easier to find plugins/themes/completions by name by preventing big clusters in the O and Z sections of the list.

@unixorn
Copy link
Owner

unixorn commented Jun 3, 2023

I don't see a plugin file in the repo - without one, ZSH frameworks can't automatically load it.

Signed-off-by: decayofmind <[email protected]>
@decayofmind decayofmind force-pushed the add-iterm2-shell-integration branch from 3bf381e to 5c91fe3 Compare June 4, 2023 00:55
@decayofmind
Copy link
Contributor Author

@unixorn So, should I just remove my plugin without adding a replacement, right?

@unixorn
Copy link
Owner

unixorn commented Jun 4, 2023

I added a plugin.zsh file in gnachman/iTerm2-shell-integration#15

Once that's merged, ZSH frameworks will detect it and it will add the plugin's utilities directory to the user's $PATH automatically.

@decayofmind
Copy link
Contributor Author

Amazing work @unixorn !

One small thing - It's not only binaries but also some helper functions to source under shell_integration/zsh, so the plugin file in PR needs one more line to add:

source "${0:h}/shell_integration/zsh"

Copy link
Owner

@unixorn unixorn left a comment

Choose a reason for hiding this comment

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

lgtm

@unixorn
Copy link
Owner

unixorn commented Jun 5, 2023

Going to go ahead and merge this. If gnachman/iTerm2-shell-integration#15 doesn't get closed in a reasonable amount of time, it might be worth updating your old plugin to load https://github.com/gnachman/iTerm2-shell-integration as a submodule and then its plugin file could add the utilities to $PATH and source the helper functions.

@unixorn unixorn merged commit 0722f4e into unixorn:main Jun 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants