Compare commits
No commits in common. "master" and "v1.4.0" have entirely different histories.
42 changed files with 921 additions and 2441 deletions
25
.github/ISSUE_TEMPLATE.md
vendored
Normal file
25
.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
Please check the existing issues to make sure you're not duplicating a report.
|
||||
|
||||
For bug reports, please provide the following information:
|
||||
|
||||
In a terminal, run `zimfw info` and paste the output below:
|
||||
|
||||
```
|
||||
#Paste the output here
|
||||
```
|
||||
|
||||
- gist of .zimrc:
|
||||
- gist of .zshrc:
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
|
||||
Steps to reproduce
|
||||
------------------
|
||||
|
||||
|
||||
Images or other information
|
||||
---------------------------
|
||||
|
||||
|
||||
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
Please follow Zim's [code style guidelines](https://github.com/zimfw/zimfw/wiki/Code-Style-Guide).
|
||||
312
CHANGELOG.md
312
CHANGELOG.md
|
|
@ -7,283 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- Also output zimfw config and zimfw.zsh script paths in `info` action,
|
||||
following symlinks if any.
|
||||
- Don't output colors if `NO_COLOR` environment variable is set to a non-empty
|
||||
value.
|
||||
|
||||
## [1.15.1] - 2024-10-10
|
||||
|
||||
### Fixed
|
||||
|
||||
- Preserve original module if reinstall fails instead of removing it first.
|
||||
|
||||
## [1.15.0] - 2024-10-08
|
||||
|
||||
### Added
|
||||
|
||||
- `reinstall` action, that removes and then installs again the modules that
|
||||
failed any of the checks: (See [#542](https://github.com/zimfw/zimfw/issues/542))
|
||||
- module was installed with the defined tool,
|
||||
- module URL matches the defined one.
|
||||
- `--if-ostype` option to `zmodule`. This option is equivalent to
|
||||
`--if "[[ \${OSTYPE} == ${1} ]]"`.
|
||||
|
||||
### Changed
|
||||
|
||||
- Ask before uninstalling each unused module, instead of asking just once for
|
||||
all.
|
||||
- Add disclaimer comment at beginning of .zimrc file.
|
||||
|
||||
## [1.14.0] - 2024-06-25
|
||||
|
||||
### Changed
|
||||
|
||||
- Don't expand `${HOME}` in the init.zsh script. (See
|
||||
[#509](https://github.com/zimfw/zimfw/issues/509))
|
||||
- Don't allow calling `zmodule` from the command line. Let it fail with "command
|
||||
not found" instead, as it's intended to be used only in the .zimrc script.
|
||||
- `ZIM_HOME` must be defined before sourcing zimfw.zsh. All documentation was
|
||||
already doing so, hence not considering this as a breaking change.
|
||||
- Allow zimfw.zsh to exist anywhere else, not only inside `ZIM_HOME`. This
|
||||
enables installing the zimfw.zsh script independently with a package manager.
|
||||
- Don't try to upgrade if sourced zimfw.zsh is not in a writable path.
|
||||
- Don't try actions that write to `ZIM_HOME` if user has no write permissions
|
||||
there.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Update error messages to hopefully make it clearer when either the git or the
|
||||
degit tool is being used.
|
||||
- Set read permissions to generated init.zsh script, so it can be read from
|
||||
other users.
|
||||
|
||||
## [1.13.1] - 2024-04-28
|
||||
|
||||
### Fixed
|
||||
|
||||
- The `--strip` option in tar command is not BSD compatible.
|
||||
|
||||
## [1.13.0] - 2024-02-17
|
||||
|
||||
### Added
|
||||
|
||||
- `--if-command` option to `zmodule`. This option is equivalent to
|
||||
`--if "(( \${+commands[${1}]} ))"`.
|
||||
- `mkdir` tool option in `zmodule` that creates an empty directory. This allows
|
||||
creating modules that contain only externally generated files.
|
||||
|
||||
## [1.12.1] - 2023-09-16
|
||||
|
||||
### Fixed
|
||||
|
||||
- Expansion of prompt sequences in print statements causing text between
|
||||
backticks to be executed by the shell.
|
||||
|
||||
## [1.12.0] - 2023-07-17
|
||||
|
||||
### Added
|
||||
|
||||
- `check-version` action, that immediately checks if a new version of `zimfw` is
|
||||
available and returns code 4 if there is one.
|
||||
- `check` action, that checks if there are updates available for current modules.
|
||||
- Output of `LANG` and `LC_*` parameters in `info` action.
|
||||
|
||||
### Changed
|
||||
|
||||
- Don't resolve symlinks when building init.zsh.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Show warning when there's no write permission to compile Zsh scripts.
|
||||
|
||||
## [1.11.3] - 2023-02-26
|
||||
|
||||
### Deprecated
|
||||
|
||||
- `check-dumpfile` action. The [completion] module alone now handles
|
||||
checking the dumpfile. (See
|
||||
[zimfw/completion#12](https://github.com/zimfw/completion/pull/12))
|
||||
|
||||
## [1.11.2] - 2023-02-16
|
||||
|
||||
### Fixed
|
||||
|
||||
- Quote path names in init.zsh to properly handle path names with spaces.
|
||||
|
||||
## [1.11.1] - 2023-02-04
|
||||
|
||||
### Fixed
|
||||
|
||||
- Use `_zim_dumpfile_fpath` defined by the completion module
|
||||
[here](https://github.com/zimfw/completion/blob/33737e8c15fa8dba9af47bef8408b1af2599c21b/init.zsh#L11),
|
||||
right before `compinit` is run, to more accurately do `zimfw check-dumpfile`.
|
||||
|
||||
## [1.11.0] - 2022-12-18
|
||||
|
||||
### Added
|
||||
|
||||
- `--if` option to `zmodule` that will only initialize the module root if the
|
||||
specified test returns a zero exit status. The test is evaluated at every new
|
||||
terminal startup.
|
||||
- Ability to customize the .zimrc file name and path with the `ZIM_CONFIG_FILE`
|
||||
environment variable.
|
||||
|
||||
## [1.10.0] - 2022-09-27
|
||||
|
||||
### Added
|
||||
|
||||
- `--root` option to `zmodule`. Combined with the ability to call `zmodule`
|
||||
multiple times for the same module, this allows initializing from multiple
|
||||
roots in repositories like prezto or ohmyzsh. Also, `--on-pull` and `--disable`
|
||||
now work on a per-module-root basis.
|
||||
|
||||
### Changed
|
||||
|
||||
- Show `OSTYPE`, `TERM`, `TERM_PROGRAM` and `TERM_PROGRAM_VERSION` environment
|
||||
variables instead of calling the `uname -a` command to show system info in the
|
||||
`zimfw info` action.
|
||||
|
||||
## [1.9.1] - 2022-05-24
|
||||
|
||||
### Fixed
|
||||
|
||||
- Override repository options along multiple `zmodule` calls with the same
|
||||
module name.
|
||||
- Show already installed modules skipped with install action and `-v`.
|
||||
- Consider external module directory paths when calling compile action directly.
|
||||
- Ignore return value from `zargs` with `-P`.
|
||||
(See https://www.zsh.org/mla/workers/2022/msg00611.html)
|
||||
|
||||
## [1.9.0] - 2022-05-09
|
||||
|
||||
### Added
|
||||
|
||||
- `--on-pull` option to `zmodule`, which allows setting a command that is always
|
||||
triggered after the module is installed or updated.
|
||||
|
||||
## [1.8.0] - 2022-01-25
|
||||
|
||||
### Added
|
||||
|
||||
- `check-dumpfile` action. It runs in the build, install and update actions, and
|
||||
checks if a new completion configuration needs to be dumped. It's intended to
|
||||
be used with `compinit -C`, so no checks are done during the shell startup.
|
||||
(See [zimfw/completion#8](https://github.com/zimfw/completion/pull/8))
|
||||
- `--no-submodules` option to `zmodule`, which disables installing or updating
|
||||
git submodules.
|
||||
|
||||
## [1.7.0] - 2022-01-12
|
||||
|
||||
### Changed
|
||||
|
||||
- The output of `zimfw init` to be friendlier to the terminal startup screen
|
||||
when called without `-q`.
|
||||
- Only compile scripts via the `zimfw` tool after actions where scripts can
|
||||
change (build, install, update, upgrade).
|
||||
- Move compilation of the completion dumpfile to the completion module,
|
||||
[here](https://github.com/zimfw/completion/blob/9386a76eac3f55b1c04d57d26238f725b4b3ba25/init.zsh#L10-L11).
|
||||
- Don't compile user Zsh startup scripts anymore
|
||||
(See [#450](https://github.com/zimfw/zimfw/pull/450)). This means you can:
|
||||
- either manually delete the compiled files, as they won't be updated by zimfw
|
||||
anymore (recommended):
|
||||
```
|
||||
for zfile in ${ZDOTDIR:-${HOME}}/.z(shenv|profile|shrc|login|logout); do
|
||||
rm -f ${zfile}.zwc(|.old)(N)
|
||||
done
|
||||
```
|
||||
- or add the following to your .zlogin so Zsh startup scripts continue to be
|
||||
compiled:
|
||||
```diff
|
||||
+for zfile in ${ZDOTDIR:-${HOME}}/.z(shenv|profile|shrc|login|logout); do
|
||||
+ if [[ ! ${zfile}.zwc -nt ${zfile} ]] zcompile -R ${zfile}
|
||||
+done
|
||||
+unset zfile
|
||||
```
|
||||
|
||||
### Deprecated
|
||||
- The login_init.zsh script, which is now empty. This means you can safely
|
||||
remove the following line from your .zlogin:
|
||||
```diff
|
||||
-source ${ZIM_HOME}/login_init.zsh -q &!
|
||||
```
|
||||
|
||||
## [1.6.2] - 2021-11-21
|
||||
|
||||
### Fixed
|
||||
- Force local zsh emulation options, so the code is not broken by unexpected
|
||||
option changes by the user.
|
||||
|
||||
## [1.6.1] - 2021-11-08
|
||||
|
||||
### Fixed
|
||||
- Missing line break before showing git log when using the git tool to update.
|
||||
|
||||
## [1.6.0] - 2021-11-06
|
||||
|
||||
### Added
|
||||
- `list` action. Using it with `-v` also shows the current details for all
|
||||
modules.
|
||||
|
||||
### Changed
|
||||
- Be quieter and don't output warnings when `-q` is provided.
|
||||
- Be more verbose when `-v` is provided: show skipped external and frozen
|
||||
modules with the install and update actions.
|
||||
- Show warning instead of error when module was not installed with the tool
|
||||
currently in use.
|
||||
- Manually setting any `zmodule` initialization option will disable all the
|
||||
default values from the other initialization options, so only user-provided
|
||||
values are used in this case. I.e. it's either all automatic, or all manual.
|
||||
- Also install new modules when starting a new shell (via `zimfw init`, that
|
||||
is sourced in .zshrc).
|
||||
|
||||
### Fixed
|
||||
- Error in `zimfw update` with the `git` tool when module directory is under a
|
||||
symlinked directory.
|
||||
- Warning when `WARN_CREATE_GLOBAL` is set and `ZIM_HOME` is not.
|
||||
- "zsh: command not found: zmodule" when trying to run `zmodule` from the shell.
|
||||
Show a more informative error instead.
|
||||
- Don't try to install or update external modules.
|
||||
|
||||
## [1.5.0] - 2021-08-10
|
||||
|
||||
### Added
|
||||
- Option to use the new `degit` tool in `zmodule`, that is able to install and
|
||||
update modules from GitHub without requiring `git`. Modules are installed
|
||||
faster and take less disk space when using this tool. It can be set as the
|
||||
default with `zstyle ':zim:zmodule' use 'degit'`.
|
||||
|
||||
### Fixed
|
||||
- Force `core.autocrlf=false` when doing `git clone`.
|
||||
(See [#404](https://github.com/zimfw/zimfw/issues/404))
|
||||
- Allow uninstalling modules with custom names that have a slash.
|
||||
|
||||
|
||||
## [1.4.3] - 2021-03-19
|
||||
|
||||
### Fixed
|
||||
- Prefer the prezto module format when using defaults to initialize a module.
|
||||
This is the format we use in our Zim framework modules. It's not well
|
||||
documented anywhere officially, but in short words a prezto module can have:
|
||||
* a `functions` subdirectory that is added to the fpath by the framework,
|
||||
* files inside the `functions` subdirectory that are autoloaded by the
|
||||
framework (except for those with names matching `_*` or `prompt_*_setup`),
|
||||
* an `init.zsh` file that is sourced by the framework.
|
||||
|
||||
## [1.4.2] - 2021-02-19
|
||||
|
||||
### Fixed
|
||||
- "Not a valid ref: refs/remotes/origin/main" error in `zimfw update`, when the
|
||||
repository's default branch was renamed to main.
|
||||
|
||||
## [1.4.1] - 2021-02-17
|
||||
|
||||
### Fixed
|
||||
- Correctly get the repository's default branch in `zimfw update`. The related
|
||||
change in version 1.4.0 actually broke updating the modules, as new changes
|
||||
stopped being fetched.
|
||||
_No unreleased changes._
|
||||
|
||||
## [1.4.0] - 2021-01-07
|
||||
|
||||
|
|
@ -293,8 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
### Fixed
|
||||
- Show error when no parameter is provided to `-c|--cmd` in `zmodule`.
|
||||
- Use repository's default branch instead of hardcoding the default to `master`
|
||||
in `zimfw update`, when no branch is specified in `zmodule`.
|
||||
- Use repository's default branch instead of hardcoding the default to `master`,
|
||||
when no branch is specified in `zmodule`.
|
||||
|
||||
## [1.3.2] - 2020-08-01
|
||||
|
||||
|
|
@ -369,7 +93,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
This is a major change, where modules are not git submodules in the Zim repo
|
||||
anymore, but customized and installed separately as individual repositories.
|
||||
External modules can more easily be installed, updated and uninstalled. This
|
||||
makes Zim a project for Zsh that is both a set of community-maintained
|
||||
makes Zim the first project for Zsh that is both a set of community-maintained
|
||||
modules with a default installation (like on-my-zsh and prezto) and a plugin
|
||||
manager (like antigen and zplug).
|
||||
|
||||
|
|
@ -388,7 +112,7 @@ Take your time to review the updated [README.md] and the changes listed below.
|
|||
- The Zim "core" is reduced to a single file, namely zimfw.zsh, that is
|
||||
self-updated without requiring git. With this, `ZIM_HOME` is not (the root of)
|
||||
a git repo anymore.
|
||||
- Zsh and modules are initialized in .zshrc instead of .zimrc.
|
||||
- Zsh and modules are configured in .zshrc instead of .zimrc.
|
||||
- .zimrc is not sourced during Zsh startup anymore, and only contains the module
|
||||
definitions.
|
||||
- Zim's init.zsh and login_init.zsh scripts are generated by the `zimfw` CLI
|
||||
|
|
@ -419,7 +143,6 @@ Take your time to review the updated [README.md] and the changes listed below.
|
|||
- `ZIM_HOME` is set in .zshenv instead of .zshrc. The issue was that the
|
||||
variable was not available in .zlogin in non-interactive login shells.
|
||||
|
||||
[completion]: https://github.com/zimfw/completion
|
||||
[README.md]: https://github.com/zimfw/zimfw/blob/master/README.md
|
||||
[environment]: https://github.com/zimfw/environment
|
||||
[input]: https://github.com/zimfw/input
|
||||
|
|
@ -427,30 +150,7 @@ Take your time to review the updated [README.md] and the changes listed below.
|
|||
[termtitle]: https://github.com/zimfw/termtitle
|
||||
[s1ck94]: https://github.com/zimfw/s1ck94
|
||||
|
||||
[Unreleased]: https://github.com/zimfw/zimfw/compare/v1.15.1...HEAD
|
||||
[1.15.1]: https://github.com/zimfw/zimfw/compare/v1.15.0...v1.15.1
|
||||
[1.15.0]: https://github.com/zimfw/zimfw/compare/v1.14.0...v1.15.0
|
||||
[1.14.0]: https://github.com/zimfw/zimfw/compare/v1.13.1...v1.14.0
|
||||
[1.13.1]: https://github.com/zimfw/zimfw/compare/v1.13.0...v1.13.1
|
||||
[1.13.0]: https://github.com/zimfw/zimfw/compare/v1.12.1...v1.13.0
|
||||
[1.12.1]: https://github.com/zimfw/zimfw/compare/v1.12.0...v1.12.1
|
||||
[1.12.0]: https://github.com/zimfw/zimfw/compare/v1.11.3...v1.12.0
|
||||
[1.11.3]: https://github.com/zimfw/zimfw/compare/v1.11.2...v1.11.3
|
||||
[1.11.2]: https://github.com/zimfw/zimfw/compare/v1.11.1...v1.11.2
|
||||
[1.11.1]: https://github.com/zimfw/zimfw/compare/v1.11.0...v1.11.1
|
||||
[1.11.0]: https://github.com/zimfw/zimfw/compare/v1.10.0...v1.11.0
|
||||
[1.10.0]: https://github.com/zimfw/zimfw/compare/v1.9.1...v1.10.0
|
||||
[1.9.1]: https://github.com/zimfw/zimfw/compare/v1.9.0...v1.9.1
|
||||
[1.9.0]: https://github.com/zimfw/zimfw/compare/v1.8.0...v1.9.0
|
||||
[1.8.0]: https://github.com/zimfw/zimfw/compare/v1.7.0...v1.8.0
|
||||
[1.7.0]: https://github.com/zimfw/zimfw/compare/v1.6.2...v1.7.0
|
||||
[1.6.2]: https://github.com/zimfw/zimfw/compare/v1.6.1...v1.6.2
|
||||
[1.6.1]: https://github.com/zimfw/zimfw/compare/v1.6.0...v1.6.1
|
||||
[1.6.0]: https://github.com/zimfw/zimfw/compare/v1.5.0...v1.6.0
|
||||
[1.5.0]: https://github.com/zimfw/zimfw/compare/v1.4.3...v1.5.0
|
||||
[1.4.3]: https://github.com/zimfw/zimfw/compare/v1.4.2...v1.4.3
|
||||
[1.4.2]: https://github.com/zimfw/zimfw/compare/v1.4.1...v1.4.2
|
||||
[1.4.1]: https://github.com/zimfw/zimfw/compare/v1.4.0...v1.4.1
|
||||
[Unreleased]: https://github.com/zimfw/zimfw/compare/v1.4.0...HEAD
|
||||
[1.4.0]: https://github.com/zimfw/zimfw/compare/v1.3.2...v1.4.0
|
||||
[1.3.2]: https://github.com/zimfw/zimfw/compare/v1.3.1...v1.3.2
|
||||
[1.3.1]: https://github.com/zimfw/zimfw/compare/v1.3.0...v1.3.1
|
||||
|
|
|
|||
84
CODE_OF_CONDUCT.md
Normal file
84
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `eric@amalgamar.com.br` and `m@tthamilton.com`. All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the project community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
||||
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
|
||||
2
LICENSE
2
LICENSE
|
|
@ -1,7 +1,7 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2015-2016 Matt Hamilton and contributors
|
||||
Copyright (c) 2016-2024 Eric Nielsen, Matt Hamilton and contributors
|
||||
Copyright (c) 2016-2021 Eric Nielsen, Matt Hamilton and contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
416
README.md
416
README.md
|
|
@ -1,385 +1,141 @@
|
|||
<p align="center">
|
||||
<a href="https://github.com/zimfw/zimfw/releases"><img src="https://img.shields.io/github/v/release/zimfw/zimfw"></a>
|
||||
<a href="https://github.com/zimfw/zimfw/issues"><img src="https://img.shields.io/github/issues/zimfw/zimfw.svg"></a>
|
||||
<a href="https://github.com/zimfw/zimfw/network/members"><img src="https://img.shields.io/github/forks/zimfw/zimfw.svg"></a>
|
||||
<a href="https://github.com/zimfw/zimfw/stargazers"><img src="https://img.shields.io/github/stars/zimfw/zimfw.svg"></a>
|
||||
<a href="https://github.com/zimfw/zimfw/releases"><img src="https://img.shields.io/github/downloads/zimfw/zimfw/total.svg"></a>
|
||||
<a href="https://github.com/zimfw/zimfw/discussions"><img src="https://img.shields.io/badge/forum-online-green.svg"></a>
|
||||
<a href="https://github.com/zimfw/zimfw/blob/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/zimfw/zimfw"></a>
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://github.com/zimfw/zimfw">
|
||||
<img width="600" src="https://zimfw.github.io/images/zimfw-banner@2.jpg">
|
||||
<img width="650" src="https://zimfw.github.io/images/zim_banner.png">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
Zsh IMproved FrameWork
|
||||
======================
|
||||
|
||||
What is Zim?
|
||||
------------
|
||||
Zim is a Zsh configuration framework that bundles a [plugin manager](#usage),
|
||||
useful [modules] and a wide variety of [themes], without compromising on [speed].
|
||||
Zim is a Zsh configuration framework with [blazing speed] and modular extensions.
|
||||
|
||||
Check how Zim compares to other frameworks and plugin managers:
|
||||
Zim is very easy to customize, and comes with a rich set of modules and features without compromising on speed or functionality!
|
||||
|
||||
<a href="https://github.com/zimfw/zimfw/wiki/Speed">
|
||||
<img src="https://zimfw.github.io/images/results.svg">
|
||||
</a>
|
||||
|
||||
Table of Contents
|
||||
What does Zim offer?
|
||||
-----------------
|
||||
* [Installation](#installation)
|
||||
* [Automatic installation](#automatic-installation)
|
||||
* [Manual installation](#manual-installation)
|
||||
* [Set up `~/.zshrc`](#set-up-zshrc)
|
||||
* [Create `~/.zimrc`](#create-zimrc)
|
||||
* [Usage](#usage)
|
||||
* [`zmodule`](#zmodule)
|
||||
* [`zimfw`](#zimfw)
|
||||
* [Settings](#settings)
|
||||
* [Uninstalling](#uninstalling)
|
||||
If you're here, it means you want to see the cool shit Zim can do. Check out the [available modules]!
|
||||
|
||||
Below is a brief showcase of Zim's features.
|
||||
|
||||
### Speed
|
||||
For a speed comparison between Zim and other frameworks, see [this wiki entry][blazing speed].
|
||||
|
||||
### Themes
|
||||
|
||||
To preview some of the available themes, check the [themes wiki page].
|
||||
|
||||
### Fish-shell history navigation
|
||||
![history-substring-search]
|
||||
|
||||
### Syntax highlighting
|
||||
![syntax-highlighting]
|
||||
|
||||
### And much more!
|
||||
Zim has many modules! Enable as many or as few as you'd like.
|
||||
|
||||
Installation
|
||||
------------
|
||||
Installing Zim is easy. You can choose either the automatic or manual method below:
|
||||
Installing Zim is easy:
|
||||
|
||||
### Automatic installation
|
||||
* With curl:
|
||||
|
||||
This will install a predefined set of modules and a theme for you.
|
||||
|
||||
* With `curl`:
|
||||
```zsh
|
||||
curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
|
||||
```
|
||||
|
||||
* With `wget`:
|
||||
```zsh
|
||||
* With wget:
|
||||
|
||||
wget -nv -O - https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
|
||||
```
|
||||
|
||||
Restart your terminal and you're done. Enjoy your Zsh IMproved! Take some time
|
||||
to tweak your [`~/.zshrc`](#set-up-zshrc) file and to also check the available
|
||||
[modules] and [themes] you can add to your [`~/.zimrc`](#create-zimrc).
|
||||
Open a new terminal and you're done! Enjoy your Zsh IMproved! Take some time to
|
||||
read about the [available modules] and tweak your `~/.zshrc` file.
|
||||
|
||||
If you have a different shell framework installed (like oh-my-zsh or prezto),
|
||||
*uninstall those first to prevent conflicts*.
|
||||
|
||||
### Manual installation
|
||||
|
||||
1. Set Zsh as the default shell, if you haven't done so already:
|
||||
```zsh
|
||||
1. Set Zsh as the default shell:
|
||||
|
||||
chsh -s $(which zsh)
|
||||
````
|
||||
|
||||
2. [Set up your `~/.zshrc` file](#set-up-zshrc)
|
||||
2. Add the lines in the following templates to the respective dot files:
|
||||
* [~/.zshenv](https://github.com/zimfw/install/blob/master/src/templates/zshenv)
|
||||
* [~/.zshrc](https://github.com/zimfw/install/blob/master/src/templates/zshrc)
|
||||
* [~/.zlogin](https://github.com/zimfw/install/blob/master/src/templates/zlogin)
|
||||
* [~/.zimrc](https://github.com/zimfw/install/blob/master/src/templates/zimrc)
|
||||
|
||||
3. [Create your `~/.zimrc` file](#create-zimrc)
|
||||
3. Copy https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh to
|
||||
`~/.zim/zimfw.zsh`.
|
||||
|
||||
4. Restart your terminal and you're done. Enjoy your Zsh IMproved!
|
||||
4. Install the modules defined in `~/.zimrc` and build the initialization scripts:
|
||||
|
||||
#### Set up `~/.zshrc`
|
||||
|
||||
Add the lines below to your `~/.zshrc` file, in the following order:
|
||||
|
||||
1. To use our `degit` tool by default to install modules:
|
||||
```zsh
|
||||
zstyle ':zim:zmodule' use 'degit'
|
||||
````
|
||||
This is optional and only required if you don't have `git` installed (yes,
|
||||
zimfw works even without `git`!)
|
||||
|
||||
2. To set where the zimfw plugin manager configuration file will be located:
|
||||
```zsh
|
||||
ZIM_CONFIG_FILE=~/.config/zsh/zimrc
|
||||
```
|
||||
This is optional. The value of `ZIM_CONFIG_FILE` can be any path your user
|
||||
has at least read access to. By default, the file must be at `~/.zimrc`, if
|
||||
the `ZDOTDIR` environment variable is not defined. Otherwise, it must be at
|
||||
`${ZDOTDIR}/.zimrc`.
|
||||
|
||||
3. To set the directory where the zimfw plugin manager will keep necessary files:
|
||||
```zsh
|
||||
ZIM_HOME=~/.zim
|
||||
```
|
||||
The value of `ZIM_HOME` can be any directory your user has write access to.
|
||||
You can even set it to a cache directory like `${XDG_CACHE_HOME}/zim` or
|
||||
`~/.cache/zim`.
|
||||
|
||||
4. To automatically download the zimfw plugin manager if missing:
|
||||
```zsh
|
||||
# Download zimfw plugin manager if missing.
|
||||
if [[ ! -e ${ZIM_HOME}/zimfw.zsh ]]; then
|
||||
curl -fsSL --create-dirs -o ${ZIM_HOME}/zimfw.zsh \
|
||||
https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh
|
||||
fi
|
||||
```
|
||||
Or if you use `wget` instead of `curl`:
|
||||
```zsh
|
||||
# Download zimfw plugin manager if missing.
|
||||
if [[ ! -e ${ZIM_HOME}/zimfw.zsh ]]; then
|
||||
mkdir -p ${ZIM_HOME} && wget -nv -O ${ZIM_HOME}/zimfw.zsh \
|
||||
https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh
|
||||
fi
|
||||
```
|
||||
This is optional. Alternatively, you can download the `zimfw.zsh` script
|
||||
anywhere your user has write access to: just replace the occurrences of
|
||||
`${ZIM_HOME}/zimfw.zsh` by the preferred path, like `/usr/local/bin/zimfw.zsh`
|
||||
for example. If you choose to not include this step, you should manually
|
||||
download the `zimfw.zsh` script once and keep it at the preferred path.
|
||||
|
||||
5. To automatically install missing modules and update the static initialization
|
||||
script if missing or outdated:
|
||||
```zsh
|
||||
# Install missing modules and update ${ZIM_HOME}/init.zsh if missing or outdated.
|
||||
if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZIM_CONFIG_FILE:-${ZDOTDIR:-${HOME}}/.zimrc} ]]; then
|
||||
source ${ZIM_HOME}/zimfw.zsh init -q
|
||||
fi
|
||||
```
|
||||
This step is optional, but highly recommended. If you choose to not include
|
||||
it, you must remember to manually run `zimfw install` every time you update
|
||||
your [`~/.zimrc`](#create-zimrc) file. If you have chosen to keep the
|
||||
`zimfw.zsh` in a different path as mentioned in the previous step, replace
|
||||
`${ZIM_HOME}/zimfw.zsh` by the chosen path.
|
||||
|
||||
6. To source the static script, that will initialize your modules:
|
||||
```zsh
|
||||
# Initialize modules.
|
||||
source ${ZIM_HOME}/init.zsh
|
||||
```
|
||||
|
||||
#### Create `~/.zimrc`
|
||||
|
||||
This file configures the zimfw plugin manager. It's referred to as `~/.zimrc`
|
||||
in the documentation for the sake of simplicity, but the actual location of the
|
||||
file is defined by the following rules:
|
||||
|
||||
1. You can define the full path and name of the file with a `ZIM_CONFIG_FILE`
|
||||
environment variable. For example:
|
||||
```zsh
|
||||
ZIM_CONFIG_FILE=~/.config/zsh/zimrc
|
||||
```
|
||||
|
||||
2. Or, if you defined a `ZDOTDIR` environment variable, then the file must be at
|
||||
`${ZDOTDIR}/.zimrc`
|
||||
|
||||
3. Otherwise, it must be at at `~/.zimrc`, which is it's default location.
|
||||
|
||||
As for the contents of the file, you can start with just:
|
||||
```zsh
|
||||
zmodule zsh-users/zsh-syntax-highlighting
|
||||
zmodule zsh-users/zsh-autosuggestions
|
||||
```
|
||||
|
||||
If you also want one of our prompt [themes]:
|
||||
```zsh
|
||||
zmodule git-info
|
||||
zmodule duration-info
|
||||
zmodule asciiship
|
||||
zmodule zsh-users/zsh-syntax-highlighting
|
||||
zmodule zsh-users/zsh-autosuggestions
|
||||
```
|
||||
|
||||
If you want to use our [completion] module too, instead of using `compinit` directly:
|
||||
```zsh
|
||||
zmodule git-info
|
||||
zmodule duration-info
|
||||
zmodule asciiship
|
||||
zmodule zsh-users/zsh-completions --fpath src
|
||||
zmodule completion
|
||||
zmodule zsh-users/zsh-syntax-highlighting
|
||||
zmodule zsh-users/zsh-autosuggestions
|
||||
```
|
||||
The [completion] module calls `compinit` for you. You should remove any
|
||||
`compinit` calls from your `~/.zshrc` when you use this module. The modules will
|
||||
be initialized in the order they are defined, and [completion] must be
|
||||
initialized *after* all modules that add completion definitions, so it must come
|
||||
after [zsh-users/zsh-completions].
|
||||
|
||||
Check the [`zmodule` usage](#zmodule) below for more examples on how to use it to
|
||||
define the modules you want to use.
|
||||
zsh ~/.zim/zimfw.zsh install
|
||||
|
||||
Usage
|
||||
-----
|
||||
The zimfw plugin manager installs your modules at `${ZIM_HOME}/modules` and
|
||||
builds a static script at `${ZIM_HOME}/init.zsh` that will initialize them. Your
|
||||
modules are defined in your `~/.zimrc` file.
|
||||
|
||||
The `~/.zimrc` file must contain `zmodule` calls to define the modules to be
|
||||
initialized. The modules will be initialized in the same order they're defined.
|
||||
|
||||
The `~/.zimrc` file is not sourced during Zsh startup and it's only used to
|
||||
configure the zimfw plugin manager.
|
||||
|
||||
Check [examples of `~/.zimrc` files](#create-zimrc) above.
|
||||
|
||||
### zmodule
|
||||
|
||||
Below are some usage examples:
|
||||
<pre>
|
||||
Usage: <strong>zmodule</strong> <url> [<strong>-n</strong>|<strong>--name</strong> <module_name>] [options]
|
||||
|
||||
* A module from the [@zimfw] organization: `zmodule archive`
|
||||
* A module from another GitHub organization: `zmodule StackExchange/blackbox`
|
||||
* A module with a custom URL: `zmodule https://gitlab.com/Spriithy/basher.git`
|
||||
* A module at an absolute path, that is already installed:
|
||||
`zmodule /usr/local/share/zsh-autosuggestions`
|
||||
* A module with a custom fpath: `zmodule zsh-users/zsh-completions --fpath src`
|
||||
* A module with a custom initialization file and with git submodules disabled:
|
||||
`zmodule spaceship-prompt/spaceship-prompt --source spaceship.zsh --no-submodules` or
|
||||
`zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules`
|
||||
* A module with two custom initialization files:
|
||||
`zmodule sindresorhus/pure --source async.zsh --source pure.zsh`. Separate
|
||||
zmodule calls can also be used. In this equivalent example, the second call
|
||||
automatically discovers the second file to be sourced:
|
||||
```
|
||||
zmodule sindresorhus/pure --source async.zsh
|
||||
zmodule sindresorhus/pure
|
||||
```
|
||||
* A module with a custom initialization command:
|
||||
`zmodule skywind3000/z.lua --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"'`
|
||||
* A module with an on-pull command. It can be used to create a cached initialization script:
|
||||
`zmodule skywind3000/z.lua --on-pull 'lua z.lua --init zsh enhanced once >! init.zsh'`
|
||||
* A module with a big git repository: `zmodule romkatv/powerlevel10k --use degit`
|
||||
* A module with a custom root subdirectory: `zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction`
|
||||
* A module with multiple roots:
|
||||
```
|
||||
zmodule sorin-ionescu/prezto --root modules/command-not-found
|
||||
zmodule sorin-ionescu/prezto --root modules/gnu-utility
|
||||
```
|
||||
or
|
||||
```
|
||||
zmodule ohmyzsh/ohmyzsh --root plugins/perl
|
||||
zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction
|
||||
```
|
||||
|
||||
<details id="zmodule-usage">
|
||||
<summary>Want help with the complete <code>zmodule</code> usage?</summary>
|
||||
|
||||
<pre>Usage: <b>zmodule</b> <url> [<b>-n</b>|<b>--name</b> <module_name>] [<b>-r</b>|<b>--root</b> <path>] [options]
|
||||
|
||||
Add <b>zmodule</b> calls to your <b>~/.zimrc</b> file to define the modules to be initialized. The initiali-
|
||||
zation will be done in the same order it's defined.
|
||||
Add <strong>zmodule</strong> calls to your <strong>~/.zimrc</strong> file to define the modules to be initialized. The modules are
|
||||
initialized in the same order they are defined.
|
||||
|
||||
<url> Module absolute path or repository URL. The following URL formats
|
||||
are equivalent: <b>foo</b>, <b>zimfw/foo</b>, <b>https://github.com/zimfw/foo.git</b>.
|
||||
If an absolute path is given, the module is considered externally
|
||||
installed and won't be installed or updated by zimfw.
|
||||
<b>-n</b>|<b>--name</b> <module_name> Set a custom module name. Default: the last component in <url>.
|
||||
Slashes can be used inside the name to organize the module into
|
||||
subdirectories. The module will be installed at
|
||||
<b>${ZIM_HOME}/</b><module_name>.
|
||||
<b>-r</b>|<b>--root</b> <path> Relative path to the module root.
|
||||
are equivalent: <strong>name</strong>, <strong>zimfw/name</strong>, <strong>https://github.com/zimfw/name.git</strong>.
|
||||
<strong>-n</strong>|<strong>--name</strong> <module_name> Set a custom module name. Default: the last component in the <url>.
|
||||
|
||||
Per-module options:
|
||||
<b>-b</b>|<b>--branch</b> <branch_name> Use specified branch when installing and updating the module.
|
||||
Overrides the tag option. Default: the repository default branch.
|
||||
<b>-t</b>|<b>--tag</b> <tag_name> Use specified tag when installing and updating the module. Over-
|
||||
rides the branch option.
|
||||
<b>-u</b>|<b>--use</b> <tool_name> Install and update the module using the defined tool. Default is
|
||||
either defined by <b>zstyle ':zim:zmodule' use '</b><tool_name><b>'</b>, or <b>git</b>
|
||||
if none is provided. The tools available are:
|
||||
<b>git</b> uses the git command. Local changes are preserved on updates.
|
||||
<b>degit</b> uses curl or wget, and currently only works with GitHub
|
||||
URLs. Modules install faster and take less disk space. Local
|
||||
changes are lost on updates. Git submodules are not supported.
|
||||
<b>mkdir</b> creates an empty directory. The <url> is only used to set
|
||||
the module name. Use the <b>-c</b>|<b>--cmd</b> or <b>--on-pull</b> options to execute
|
||||
the desired command to generate the module files.
|
||||
<b>--no-submodules</b> Don't install or update git submodules.
|
||||
<b>-z</b>|<b>--frozen</b> Don't install or update the module.
|
||||
Repository options:
|
||||
<strong>-b</strong>|<strong>--branch</strong> <branch_name> Use specified branch when installing and updating the module.
|
||||
Overrides the tag option. Default: the repository's default branch.
|
||||
<strong>-t</strong>|<strong>--tag</strong> <tag_name> Use specified tag when installing and updating the module.
|
||||
Overrides the branch option.
|
||||
<strong>-z</strong>|<strong>--frozen</strong> Don't install or update the module.
|
||||
|
||||
The per-module options above are carried over multiple zmodule calls for the same module.
|
||||
Modules are uniquely identified by their name.
|
||||
|
||||
Per-module-root options:
|
||||
<b>--if</b> <test> Will only initialize module root if specified test returns a zero
|
||||
exit status. The test is evaluated at every new terminal startup.
|
||||
<b>--if-command</b> <cmd_name> Will only initialize module root if specified external command is
|
||||
available. This is evaluated at every new terminal startup.
|
||||
Equivalent to <b>--if '(( ${+commands[</b><cmd_name><b>]} ))'</b>.
|
||||
<b>--if-ostype</b> <ostype> Will only initialize module root if <b>OSTYPE</b> is equal to the given
|
||||
expression. This is evaluated at every new terminal startup.
|
||||
Equivalent to <b>--if '[[ ${OSTYPE} == </b><ostype><b> ]]'</b>.
|
||||
<b>--on-pull</b> <command> Execute command after installing or updating the module. The com-
|
||||
mand is executed in the module root directory.
|
||||
<b>-d</b>|<b>--disabled</b> Don't initialize the module root or uninstall the module.
|
||||
|
||||
The per-module-root options above are carried over multiple zmodule calls for the same mod-
|
||||
ule root.
|
||||
|
||||
Per-call initialization options:
|
||||
<b>-f</b>|<b>--fpath</b> <path> Will add specified path to fpath. The path is relative to the
|
||||
module root directory. Default: <b>functions</b>, if the subdirectory
|
||||
exists and is non-empty.
|
||||
<b>-a</b>|<b>--autoload</b> <func_name> Will autoload specified function. Default: all valid names inside
|
||||
the <b>functions</b> subdirectory, if any.
|
||||
<b>-s</b>|<b>--source</b> <file_path> Will source specified file. The path is relative to the module
|
||||
root directory. Default: <b>init.zsh</b>, if a non-empty <b>functions</b> sub-
|
||||
directory exists, else the largest of the files matching the glob
|
||||
<b>(init.zsh|</b><name><b>.(zsh|plugin.zsh|zsh-theme|sh))</b>, if any.
|
||||
<name> in the glob is resolved to the last component of the mod-
|
||||
ule name, or the last component of the path to the module root.
|
||||
<b>-c</b>|<b>--cmd</b> <command> Will execute specified command. Occurrences of the <b>{}</b> placeholder
|
||||
in the command are substituted by the module root directory path.
|
||||
I.e., <b>-s 'foo.zsh'</b> and <b>-c 'source {}/foo.zsh'</b> are equivalent.
|
||||
|
||||
Setting any per-call initialization option above will disable the default values from the
|
||||
other per-call initialization options, so only your provided values will be used. I.e. these
|
||||
values are either all automatic, or all manual in each zmodule call. To use default values
|
||||
and also provided values, use separate zmodule calls.
|
||||
Initialization options:
|
||||
<strong>-f</strong>|<strong>--fpath</strong> <path> Add specified path to fpath. The path is relative to the module
|
||||
root directory. Default: <strong>functions</strong>, if the subdirectory exists.
|
||||
<strong>-a</strong>|<strong>--autoload</strong> <func_name> Autoload specified function. Default: all valid names inside the
|
||||
module's specified fpath paths.
|
||||
<strong>-s</strong>|<strong>--source</strong> <file_path> Source specified file. The file path is relative to the module root
|
||||
directory. Default: the file with largest size matching
|
||||
<strong>{init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}</strong>, if any exist.
|
||||
<strong>-c</strong>|<strong>--cmd</strong> <command> Execute specified command. Occurrences of the <strong>{}</strong> placeholder in the
|
||||
command are substituted by the module root directory path.
|
||||
<strong>-s 'script.zsh'</strong> and <strong>-c 'source {}/script.zsh'</strong> are equivalent.
|
||||
<strong>-d</strong>|<strong>--disabled</strong> Don't initialize or uninstall the module.
|
||||
</pre>
|
||||
|
||||
</details>
|
||||
|
||||
### zimfw
|
||||
|
||||
The Zim plugin manager:
|
||||
Added new modules to `~/.zimrc`? Run `zimfw install`.
|
||||
|
||||
* Added new modules to `~/.zimrc`? Run `zimfw install`.
|
||||
* Removed modules from `~/.zimrc`? Run `zimfw uninstall`.
|
||||
* Want to update your modules to their latest revisions? Run `zimfw update`.
|
||||
* Want to upgrade zimfw to its latest version? Run `zimfw upgrade`.
|
||||
* For more information about the zimfw plugin manager, run `zimfw help`.
|
||||
Removed modules from `~/.zimrc`? Run `zimfw uninstall`.
|
||||
|
||||
Want to update your modules to their latest revisions? Run `zimfw update`.
|
||||
|
||||
Want to upgrade `zimfw` to its latest version? Run `zimfw upgrade`.
|
||||
|
||||
For more information about the `zimfw` tool, run `zimfw help`.
|
||||
|
||||
Settings
|
||||
--------
|
||||
Set the path of the directory used by zimfw with the `ZIM_HOME` environment
|
||||
variable:
|
||||
|
||||
ZIM_HOME=~/.zim
|
||||
|
||||
By default, the zimfw plugin manager configuration file must be at `~/.zimrc`,
|
||||
if the `ZDOTDIR` environment variable is not defined. Otherwise, it must be at
|
||||
`${ZDOTDIR}/.zimrc`. You can customize its full path and name with the
|
||||
`ZIM_CONFIG_FILE` environment variable:
|
||||
|
||||
ZIM_CONFIG_FILE=~/.config/zsh/zimrc
|
||||
|
||||
Modules are installed using `git` by default. If you don't have `git`
|
||||
installed, or if you want to take advantage of our degit tool for faster and
|
||||
lighter module installations, you can set degit as the default tool with:
|
||||
|
||||
zstyle ':zim:zmodule' use 'degit'
|
||||
|
||||
By default, zimfw will check if it has a new version available every 30 days. If
|
||||
the `zimfw.zsh` file cannot be upgraded, either because your user does not have
|
||||
write access to it, or because it was sourced from a symlink, then this will be
|
||||
disabled. This can be manually disabled with:
|
||||
By default, `zimfw` will check if it has a new version available every 30 days.
|
||||
This can be disabled with:
|
||||
|
||||
zstyle ':zim' disable-version-check yes
|
||||
|
||||
To disable color output from zimfw, prefix the zimfw call with `NO_COLOR=1`,
|
||||
like:
|
||||
|
||||
NO_COLOR=1 zimfw install
|
||||
|
||||
or add the following to your `.zshrc`, which should also disable color output
|
||||
for other tools. See https://no-color.org/
|
||||
|
||||
export NO_COLOR=1
|
||||
|
||||
Uninstalling
|
||||
------------
|
||||
|
||||
The best way to remove Zim is to manually delete `~/.zim`, `~/.zimrc`, and
|
||||
remove the initialization lines from your `~/.zshenv`, `~/.zshrc` and `~/.zlogin`.
|
||||
|
||||
[modules]: https://zimfw.sh/docs/modules/
|
||||
[themes]: https://zimfw.sh/docs/themes/
|
||||
[speed]: https://github.com/zimfw/zimfw/wiki/Speed
|
||||
[@zimfw]: https://github.com/zimfw
|
||||
[completion]: https://github.com/zimfw/completion
|
||||
[zsh-users/zsh-completions]: https://github.com/zsh-users/zsh-completions
|
||||
[history-substring-search]: https://zimfw.github.io/images/zim_history-substring-search.gif
|
||||
[syntax-highlighting]: https://zimfw.github.io/images/zim_syntax-highlighting.gif
|
||||
[blazing speed]: https://github.com/zimfw/zimfw/wiki/Speed
|
||||
[available modules]: https://github.com/zimfw/zimfw/wiki/Modules
|
||||
[themes wiki page]: https://github.com/zimfw/zimfw/wiki/Themes
|
||||
|
|
|
|||
|
|
@ -1,243 +0,0 @@
|
|||
zmodule() {
|
||||
local -r zusage="Usage: ${_zbold}${0}${_znormal} <url> [${_zbold}-n${_znormal}|${_zbold}--name${_znormal} <module_name>] [${_zbold}-r${_znormal}|${_zbold}--root${_znormal} <path>] [options]
|
||||
|
||||
Add ${_zbold}zmodule${_znormal} calls to your ${_zbold}${_zconfig}${_znormal} file to define the modules to be initialized.
|
||||
The initialization will be done in the same order it's defined.
|
||||
|
||||
<url> Module absolute path or repository URL. The following URL formats
|
||||
are equivalent: ${_zbold}foo${_znormal}, ${_zbold}zimfw/foo${_znormal}, ${_zbold}https://github.com/zimfw/foo.git${_znormal}.
|
||||
If an absolute path is given, the module is considered externally
|
||||
installed and won't be installed or updated by zimfw.
|
||||
${_zbold}-n${_znormal}|${_zbold}--name${_znormal} <module_name> Set a custom module name. Default: the last component in <url>.
|
||||
Slashes can be used inside the name to organize the module into
|
||||
subdirectories. The module will be installed at
|
||||
${_zbold}${ZIM_HOME}/${_znormal}<module_name>.
|
||||
${_zbold}-r${_znormal}|${_zbold}--root${_znormal} <path> Relative path to the module root.
|
||||
|
||||
Per-module options:
|
||||
${_zbold}-b${_znormal}|${_zbold}--branch${_znormal} <branch_name> Use specified branch when installing and updating the module.
|
||||
Overrides the tag option. Default: the repository default branch.
|
||||
${_zbold}-t${_znormal}|${_zbold}--tag${_znormal} <tag_name> Use specified tag when installing and updating the module. Over-
|
||||
rides the branch option.
|
||||
${_zbold}-u${_znormal}|${_zbold}--use${_znormal} <tool_name> Install and update the module using the defined tool. Default is
|
||||
either defined by ${_zbold}zstyle ':zim:zmodule' use '${_znormal}<tool_name>${_zbold}'${_znormal}, or ${_zbold}git${_znormal}
|
||||
if none is provided. The tools available are:
|
||||
${_zbold}git${_znormal} uses the git command. Local changes are preserved on updates.
|
||||
${_zbold}degit${_znormal} uses curl or wget, and currently only works with GitHub
|
||||
URLs. Modules install faster and take less disk space. Local
|
||||
changes are lost on updates. Git submodules are not supported.
|
||||
${_zbold}mkdir${_znormal} creates an empty directory. The <url> is only used to set
|
||||
the module name. Use the ${_zbold}-c${_znormal}|${_zbold}--cmd${_znormal} or ${_zbold}--on-pull${_znormal} options to execute
|
||||
the desired command to generate the module files.
|
||||
${_zbold}--no-submodules${_znormal} Don't install or update git submodules.
|
||||
${_zbold}-z${_znormal}|${_zbold}--frozen${_znormal} Don't install or update the module.
|
||||
|
||||
The per-module options above are carried over multiple zmodule calls for the same module.
|
||||
Modules are uniquely identified by their name.
|
||||
|
||||
Per-module-root options:
|
||||
${_zbold}--if${_znormal} <test> Will only initialize module root if specified test returns a zero
|
||||
exit status. The test is evaluated at every new terminal startup.
|
||||
${_zbold}--if-command${_znormal} <cmd_name> Will only initialize module root if specified external command is
|
||||
available. This is evaluated at every new terminal startup.
|
||||
Equivalent to ${_zbold}--if '(( \${+commands[${_znormal}<cmd_name>${_zbold}]} ))'${_znormal}.
|
||||
${_zbold}--if-ostype${_znormal} <ostype> Will only initialize module root if ${_zbold}OSTYPE${_znormal} is equal to the given
|
||||
expression. This is evaluated at every new terminal startup.
|
||||
Equivalent to ${_zbold}--if '[[ \${OSTYPE} == ${_znormal}<ostype>${_zbold} ]]'${_znormal}.
|
||||
${_zbold}--on-pull${_znormal} <command> Execute command after installing or updating the module. The com-
|
||||
mand is executed in the module root directory.
|
||||
${_zbold}-d${_znormal}|${_zbold}--disabled${_znormal} Don't initialize the module root or uninstall the module.
|
||||
|
||||
The per-module-root options above are carried over multiple zmodule calls for the same mod-
|
||||
ule root.
|
||||
|
||||
Per-call initialization options:
|
||||
${_zbold}-f${_znormal}|${_zbold}--fpath${_znormal} <path> Will add specified path to fpath. The path is relative to the
|
||||
module root directory. Default: ${_zbold}functions${_znormal}, if the subdirectory
|
||||
exists and is non-empty.
|
||||
${_zbold}-a${_znormal}|${_zbold}--autoload${_znormal} <func_name> Will autoload specified function. Default: all valid names inside
|
||||
the ${_zbold}functions${_znormal} subdirectory, if any.
|
||||
${_zbold}-s${_znormal}|${_zbold}--source${_znormal} <file_path> Will source specified file. The path is relative to the module
|
||||
root directory. Default: ${_zbold}init.zsh${_znormal}, if a non-empty ${_zbold}functions${_znormal} sub-
|
||||
directory exists, else the largest of the files matching the glob
|
||||
${_zbold}(init.zsh|${_znormal}<name>${_zbold}.(zsh|plugin.zsh|zsh-theme|sh))${_znormal}, if any.
|
||||
<name> in the glob is resolved to the last component of the mod-
|
||||
ule name, or the last component of the path to the module root.
|
||||
${_zbold}-c${_znormal}|${_zbold}--cmd${_znormal} <command> Will execute specified command. Occurrences of the ${_zbold}{}${_znormal} placeholder
|
||||
in the command are substituted by the module root directory path.
|
||||
I.e., ${_zbold}-s 'foo.zsh'${_znormal} and ${_zbold}-c 'source {}/foo.zsh'${_znormal} are equivalent.
|
||||
|
||||
Setting any per-call initialization option above will disable the default values from the
|
||||
other per-call initialization options, so only your provided values will be used. I.e. these
|
||||
values are either all automatic, or all manual in each zmodule call. To use default values
|
||||
and also provided values, use separate zmodule calls."
|
||||
if (( ! # )); then
|
||||
print -u2 -lR "${_zerror}${funcfiletrace[1]}: Missing zmodule url${_znormal}" '' ${zusage}
|
||||
_zfailed=1
|
||||
return 2
|
||||
fi
|
||||
local zurl=${1} zname=${1:t} zroot zarg
|
||||
local -a zfpaths zfunctions zcmds
|
||||
if [[ ${zurl} =~ ^[^:/]+: ]]; then
|
||||
zname=${zname%.git}
|
||||
elif [[ ${zurl} != /* ]]; then
|
||||
# Count number of slashes
|
||||
case ${#zurl//[^\/]/} in
|
||||
0) zurl=https://github.com/zimfw/${zurl}.git ;;
|
||||
1) zurl=https://github.com/${zurl}.git ;;
|
||||
esac
|
||||
fi
|
||||
shift
|
||||
while [[ ${1} == (-n|--name|-r|--root) ]]; do
|
||||
if (( # < 2 )); then
|
||||
print -u2 -lR "${_zerror}${funcfiletrace[1]}:${_zbold}${zname}:${_znormalred} Missing argument for zmodule option ${_zbold}${1}${_znormal}" '' ${zusage}
|
||||
_zfailed=1
|
||||
return 2
|
||||
fi
|
||||
case ${1} in
|
||||
-n|--name)
|
||||
shift
|
||||
zname=${${1%%/##}##/##}
|
||||
;;
|
||||
-r|--root)
|
||||
shift
|
||||
zroot=${${1%%/##}##/##}
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
if [[ ${zurl} == /* ]]; then
|
||||
_zdirs[${zname}]=${zurl%%/##}
|
||||
zurl=
|
||||
else
|
||||
_zdirs[${zname}]=${ZIM_HOME}/modules/${zname}
|
||||
fi
|
||||
if [[ ${+_zurls[${zname}]} -ne 0 && ${_zurls[${zname}]} != ${zurl} ]]; then
|
||||
print -u2 -lR "${_zerror}${funcfiletrace[1]}:${_zbold}${zname}:${_znormalred} Module already defined with a different URL. Expected ${_zbold}${_zurls[${zname}]}${_znormal}" '' ${zusage}
|
||||
_zfailed=1
|
||||
return 2
|
||||
fi
|
||||
_zurls[${zname}]=${zurl}
|
||||
local -r zroot_dir=${_zdirs[${zname}]}${zroot:+/${zroot}}
|
||||
_zroot_dirs+=(${zroot_dir})
|
||||
# Set default values
|
||||
if (( ! ${+_ztools[${zname}]} )); then
|
||||
zstyle -s ':zim:zmodule' use "_ztools[${zname}]" || _ztools[${zname}]=git
|
||||
fi
|
||||
if (( ! ${+_ztypes[${zname}]} )) _ztypes[${zname}]=branch
|
||||
if (( ! ${+_zsubmodules[${zname}]} )) _zsubmodules[${zname}]=1
|
||||
# Set values from options
|
||||
while (( # > 0 )); do
|
||||
case ${1} in
|
||||
-b|--branch|-t|--tag|-u|--use|--on-pull|--if|--if-command|--if-ostype|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd)
|
||||
if (( # < 2 )); then
|
||||
print -u2 -lR "${_zerror}${funcfiletrace[1]}:${_zbold}${zname}:${_znormalred} Missing argument for zmodule option ${_zbold}${1}${_znormal}" '' ${zusage}
|
||||
_zfailed=1
|
||||
return 2
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
case ${1} in
|
||||
-b|--branch|-t|--tag|-u|--use|--no-submodules)
|
||||
if [[ -z ${zurl} ]] _zimfw_print -u2 -R "${_zwarn}${funcfiletrace[1]}:${_zbold}${zname}:${_znormalyellow} The zmodule option ${_zbold}${1}${_znormalyellow} has no effect for external modules${_znormal}"
|
||||
;;
|
||||
esac
|
||||
case ${1} in
|
||||
-b|--branch)
|
||||
shift
|
||||
_ztypes[${zname}]=branch
|
||||
_zrevs[${zname}]=${1}
|
||||
;;
|
||||
-t|--tag)
|
||||
shift
|
||||
_ztypes[${zname}]=tag
|
||||
_zrevs[${zname}]=${1}
|
||||
;;
|
||||
-u|--use)
|
||||
shift
|
||||
_ztools[${zname}]=${1}
|
||||
;;
|
||||
--no-submodules) _zsubmodules[${zname}]=0 ;;
|
||||
-z|--frozen) _zfrozens[${zname}]=1 ;;
|
||||
--on-pull)
|
||||
shift
|
||||
zarg=${1}
|
||||
if [[ -n ${zroot} ]] zarg="(builtin cd -q ${zroot}; ${zarg})"
|
||||
_zonpulls[${zname}]="${_zonpulls[${zname}]+${_zonpulls[${zname}]}; }${zarg}"
|
||||
;;
|
||||
--if)
|
||||
shift
|
||||
_zifs[${zroot_dir}]=${1}
|
||||
;;
|
||||
--if-command)
|
||||
shift
|
||||
_zifs[${zroot_dir}]="(( \${+commands[${1}]} ))"
|
||||
;;
|
||||
--if-ostype)
|
||||
shift
|
||||
_zifs[${zroot_dir}]="[[ \${OSTYPE} == ${1} ]]"
|
||||
;;
|
||||
-f|--fpath)
|
||||
shift
|
||||
zarg=${1}
|
||||
if [[ ${zarg} != /* ]] zarg=${zroot_dir}/${zarg}
|
||||
zfpaths+=(${zarg})
|
||||
;;
|
||||
-a|--autoload)
|
||||
shift
|
||||
zfunctions+=(${1})
|
||||
;;
|
||||
-s|--source)
|
||||
shift
|
||||
zarg=${1}
|
||||
if [[ ${zarg} != /* ]] zarg=${zroot_dir}/${zarg}
|
||||
zcmds+=('source '${(qqq)zarg:a})
|
||||
;;
|
||||
-c|--cmd)
|
||||
shift
|
||||
zcmds+=(${1//{}/${(qqq)zroot_dir:a}})
|
||||
;;
|
||||
-d|--disabled) _zdisabled_root_dirs+=(${zroot_dir}) ;;
|
||||
*)
|
||||
print -u2 -lR "${_zerror}${funcfiletrace[1]}:${_zbold}${zname}:${_znormalred} Unknown zmodule option ${_zbold}${1}${_znormal}" '' ${zusage}
|
||||
_zfailed=1
|
||||
return 2
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
if (( _zflags & 1 )); then
|
||||
_znames+=(${zname})
|
||||
fi
|
||||
if (( _zflags & 2 )); then
|
||||
if [[ ! -e ${zroot_dir} ]]; then
|
||||
print -u2 -R "${_zerror}${funcfiletrace[1]}:${_zbold}${zname}: ${zroot_dir}${_znormalred} not found${_znormal}"
|
||||
_zfailed=1
|
||||
return 1
|
||||
fi
|
||||
if (( ! ${#zfpaths} && ! ${#zfunctions} && ! ${#zcmds} )); then
|
||||
zfpaths=(${zroot_dir}/functions(NF))
|
||||
# _* functions are autoloaded by compinit
|
||||
# prompt_*_setup functions are autoloaded by promptinit
|
||||
zfunctions=(${^zfpaths}/^(*~|*.zwc(|.old)|_*|prompt_*_setup)(N-.:t))
|
||||
local -ra prezto_scripts=(${zroot_dir}/init.zsh(N))
|
||||
if (( ${#zfpaths} && ${#prezto_scripts} )); then
|
||||
# this follows the prezto module format, no need to check for other scripts
|
||||
zcmds=('source '${(qqq)^prezto_scripts:a})
|
||||
else
|
||||
# get script with largest size (descending `O`rder by `L`ength, and return only `[1]` first)
|
||||
local -ra zscripts=(${zroot_dir}/(init.zsh|(${zname:t}|${zroot_dir:t}).(zsh|plugin.zsh|zsh-theme|sh))(NOL[1]))
|
||||
zcmds=('source '${(qqq)^zscripts:a})
|
||||
fi
|
||||
fi
|
||||
if (( ! ${#zfpaths} && ! ${#zfunctions} && ! ${#zcmds} )); then
|
||||
_zimfw_print -u2 -lR "${_zwarn}${funcfiletrace[1]}:${_zbold}${zname}:${_znormalyellow} Nothing found to be initialized. Customize the module name, root or initialization with ${_zbold}zmodule${_znormalyellow} options.${_znormal}" '' ${zusage}
|
||||
fi
|
||||
# Prefix is added to all _zfpaths, _zfunctions and _zcmds to distinguish the originating root dir
|
||||
local -r zpre=${zroot_dir}$'\0'
|
||||
_zfpaths+=(${zpre}${^zfpaths})
|
||||
_zfunctions+=(${zpre}${^zfunctions})
|
||||
zcmds=(${zcmds//${HOME}/\${HOME}})
|
||||
_zcmds+=(${zpre}${^zcmds})
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,12 +1,7 @@
|
|||
autoload -Uz is-at-least && if ! is-at-least <%= min_zsh_version %>; then
|
||||
print -u2 -R "${_zred}${0}: Error starting zimfw. You're using Zsh version ${_zbold}${ZSH_VERSION}${_znormalred} and versions < ${_zbold}<%= min_zsh_version %>${_znormalred} are not supported. Update your Zsh.${_znormal}"
|
||||
print -u2 -PR "%F{red}${0}: Error starting Zim. You're using Zsh version %B${ZSH_VERSION}%b and versions < %B<%= min_zsh_version %>%b are not supported. Upgrade your Zsh.%f"
|
||||
return 1
|
||||
fi
|
||||
autoload -Uz zargs
|
||||
|
||||
if (( ! ${+ZIM_HOME} )); then
|
||||
print -u2 -R "${_zred}${0}: ${_zbold}ZIM_HOME${_znormalred} not defined${_znormal}"
|
||||
return 1
|
||||
fi
|
||||
# Define zimfw location
|
||||
typeset -g __ZIMFW_FILE=${0}
|
||||
# Define Zim location
|
||||
: ${ZIM_HOME=${0:A:h}}
|
||||
|
|
|
|||
|
|
@ -2,11 +2,12 @@ _zimfw_mv() {
|
|||
local -a cklines
|
||||
if cklines=(${(f)"$(command cksum ${1} ${2} 2>/dev/null)"}) && \
|
||||
[[ ${${(z)cklines[1]}[1,2]} == ${${(z)cklines[2]}[1,2]} ]]; then
|
||||
_zimfw_print -R "${_zokay}${_zbold}${2}:${_znormal} Already up to date"
|
||||
_zimfw_print -PR "<%= okay %>%B${2}:%b Already up to date"
|
||||
else
|
||||
if [[ -e ${2} ]]; then
|
||||
command mv -f ${2}{,.old} || return 1
|
||||
fi
|
||||
command mv -f ${1} ${2} && command chmod a+r ${2} && _zimfw_print -R "${_zokay}${_zbold}${2}:${_znormal} Updated.${_zrestartmsg}"
|
||||
command mv -f ${1} ${2} && \
|
||||
_zimfw_print -PR "<%= okay %>%B${2}:%b Updated. Restart your terminal for changes to take effect."
|
||||
fi
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,46 +1,13 @@
|
|||
_zimfw_build_init() {
|
||||
local -r ztarget=${ZIM_HOME}/init.zsh
|
||||
# Force update of init.zsh if it's older than .zimrc
|
||||
if [[ ${ztarget} -ot ${_zconfig} ]]; then
|
||||
if [[ ${ztarget} -ot <%= home %>/.zimrc ]]; then
|
||||
command mv -f ${ztarget}{,.old} || return 1
|
||||
fi
|
||||
_zimfw_mv =(
|
||||
print -R '# FILE AUTOMATICALLY GENERATED FROM '${_zconfig}
|
||||
print '# EDIT THE SOURCE FILE AND THEN RUN zimfw build. DO NOT DIRECTLY EDIT THIS FILE!'
|
||||
print
|
||||
print -R 'if [[ -e ${ZIM_CONFIG_FILE:-<%= home %>/.zimrc} ]] zimfw() { source '${${(qqq)__ZIMFW_FILE}/${HOME}/\${HOME}}' "${@}" }'
|
||||
local zroot_dir zpre
|
||||
local -a zif_functions zif_cmds zroot_functions zroot_cmds
|
||||
local -a zfunctions=(${_zfunctions}) zcmds=(${_zcmds})
|
||||
# Keep fpath constant regardless of "if" root dirs, to avoid confusing compinit.
|
||||
# Move all from zfunctions and zcmds with "if" root dirs prefixes.
|
||||
for zroot_dir in ${_zroot_dirs}; do
|
||||
if (( ${+_zifs[${zroot_dir}]} )); then
|
||||
zpre=${zroot_dir}$'\0'
|
||||
zif_functions+=(${(M)zfunctions:#${zpre}*})
|
||||
zif_cmds+=(${(M)zcmds:#${zpre}*})
|
||||
zfunctions=(${zfunctions:#${zpre}*})
|
||||
zcmds=(${zcmds:#${zpre}*})
|
||||
fi
|
||||
done
|
||||
zpre=$'*\0'
|
||||
if (( ${#_zfpaths} )) print -R 'fpath=('${${(qqq)${_zfpaths#${~zpre}}:a}/${HOME}/\${HOME}}' ${fpath})'
|
||||
if (( ${#zfunctions} )) print -R 'autoload -Uz -- '${zfunctions#${~zpre}}
|
||||
for zroot_dir in ${_zroot_dirs}; do
|
||||
zpre=${zroot_dir}$'\0'
|
||||
if (( ${+_zifs[${zroot_dir}]} )); then
|
||||
zroot_functions=(${${(M)zif_functions:#${zpre}*}#${zpre}})
|
||||
zroot_cmds=(${${(M)zif_cmds:#${zpre}*}#${zpre}})
|
||||
if (( ${#zroot_functions} || ${#zroot_cmds} )); then
|
||||
print -R 'if '${_zifs[${zroot_dir}]}'; then'
|
||||
if (( ${#zroot_functions} )) print -R ' autoload -Uz -- '${zroot_functions}
|
||||
if (( ${#zroot_cmds} )) print -R ${(F):- ${^zroot_cmds}}
|
||||
print fi
|
||||
fi
|
||||
else
|
||||
zroot_cmds=(${${(M)zcmds:#${zpre}*}#${zpre}})
|
||||
if (( ${#zroot_cmds} )) print -R ${(F)zroot_cmds}
|
||||
fi
|
||||
done
|
||||
print -R "zimfw() { source ${ZIM_HOME}/zimfw.zsh \"\${@}\" }"
|
||||
if (( ${#_zfpaths} )) print -R 'fpath=('${_zfpaths:A}' ${fpath})'
|
||||
if (( ${#_zfunctions} )) print -R 'autoload -Uz '${_zfunctions}
|
||||
print -R ${(F)_zcmds}
|
||||
) ${ztarget}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,13 @@
|
|||
_zimfw_build_login_init() {
|
||||
# Array with unique dirs. ${ZIM_HOME} or any subdirectory should only occur once.
|
||||
local -Ur zscriptdirs=(${ZIM_HOME} ${${_zdirs##${ZIM_HOME}/*}:A})
|
||||
local -r zscriptglob=("${^zscriptdirs[@]}/(^*test*/)#*.zsh(|-theme)(N-.)")
|
||||
local -r ztarget=${ZIM_HOME}/login_init.zsh
|
||||
# Force update of login_init.zsh if it's older than .zimrc
|
||||
if [[ ${ztarget} -ot ${_zconfig} ]]; then
|
||||
if [[ ${ztarget} -ot <%= home %>/.zimrc ]]; then
|
||||
command mv -f ${ztarget}{,.old} || return 1
|
||||
fi
|
||||
_zimfw_mv =(
|
||||
print '# Do nothing. This file is deprecated.'
|
||||
print -Rn "<%= render_escaped("src/templates/login_init.zsh.erb") %>"
|
||||
) ${ztarget}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
_zimfw_build() {
|
||||
_zimfw_build_init && _zimfw_build_login_init && _zimfw_print 'Done with build.'
|
||||
_zimfw_build_init && _zimfw_build_login_init && _zimfw_print -P '<%= done %>Done with build.'
|
||||
}
|
||||
|
|
|
|||
155
src/stage2/30_zmodule.zsh.erb
Normal file
155
src/stage2/30_zmodule.zsh.erb
Normal file
|
|
@ -0,0 +1,155 @@
|
|||
zmodule() {
|
||||
local -r zusage="Usage: %B${0}%b <url> [%B-n%b|%B--name%b <module_name>] [options]
|
||||
|
||||
Add %Bzmodule%b calls to your %B${ZDOTDIR:-${HOME}}/.zimrc%b file to define the modules to be initialized.
|
||||
The modules are initialized in the same order they are defined.
|
||||
|
||||
<url> Module absolute path or repository URL. The following URL formats
|
||||
are equivalent: %Bname%b, %Bzimfw/name%b, %Bhttps://github.com/zimfw/name.git%b.
|
||||
%B-n%b|%B--name%b <module_name> Set a custom module name. Default: the last component in the <url>.
|
||||
|
||||
Repository options:
|
||||
%B-b%b|%B--branch%b <branch_name> Use specified branch when installing and updating the module.
|
||||
Overrides the tag option. Default: the repository's default branch.
|
||||
%B-t%b|%B--tag%b <tag_name> Use specified tag when installing and updating the module.
|
||||
Overrides the branch option.
|
||||
%B-z%b|%B--frozen%b Don't install or update the module.
|
||||
|
||||
Initialization options:
|
||||
%B-f%b|%B--fpath%b <path> Add specified path to fpath. The path is relative to the module
|
||||
root directory. Default: %Bfunctions%b, if the subdirectory exists.
|
||||
%B-a%b|%B--autoload%b <func_name> Autoload specified function. Default: all valid names inside the
|
||||
module's specified fpath paths.
|
||||
%B-s%b|%B--source%b <file_path> Source specified file. The file path is relative to the module root
|
||||
directory. Default: the file with largest size matching
|
||||
%B{init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}%b, if any exist.
|
||||
%B-c%b|%B--cmd%b <command> Execute specified command. Occurrences of the %B{}%b placeholder in the
|
||||
command are substituted by the module root directory path.
|
||||
%B-s 'script.zsh'%b and %B-c 'source {}/script.zsh'%b are equivalent.
|
||||
%B-d%b|%B--disabled%b Don't initialize or uninstall the module.
|
||||
"
|
||||
if [[ ${${funcfiletrace[1]%:*}:t} != .zimrc ]]; then
|
||||
print -u2 -PR "%F{red}${0}: Must be called from %B<%= home %>/.zimrc%b%f"$'\n\n'${zusage}
|
||||
return 1
|
||||
fi
|
||||
if (( ! # )); then
|
||||
print -u2 -PR "%F{red}<%= error %>${funcfiletrace[1]}: Missing zmodule url%f"$'\n\n'${zusage}
|
||||
_zfailed=1
|
||||
return 1
|
||||
fi
|
||||
setopt LOCAL_OPTIONS CASE_GLOB EXTENDED_GLOB
|
||||
local zmodule=${1:t} zurl=${1}
|
||||
local ztype zrev
|
||||
local -i zdisabled=0 zfrozen=0
|
||||
local -a zfpaths zfunctions zcmds
|
||||
local zarg zdir
|
||||
if [[ ${zurl} =~ ^[^:/]+: ]]; then
|
||||
zmodule=${zmodule%.git}
|
||||
elif [[ ${zurl} != /* ]]; then
|
||||
# Count number of slashes
|
||||
case ${#zurl//[^\/]/} in
|
||||
0) zurl="https://github.com/zimfw/${zurl}.git" ;;
|
||||
1) zurl="https://github.com/${zurl}.git" ;;
|
||||
esac
|
||||
fi
|
||||
shift
|
||||
if [[ ${1} == (-n|--name) ]]; then
|
||||
if (( # < 2 )); then
|
||||
print -u2 -PR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zmodule}:%b Missing argument for zmodule option ${1}%f"$'\n\n'${zusage}
|
||||
_zfailed=1
|
||||
return 1
|
||||
fi
|
||||
shift
|
||||
zmodule=${1}
|
||||
shift
|
||||
fi
|
||||
if [[ ${zurl} == /* ]]; then
|
||||
zdir=${zurl}
|
||||
else
|
||||
zdir=${ZIM_HOME}/modules/${zmodule}
|
||||
fi
|
||||
while (( # > 0 )); do
|
||||
case ${1} in
|
||||
-b|--branch|-t|--tag|-f|--fpath|-a|--autoload|-s|--source|-c|--cmd)
|
||||
if (( # < 2 )); then
|
||||
print -u2 -PR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zmodule}:%b Missing argument for zmodule option ${1}%f"$'\n\n'${zusage}
|
||||
_zfailed=1
|
||||
return 1
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
case ${1} in
|
||||
-b|--branch)
|
||||
shift
|
||||
ztype=branch
|
||||
zrev=${1}
|
||||
;;
|
||||
-t|--tag)
|
||||
shift
|
||||
ztype=tag
|
||||
zrev=${1}
|
||||
;;
|
||||
-z|--frozen) zfrozen=1 ;;
|
||||
-f|--fpath)
|
||||
shift
|
||||
zarg=${1}
|
||||
if [[ ${zarg} != /* ]] zarg=${zdir}/${zarg}
|
||||
zfpaths+=(${zarg})
|
||||
;;
|
||||
-a|--autoload)
|
||||
shift
|
||||
zfunctions+=(${1})
|
||||
;;
|
||||
-s|--source)
|
||||
shift
|
||||
zarg=${1}
|
||||
if [[ ${zarg} != /* ]] zarg=${zdir}/${zarg}
|
||||
zcmds+=("source ${zarg:A}")
|
||||
;;
|
||||
-c|--cmd)
|
||||
shift
|
||||
zcmds+=(${1//{}/${zdir:A}})
|
||||
;;
|
||||
-d|--disabled) zdisabled=1 ;;
|
||||
*)
|
||||
print -u2 -PR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zmodule}:%b Unknown zmodule option ${1}%f"$'\n\n'${zusage}
|
||||
_zfailed=1
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
if (( _zprepare_zargs )); then
|
||||
if (( ! zfrozen )); then
|
||||
_zmodules_zargs+=(${zmodule} ${zdir} ${zurl} "${ztype}" "${zrev}" ${_zprintlevel})
|
||||
fi
|
||||
else
|
||||
if (( zdisabled )); then
|
||||
_zdisableds+=(${zmodule})
|
||||
else
|
||||
if [[ ! -d ${zdir} ]]; then
|
||||
print -u2 -PR "%F{red}<%= error %>${funcfiletrace[1]}:%B${zmodule}:%b Not installed. Run %Bzimfw install%b to install.%f"
|
||||
_zfailed=1
|
||||
return 1
|
||||
fi
|
||||
if (( ! ${#zfpaths} )) zfpaths+=(${zdir}/functions(NF))
|
||||
if (( ! ${#zfunctions} )); then
|
||||
# _* functions are autoloaded by compinit
|
||||
# prompt_*_setup functions are autoloaded by promptinit
|
||||
zfunctions+=(${^zfpaths}/^(*~|*.zwc(|.old)|_*|prompt_*_setup)(N-.:t))
|
||||
fi
|
||||
if (( ! ${#zcmds} )); then
|
||||
local -r zscript=(${zdir}/(init.zsh|${zmodule:t}.(zsh|plugin.zsh|zsh-theme|sh))(NOL[1]))
|
||||
zcmds+=("source ${^zscript[@]:A}")
|
||||
fi
|
||||
if (( ! ${#zfpaths} && ! ${#zfunctions} && ! ${#zcmds} )); then
|
||||
print -u2 -PR "%F{yellow}<%= warn %>${funcfiletrace[1]}:%B${zmodule}:%b Nothing found to be initialized. Customize the module name or initialization with %Bzmodule%b options.%f"$'\n\n'${zusage}
|
||||
fi
|
||||
_zmodules+=(${zmodule})
|
||||
_zdirs+=(${zdir})
|
||||
_zfpaths+=(${zfpaths})
|
||||
_zfunctions+=(${zfunctions})
|
||||
_zcmds+=(${zcmds})
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,25 +1,13 @@
|
|||
_zimfw_source_zimrc() {
|
||||
<%= render_all("src/functions/*.erb") %>
|
||||
{
|
||||
local -r _zflags=${1}
|
||||
local -r ztarget=<%= home %>/.zimrc
|
||||
local -ri _zprepare_zargs=${1}
|
||||
local -i _zfailed=0
|
||||
if ! source ${_zconfig} || (( _zfailed )); then
|
||||
print -u2 -R "${_zred}Failed to source ${_zbold}${_zconfig}${_znormal}"
|
||||
if ! source ${ztarget} || (( _zfailed )); then
|
||||
print -u2 -PR "%F{red}<%= failed %>Failed to source %B${ztarget}%b%f"
|
||||
return 1
|
||||
fi
|
||||
if (( _zflags & 1 && ${#_znames} == 0 )); then
|
||||
print -u2 -R "${_zred}No modules defined in ${_zbold}${_zconfig}${_znormal}"
|
||||
if (( _zprepare_zargs && ! ${#_zmodules_zargs} )); then
|
||||
print -u2 -PR "%F{red}<%= failed %>No modules defined in %B${ztarget}%b%f"
|
||||
return 1
|
||||
fi
|
||||
# Remove all from _zfpaths, _zfunctions and _zcmds with disabled root dirs prefixes
|
||||
local zroot_dir zpre
|
||||
for zroot_dir in ${_zdisabled_root_dirs}; do
|
||||
zpre=${zroot_dir}$'\0'
|
||||
_zfpaths=(${_zfpaths:#${zpre}*})
|
||||
_zfunctions=(${_zfunctions:#${zpre}*})
|
||||
_zcmds=(${_zcmds:#${zpre}*})
|
||||
done
|
||||
} always {
|
||||
unfunction zmodule
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,18 +0,0 @@
|
|||
_zimfw_list_unuseds() {
|
||||
local -i i=1
|
||||
local zinstalled=(${ZIM_HOME}/modules/*(N/))
|
||||
local -r zdirs=(${(v)_zdirs})
|
||||
# Search into subdirectories
|
||||
while (( i <= ${#zinstalled} )); do
|
||||
if (( ${zdirs[(I)${zinstalled[i]}/*]} )); then
|
||||
zinstalled+=(${zinstalled[i]}/*(N/))
|
||||
zinstalled[i]=()
|
||||
else
|
||||
(( i++ ))
|
||||
fi
|
||||
done
|
||||
# Unused = all installed dirs not in zdirs
|
||||
_zunused_dirs=(${zinstalled:|zdirs})
|
||||
local zunused
|
||||
for zunused (${_zunused_dirs}) _zimfw_print -R "${_zbold}${zunused:t}:${_znormal} ${zunused}${1}"
|
||||
}
|
||||
18
src/stage2/40_zimfw_version_check.zsh.erb
Normal file
18
src/stage2/40_zimfw_version_check.zsh.erb
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
_zimfw_version_check() {
|
||||
if (( _zprintlevel > 0 )); then
|
||||
setopt LOCAL_OPTIONS EXTENDED_GLOB
|
||||
local -r ztarget=${ZIM_HOME}/.latest_version
|
||||
# If .latest_version does not exist or was not modified in the last 30 days
|
||||
if [[ -w ${ztarget:h} && ! -f ${ztarget}(#qNm-30) ]]; then
|
||||
command git ls-remote --tags --refs https://github.com/zimfw/zimfw.git 'v*' | \
|
||||
command sed 's?^.*/v??' | command sort -n -t. -k1,1 -k2,2 -k3,3 | \
|
||||
command tail -n1 >! ${ztarget} &!
|
||||
fi
|
||||
if [[ -f ${ztarget} ]]; then
|
||||
local -r zlatest_version=$(<${ztarget})
|
||||
if [[ -n ${zlatest_version} && ${_zversion} != ${zlatest_version} ]]; then
|
||||
print -u2 -PR "%F{yellow}Latest zimfw version is %B${zlatest_version}%b. You're using version %B${_zversion}%b. Run %Bzimfw upgrade%b to upgrade.%f"$'\n'
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
_zimfw_check_dumpfile() {
|
||||
_zimfw_print -u2 "${_zwarn}Deprecated action. This is now handled by the completion module alone.${_znormal}"
|
||||
}
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
_zimfw_check_version() {
|
||||
if (( ${1} )); then
|
||||
if (( ${2} )); then
|
||||
# background check
|
||||
if [[ -w ${_zversion_target:h} ]]; then
|
||||
print -R ${${${(f)"$(GIT_HTTP_LOW_SPEED_LIMIT=1000 GIT_HTTP_LOW_SPEED_TIME=30 command git ls-remote --tags --refs --sort=-v:refname \
|
||||
https://github.com/zimfw/zimfw.git 'v*' 2>/dev/null)"}##*v}[1]} >! ${_zversion_target} &!
|
||||
fi
|
||||
else
|
||||
# foreground check
|
||||
local tags
|
||||
tags=$(command git ls-remote --tags --refs --sort=-v:refname https://github.com/zimfw/zimfw.git 'v*') || return 1
|
||||
>! ${_zversion_target} <<<${${${(f)tags}##*v}[1]} || return 1
|
||||
fi
|
||||
fi
|
||||
if [[ -f ${_zversion_target} ]]; then
|
||||
local -r zlatest_version=$(<${_zversion_target})
|
||||
if [[ -n ${zlatest_version} && ${_zversion} != ${zlatest_version} ]]; then
|
||||
_zimfw_print -u2 -R "${_zyellow}Latest zimfw version is ${_zbold}${zlatest_version}${_znormalyellow}. You're using version ${_zbold}${_zversion}${_znormalyellow}. Run ${_zbold}zimfw upgrade${_znormalyellow} to upgrade.${_znormal}"
|
||||
return 4
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,8 +1,9 @@
|
|||
_zimfw_clean_compiled() {
|
||||
# Array with unique dirs. ${ZIM_HOME} or any subdirectory should only occur once.
|
||||
local -Ur zscriptdirs=(${ZIM_HOME:A} ${${(v)_zdirs##${ZIM_HOME:A}/*}:A})
|
||||
local -Ur zscriptdirs=(${ZIM_HOME} ${${_zdirs##${ZIM_HOME}/*}:A})
|
||||
local zopt
|
||||
if (( _zprintlevel > 0 )) zopt=-v
|
||||
command rm -f ${zopt} ${^zscriptdirs}/**/*.zwc(|.old)(N) && \
|
||||
_zimfw_print "Done with clean-compiled. Restart your terminal or run ${_zbold}zimfw compile${_znormal} to re-compile."
|
||||
if (( _zprintlevel > 0 )) zopt='-v'
|
||||
command rm -f ${zopt} ${^zscriptdirs}/**/*.zwc(|.old)(N) || return 1
|
||||
command rm -f ${zopt} <%= home %>/<%= startup_files_glob %>.zwc(|.old)(N) || return 1
|
||||
_zimfw_print -P '<%= done %>Done with clean-compiled. Run %Bzimfw compile%b to re-compile.'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
_zimfw_clean_dumpfile() {
|
||||
local zdumpfile zopt
|
||||
zstyle -s ':zim:completion' dumpfile 'zdumpfile' || zdumpfile=<%= home %>/.zcompdump
|
||||
if (( _zprintlevel > 0 )) zopt=-v
|
||||
command rm -f ${zopt} ${zdumpfile}(|.dat|.zwc(|.old))(N) && \
|
||||
_zimfw_print -R "Done with clean-dumpfile.${_zrestartmsg}"
|
||||
if (( _zprintlevel > 0 )) zopt='-v'
|
||||
command rm -f ${zopt} ${zdumpfile}(|.zwc(|.old))(N) || return 1
|
||||
_zimfw_print -P '<%= done %>Done with clean-dumpfile. Restart your terminal to dump an updated configuration.'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,5 @@
|
|||
_zimfw_compile() {
|
||||
# Compile zimfw scripts
|
||||
local zroot_dir zfile
|
||||
for zroot_dir in ${_zroot_dirs:|_zdisabled_root_dirs}; do
|
||||
if [[ ! -w ${zroot_dir} ]]; then
|
||||
_zimfw_print -R "${_zwarn}${_zbold}${zroot_dir}:${_znormalyellow} No write permission, unable to compile.${_znormal}"
|
||||
continue
|
||||
fi
|
||||
for zfile in ${zroot_dir}/(^*test*/)#*.zsh(|-theme)(N-.); do
|
||||
if [[ ! ${zfile}.zwc -nt ${zfile} ]]; then
|
||||
zcompile -UR ${zfile} && _zimfw_print -R "${_zokay}${_zbold}${zfile}.zwc:${_znormal} Compiled"
|
||||
fi
|
||||
done
|
||||
done
|
||||
_zimfw_print 'Done with compile.'
|
||||
local zopt
|
||||
if (( _zprintlevel <= 0 )) zopt='-q'
|
||||
source ${ZIM_HOME}/login_init.zsh ${zopt}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,6 @@
|
|||
_zimfw_info() {
|
||||
_zimfw_info_print_symlink 'zimfw config' ${_zconfig}
|
||||
_zimfw_info_print_symlink ZIM_HOME ${ZIM_HOME}
|
||||
_zimfw_info_print_symlink 'zimfw script' ${__ZIMFW_FILE}
|
||||
print -R 'zimfw version: '${_zversion}' (built at <%= Time.now.utc %>, previous commit is <%= `git rev-parse --short HEAD | tr -d '\r\n'` %>)'
|
||||
local zparam
|
||||
for zparam in LANG ${(Mk)parameters:#LC_*} OSTYPE TERM TERM_PROGRAM TERM_PROGRAM_VERSION ZSH_VERSION; do
|
||||
print -R ${(r.22....:.)zparam}${(P)zparam}
|
||||
done
|
||||
print -R 'ZIM_HOME: '${ZIM_HOME}
|
||||
print -R 'Zsh version: '${ZSH_VERSION}
|
||||
print -R 'System info: '$(command uname -a)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
_zimfw_info_print_symlink() {
|
||||
print -Rn ${(r.22....:.)1}${2}
|
||||
if [[ -L ${2} ]] print -Rn ' -> '${2:A}
|
||||
print
|
||||
}
|
||||
|
|
@ -1,17 +1,15 @@
|
|||
_zimfw_uninstall() {
|
||||
if (( _zprintlevel <= 0 )); then
|
||||
command rm -rf ${_zunused_dirs} || return 1
|
||||
else
|
||||
local zunused_dir
|
||||
print "Found ${_zbold}${#_zunused_dirs}${_znormal} unused module(s)."
|
||||
for zunused_dir in ${_zunused_dirs}; do
|
||||
if read -q "?Uninstall ${zunused_dir} [y/N]? "; then
|
||||
print
|
||||
command rm -rfv ${zunused_dir} || return 1
|
||||
else
|
||||
print
|
||||
local zopt
|
||||
if (( _zprintlevel > 0 )) zopt='-v'
|
||||
local zuninstalls=(${ZIM_HOME}/modules/*(N/:t))
|
||||
# Uninstall all installed modules not in _zmodules and _zdisableds
|
||||
zuninstalls=(${${zuninstalls:|_zmodules}:|_zdisableds})
|
||||
if (( ${#zuninstalls} )); then
|
||||
_zimfw_print -PR %B${(F)zuninstalls}%b
|
||||
if (( _zprintlevel <= 0 )) || read -q "?Uninstall ${#zuninstalls} module(s) listed above [y/N]? "; then
|
||||
_zimfw_print
|
||||
command rm -rf ${zopt} ${ZIM_HOME}/modules/${^zuninstalls} || return 1
|
||||
fi
|
||||
done
|
||||
print 'Done with uninstall.'
|
||||
fi
|
||||
_zimfw_print -P '<%= done %>Done with uninstall.'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,19 +1,14 @@
|
|||
_zimfw_upgrade() {
|
||||
local -r ztarget=${__ZIMFW_FILE:A} zurl=https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh.gz
|
||||
if [[ ! -w ${ztarget:h} ]]; then
|
||||
print -u2 -R "${_zred}No write permission to ${_zbold}${ztarget:h}${_znormalred}. Will not try to upgrade.${_znormal}"
|
||||
return 1
|
||||
fi
|
||||
local -r ztarget=${ZIM_HOME}/zimfw.zsh
|
||||
local -r zurl=https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh.gz
|
||||
{
|
||||
if (( ${+commands[curl]} )); then
|
||||
command curl -fsSL -o ${ztarget}.new.gz ${zurl} || return 1
|
||||
else
|
||||
local zopt
|
||||
if (( _zprintlevel <= 1 )) zopt=-q
|
||||
if (( _zprintlevel <= 1 )) zopt='-q'
|
||||
if ! command wget -nv ${zopt} -O ${ztarget}.new.gz ${zurl}; then
|
||||
if (( _zprintlevel <= 1 )); then
|
||||
print -u2 -R "${_zred}Failed to download ${_zbold}${zurl}${_znormalred}. Use ${_zbold}-v${_znormalred} option to see details.${_znormal}"
|
||||
fi
|
||||
if (( _zprintlevel <= 1 )) print -u2 -PR "%F{red}<%= error %>Error downloading %B${zurl}%b. Use %B-v%b option to see details.%f"
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
|
|
@ -21,7 +16,7 @@ _zimfw_upgrade() {
|
|||
# .latest_version can be outdated and will yield a false warning if zimfw is
|
||||
# upgraded before .latest_version is refreshed. Bad thing about having a cache.
|
||||
_zimfw_mv ${ztarget}{.new,} && command rm -f ${ZIM_HOME}/.latest_version && \
|
||||
_zimfw_print 'Done with upgrade.'
|
||||
_zimfw_print -P '<%= done %>Done with upgrade.'
|
||||
} always {
|
||||
command rm -f ${ztarget}.new{,.gz}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,44 +0,0 @@
|
|||
_zimfw_run_list() {
|
||||
local -r zname=${1}
|
||||
local -r zdir=${_zdirs[${zname}]}
|
||||
print -nR "${_zbold}${zname}:${_znormal} ${zdir}"
|
||||
if [[ -z ${_zurls[${zname}]} ]] print -n ' (external)'
|
||||
if (( ${_zfrozens[${zname}]} )) print -n ' (frozen)'
|
||||
if (( ${_zdisabled_root_dirs[(I)${zdir}]} )) print -n ' (disabled)'
|
||||
print
|
||||
if (( _zprintlevel > 1 )); then
|
||||
if [[ ${_zfrozens[${zname}]} -eq 0 && -n ${_zurls[${zname}]} ]]; then
|
||||
if [[ ${_ztools[${zname}]} == mkdir ]]; then
|
||||
print ' From: mkdir'
|
||||
else
|
||||
print -nR " From: ${_zurls[${zname}]}, "
|
||||
if [[ -z ${_zrevs[${zname}]} ]]; then
|
||||
print -n 'default branch'
|
||||
else
|
||||
print -nR "${_ztypes[${zname}]} ${_zrevs[${zname}]}"
|
||||
fi
|
||||
print -nR ", using ${_ztools[${zname}]}"
|
||||
if (( ! _zsubmodules[${zname}] )) print -n ', no git submodules'
|
||||
print
|
||||
fi
|
||||
if [[ -n ${_zonpulls[${zname}]} ]] print -R " On-pull: ${_zonpulls[${zname}]}"
|
||||
fi
|
||||
# Match the current module dir prefix from _zroot_dirs
|
||||
local -r zroot_dirs=(${(M)_zroot_dirs:#${zdir}/*})
|
||||
if (( ${#zroot_dirs} )); then
|
||||
print ' Additional root:'
|
||||
local zroot_dir
|
||||
for zroot_dir in ${zroot_dirs}; do
|
||||
print -nR " ${zroot_dir}"
|
||||
if (( ${_zdisabled_root_dirs[(I)${zroot_dir}]} )) print -n ' (disabled)'
|
||||
print
|
||||
done
|
||||
fi
|
||||
# Match and remove the prefix from _zfpaths, _zfunctions and _zcmds
|
||||
local -r zpre="${(q)zdir}(|/*)"$'\0'
|
||||
local -r zfpaths=(${${(M)_zfpaths:#${~zpre}*}#${~zpre}}) zfunctions=(${${(M)_zfunctions:#${~zpre}*}#${~zpre}}) zcmds=(${${(M)_zcmds:#${~zpre}*}#${~zpre}})
|
||||
if (( ${#zfpaths} )) print -R ' fpath: '${zfpaths}
|
||||
if (( ${#zfunctions} )) print -R ' autoload: '${zfunctions}
|
||||
if (( ${#zcmds} )) print -R ' cmd: '${(j:; :)zcmds}
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
_zimfw_create_dir() {
|
||||
if ! ERR=$(command mkdir -p ${1} 2>&1); then
|
||||
_zimfw_print_error "Error creating ${1}" ${ERR}
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
_zimfw_print_error() {
|
||||
print -u2 -lR $'<%= clear_line %>'"${_zerror}${_zbold}${_zname}:${_znormalred} ${1}${_znormal}" ${2:+${(F):- ${(f)^2}}}
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
_zimfw_print_okay() {
|
||||
if (( _zprintlevel > ${2:-0} )) print -lR $'<%= clear_line %>'"${_zokay}${_zbold}${_zname}:${_znormal} ${1}" ${3:+${(F):- ${(f)^3}}}
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
_zimfw_print_warn() {
|
||||
_zimfw_print -u2 -R $'<%= clear_line %>'"${_zwarn}${_zbold}${_zname}:${_znormalyellow} ${1}${_znormal}"
|
||||
}
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
_zimfw_pull_print_okay() {
|
||||
# Useb by tools, which run in a subshell
|
||||
if [[ -n ${ONPULL} ]]; then
|
||||
if ! ERR=$(builtin cd -q ${DIR} 2>&1 && builtin eval ${ONPULL} 2>&1); then
|
||||
_zimfw_print_error 'Error during on-pull' ${ERR}
|
||||
return 1
|
||||
elif [[ ${_zprintlevel} -gt 1 && -n ${ERR} ]]; then
|
||||
# Overrides ${3} to include the on-pull output, to be used by _zimfw_print_okay below.
|
||||
builtin set ${1} ${2:-0} ${3:+${3}$'\n'}'On-pull output:'$'\n'${ERR}
|
||||
fi
|
||||
fi
|
||||
_zimfw_print_okay "${@}"
|
||||
}
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
_zimfw_download_tarball() {
|
||||
if [[ ${URL} =~ <%= url_regex %> ]]; then
|
||||
readonly HOST=${match[3]}
|
||||
readonly REPO=${match[4]%.git}
|
||||
fi
|
||||
if [[ ${HOST} != github.com || -z ${REPO} ]]; then
|
||||
_zimfw_print_error "${URL} is not a valid URL. Will not try to ${ACTION}. The zimfw degit tool only supports GitHub URLs. Use zmodule option ${_zbold}--use git${_znormalred} to use git instead."
|
||||
return 1
|
||||
fi
|
||||
readonly HEADERS_TARGET=${DIR}/${TEMP}_headers
|
||||
{
|
||||
readonly INFO=("${(@f)"$(<${INFO_TARGET})"}")
|
||||
# Previous REV is in line 2, reserved for future use.
|
||||
readonly INFO_HEADER=${INFO[3]}
|
||||
readonly TARBALL_URL=https://api.github.com/repos/${REPO}/tarball/${REV}
|
||||
if [[ ${ACTION} == check ]]; then
|
||||
if [[ -z ${INFO_HEADER} ]] return 0
|
||||
if (( ${+commands[curl]} )); then
|
||||
command curl -IfsL -H ${INFO_HEADER} ${TARBALL_URL} >${HEADERS_TARGET}
|
||||
else
|
||||
command wget --spider -qS --header=${INFO_HEADER} ${TARBALL_URL} 2>${HEADERS_TARGET}
|
||||
fi
|
||||
else
|
||||
if (( ${+commands[curl]} )); then
|
||||
if ! ERR=$(command curl -fsSL ${INFO_HEADER:+-H} ${INFO_HEADER} -o ${TARBALL_TARGET} -D ${HEADERS_TARGET} ${TARBALL_URL} 2>&1); then
|
||||
_zimfw_print_error "Error downloading ${TARBALL_URL} with curl" ${ERR}
|
||||
return 1
|
||||
fi
|
||||
else
|
||||
# wget returns 8 when 304 Not Modified, so we cannot use wget's error codes
|
||||
command wget -qS ${INFO_HEADER:+--header=${INFO_HEADER}} -O ${TARBALL_TARGET} ${TARBALL_URL} 2>${HEADERS_TARGET}
|
||||
fi
|
||||
fi
|
||||
while IFS= read -r HEADER; do
|
||||
HEADER=${${HEADER## ##}%%$'\r'##}
|
||||
if [[ ${HEADER} == HTTP/* ]]; then
|
||||
HTTP_CODE=${${(s: :)HEADER}[2]}
|
||||
elif [[ ${${(L)HEADER%%:*}%% ##} == etag ]]; then
|
||||
ETAG=${${HEADER#*:}## ##}
|
||||
fi
|
||||
done < ${HEADERS_TARGET}
|
||||
if (( HTTP_CODE == 304 )); then
|
||||
# Not Modified
|
||||
command rm -f ${TARBALL_TARGET} 2>/dev/null
|
||||
return 0
|
||||
elif (( HTTP_CODE != 200 )); then
|
||||
_zimfw_print_error "Error downloading ${TARBALL_URL}, HTTP code ${HTTP_CODE}"
|
||||
return 1
|
||||
fi
|
||||
if [[ -z ${ETAG} ]]; then
|
||||
_zimfw_print_error "Error downloading ${TARBALL_URL}, no ETag header found in response"
|
||||
return 1
|
||||
fi
|
||||
if [[ ${ACTION} == check ]]; then
|
||||
command touch ${TARBALL_TARGET} # Update available
|
||||
else
|
||||
if ! print -lR "${URL}" "${REV}" "If-None-Match: ${ETAG}" >! ${INFO_TARGET} 2>/dev/null; then
|
||||
_zimfw_print_error "Error creating or updating ${INFO_TARGET}"
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
} always {
|
||||
command rm -f ${HEADERS_TARGET} 2>/dev/null
|
||||
}
|
||||
}
|
||||
|
||||
_zimfw_untar_tarball() {
|
||||
if ! ERR=$(command tar -C ${1} -xzf ${TARBALL_TARGET} 2>&1); then
|
||||
_zimfw_print_error "Error extracting ${TARBALL_TARGET}" ${ERR}
|
||||
return 1
|
||||
fi
|
||||
local zsubdir
|
||||
for zsubdir in ${1}/*(/); do
|
||||
if ! ERR=$(command mv -f ${zsubdir}/*(DN) ${1} 2>&1 && command rmdir ${zsubdir} 2>&1); then
|
||||
_zimfw_print_error "Error moving ${zsubdir}" ${ERR}
|
||||
return 1
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
_zimfw_tool_degit() {
|
||||
# This runs in a subshell
|
||||
readonly -i SUBMODULES=${6}
|
||||
readonly ACTION=${1} DIR=${2} URL=${3} REV=${5} ONPULL=${7} TEMP=.zdegit_${sysparams[pid]}_${RANDOM}
|
||||
readonly TARBALL_TARGET=${DIR}/${TEMP}_tarball.tar.gz INFO_TARGET=${DIR}/.zdegit
|
||||
case ${ACTION} in
|
||||
pre|prereinstall)
|
||||
local premsg
|
||||
if [[ ${ACTION} == pre ]] premsg=" Use zmodule option ${_zbold}-z${_znormalred}|${_zbold}--frozen${_znormalred} to disable this error or run ${_zbold}zimfw reinstall${_znormalred} to reinstall."
|
||||
if [[ -e ${DIR} ]]; then
|
||||
if [[ ! -r ${INFO_TARGET} ]]; then
|
||||
_zimfw_print_error $'Module was not installed using zimfw\'s degit.'${premsg}
|
||||
return 1
|
||||
fi
|
||||
readonly INFO=("${(@f)"$(<${INFO_TARGET})"}")
|
||||
if [[ ${URL} != ${INFO[1]} ]]; then
|
||||
_zimfw_print_error 'The zimfw degit URL does not match. Expected '${URL}.${premsg}
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
return 0
|
||||
;;
|
||||
install)
|
||||
{
|
||||
_zimfw_create_dir ${DIR} && _zimfw_download_tarball && _zimfw_untar_tarball ${DIR} && _zimfw_pull_print_okay Installed || return 1
|
||||
} always {
|
||||
# return 1 does not change ${TRY_BLOCK_ERROR}, only changes ${?}
|
||||
(( TRY_BLOCK_ERROR = ? ))
|
||||
command rm -f ${TARBALL_TARGET} 2>/dev/null
|
||||
if (( TRY_BLOCK_ERROR )) command rm -rf ${DIR} 2>/dev/null
|
||||
}
|
||||
;;
|
||||
check|update)
|
||||
readonly DIR_NEW=${DIR}${TEMP}
|
||||
{
|
||||
_zimfw_download_tarball || return 1
|
||||
if [[ ${ACTION} == check ]]; then
|
||||
if [[ -e ${TARBALL_TARGET} ]]; then
|
||||
_zimfw_print_okay 'Update available'
|
||||
return 4
|
||||
fi
|
||||
_zimfw_print_okay 'Already up to date' 1
|
||||
return 0
|
||||
else
|
||||
if [[ -e ${TARBALL_TARGET} ]]; then
|
||||
_zimfw_create_dir ${DIR_NEW} && _zimfw_untar_tarball ${DIR_NEW} || return 1
|
||||
if (( ${+commands[diff]} )); then
|
||||
LOG=$(command diff -x '.zdegit*' -x '*.zwc' -x '*.zwc.old' -qr ${DIR} ${DIR_NEW} 2>/dev/null)
|
||||
LOG=${${LOG//${DIR_NEW}/new}//${DIR}/old}
|
||||
fi
|
||||
if ! ERR=$({ command cp -f ${INFO_TARGET} ${DIR_NEW} && \
|
||||
command rm -rf ${DIR} && command mv -f ${DIR_NEW} ${DIR} } 2>&1); then
|
||||
_zimfw_print_error "Error updating ${DIR}" ${ERR}
|
||||
return 1
|
||||
fi
|
||||
_zimfw_pull_print_okay Updated 0 ${LOG} || return 1
|
||||
else
|
||||
_zimfw_pull_print_okay 'Already up to date' || return 1
|
||||
fi
|
||||
fi
|
||||
} always {
|
||||
command rm -f ${TARBALL_TARGET} 2>/dev/null
|
||||
command rm -rf ${DIR_NEW} 2>/dev/null
|
||||
}
|
||||
;;
|
||||
esac
|
||||
# Check after successful install or update
|
||||
if [[ ${SUBMODULES} -ne 0 && -e ${DIR}/.gitmodules ]]; then
|
||||
_zimfw_print_warn "Module contains git submodules, which are not supported by zimfw's degit. Use zmodule option ${_zbold}--no-submodules${_znormalyellow} to disable this warning."
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,103 +0,0 @@
|
|||
_zimfw_tool_git() {
|
||||
# This runs in a subshell
|
||||
readonly -i SUBMODULES=${6}
|
||||
readonly ACTION=${1} DIR=${2} URL=${3} TYPE=${4} ONPULL=${7}
|
||||
REV=${5}
|
||||
case ${ACTION} in
|
||||
pre|prereinstall)
|
||||
local premsg
|
||||
if [[ ${ACTION} == pre ]] premsg=" Use zmodule option ${_zbold}-z${_znormalred}|${_zbold}--frozen${_znormalred} to disable this error or run ${_zbold}zimfw reinstall${_znormalred} to reinstall."
|
||||
if [[ -e ${DIR} ]]; then
|
||||
if [[ ! -r ${DIR}/.git ]]; then
|
||||
_zimfw_print_error 'Module was not installed using git.'${premsg}
|
||||
return 1
|
||||
fi
|
||||
if [[ ${URL} != $(command git -C ${DIR} config --get remote.origin.url) ]]; then
|
||||
_zimfw_print_error 'The git URL does not match. Expected '${URL}.${premsg}
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
;;
|
||||
install)
|
||||
if ERR=$(command git clone ${REV:+-b} ${REV} -q --config core.autocrlf=false ${${SUBMODULES:#0}:+--recursive} -- ${URL} ${DIR} 2>&1); then
|
||||
_zimfw_pull_print_okay Installed
|
||||
else
|
||||
_zimfw_print_error 'Error during git clone' ${ERR}
|
||||
return 1
|
||||
fi
|
||||
;;
|
||||
check|update)
|
||||
if ! ERR=$(command git -C ${DIR} fetch -pqt origin 2>&1); then
|
||||
_zimfw_print_error 'Error during git fetch' ${ERR}
|
||||
return 1
|
||||
fi
|
||||
if [[ ${TYPE} == branch ]]; then
|
||||
if [[ -z ${REV} ]]; then
|
||||
# Get HEAD remote branch
|
||||
if ! ERR=$(command git -C ${DIR} remote set-head origin -a 2>&1); then
|
||||
_zimfw_print_error 'Error during git remote set-head' ${ERR}
|
||||
return 1
|
||||
fi
|
||||
if REV=$(command git -C ${DIR} symbolic-ref --short refs/remotes/origin/HEAD 2>&1); then
|
||||
REV=${REV#origin/}
|
||||
else
|
||||
_zimfw_print_error 'Error during git symbolic-ref' ${REV}
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
TO_REV=${REV}@{u}
|
||||
if [[ ${ACTION} == check ]]; then
|
||||
readonly -i BEHIND=$(command git -C ${DIR} rev-list --count ${REV}..${TO_REV} -- 2>/dev/null)
|
||||
if (( BEHIND )); then
|
||||
_zimfw_print_okay "Update available [behind ${BEHIND}]"
|
||||
return 4
|
||||
else
|
||||
_zimfw_print_okay 'Already up to date' 1
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
else
|
||||
if [[ ${REV} == $(command git -C ${DIR} describe --tags --exact-match 2>/dev/null) ]]; then
|
||||
if [[ ${ACTION} == check ]]; then
|
||||
_zimfw_print_okay 'Already up to date' 1
|
||||
return 0
|
||||
else
|
||||
_zimfw_pull_print_okay 'Already up to date'
|
||||
return ${?}
|
||||
fi
|
||||
fi
|
||||
if [[ ${ACTION} == check ]]; then
|
||||
_zimfw_print_okay 'Update available'
|
||||
return 4
|
||||
fi
|
||||
TO_REV=${REV}
|
||||
fi
|
||||
if [[ -z ${NO_COLOR} ]]; then
|
||||
LOG=$(command git -C ${DIR} log --graph --color --format='%C(yellow)%h%C(reset) %s %C(cyan)(%cr)%C(reset)' ..${TO_REV} -- 2>/dev/null)
|
||||
else
|
||||
LOG=$(command git -C ${DIR} log --graph --format='%h %s (%cr)' ..${TO_REV} -- 2>/dev/null)
|
||||
fi
|
||||
if ! ERR=$(command git -C ${DIR} checkout -q ${REV} -- 2>&1); then
|
||||
_zimfw_print_error 'Error during git checkout' ${ERR}
|
||||
return 1
|
||||
fi
|
||||
if [[ ${TYPE} == branch ]]; then
|
||||
if ! OUT=$(command git -C ${DIR} merge --ff-only --no-progress -n 2>&1); then
|
||||
_zimfw_print_error 'Error during git merge' ${OUT}
|
||||
return 1
|
||||
fi
|
||||
# keep just first line of OUT
|
||||
OUT=${OUT%%($'\n'|$'\r')*}
|
||||
else
|
||||
OUT="Updating to ${TYPE} ${REV}"
|
||||
fi
|
||||
if (( SUBMODULES )); then
|
||||
if ! ERR=$(command git -C ${DIR} submodule update --init --recursive -q -- 2>&1); then
|
||||
_zimfw_print_error 'Error during git submodule update' ${ERR}
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
_zimfw_pull_print_okay ${OUT} 0 ${LOG}
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
_zimfw_tool_mkdir() {
|
||||
# This runs in a subshell
|
||||
readonly -i SUBMODULES=${6}
|
||||
readonly ACTION=${1} DIR=${2} TYPE=${4} REV=${5} ONPULL=${7}
|
||||
if [[ ${ACTION} == (pre|prereinstall|check) ]] return 0
|
||||
if [[ -n ${REV} ]]; then
|
||||
_zimfw_print_warn "The zmodule option ${_zbold}-${TYPE[1]}${_znormalyellow}|${_zbold}--${TYPE}${_znormalyellow} has no effect when using the mkdir tool"
|
||||
fi
|
||||
if (( ! SUBMODULES )); then
|
||||
_zimfw_print_warn "The zmodule option ${_zbold}--no-submodules${_znormalyellow} has no effect when using the mkdir tool"
|
||||
fi
|
||||
if [[ ! -d ${DIR} || -n ${ONPULL} ]]; then
|
||||
_zimfw_create_dir ${DIR} && _zimfw_pull_print_okay Created || return 1
|
||||
fi
|
||||
}
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
_zimfw_run_tool() {
|
||||
local zaction=${1}
|
||||
local -r _zname=${2}
|
||||
if [[ -z ${_zurls[${_zname}]} ]]; then
|
||||
_zimfw_print_okay 'Skipping external module' 1
|
||||
return 0
|
||||
fi
|
||||
if (( _zfrozens[${_zname}] )); then
|
||||
_zimfw_print_okay 'Skipping frozen module' 1
|
||||
return 0
|
||||
fi
|
||||
local -r ztool=${_ztools[${_zname}]}
|
||||
if [[ ${ztool} != (degit|git|mkdir) ]]; then
|
||||
_zimfw_print_error "Unknown tool ${ztool}"
|
||||
return 1
|
||||
fi
|
||||
set "${_zdirs[${_zname}]}" "${_zurls[${_zname}]}" "${_ztypes[${_zname}]}" "${_zrevs[${_zname}]}" "${_zsubmodules[${_zname}]}" "${_zonpulls[${_zname}]}"
|
||||
if [[ ${zaction} == reinstall ]]; then
|
||||
_zimfw_tool_${ztool} prereinstall "${@}" && return 0
|
||||
if (( _zprintlevel > 0 )); then
|
||||
if read -q "?Reinstall ${_zname} [y/N]? "; then
|
||||
print
|
||||
else
|
||||
print
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
local -r zdir_new=.${_zdirs[${_zname}]}_${sysparams[pid]}_${RANDOM}
|
||||
_zimfw_print -nR 'Reinstalling '${_zname}'<%= ellipsis %>'
|
||||
{
|
||||
_zimfw_tool_${ztool} install ${zdir_new} "${@:2}" || return 1
|
||||
if ! ERR=$({ command rm -rf ${_zdirs[${_zname}]} && command mv -f ${zdir_new} ${_zdirs[${_zname}]} } 2>&1); then
|
||||
_zimfw_print_error "Error updating ${_zdirs[${_zname}]}" ${ERR}
|
||||
return 1
|
||||
fi
|
||||
} always {
|
||||
command rm -rf ${zdir_new} 2>/dev/null
|
||||
}
|
||||
return 0
|
||||
else
|
||||
_zimfw_tool_${ztool} pre "${@}" || return 1
|
||||
fi
|
||||
case ${zaction} in
|
||||
install)
|
||||
if [[ -e ${_zdirs[${_zname}]} ]]; then
|
||||
_zimfw_print_okay 'Skipping already installed module' 1
|
||||
return 0
|
||||
fi
|
||||
_zimfw_print -nR $'<%= clear_line %>Installing '${_zname}'<%= ellipsis %>'
|
||||
;;
|
||||
check|update)
|
||||
if [[ ! -d ${_zdirs[${_zname}]} ]]; then
|
||||
_zimfw_print_error "Not installed. Run ${_zbold}zimfw install${_znormalred} to install."
|
||||
return 1
|
||||
fi
|
||||
if [[ ${zaction} == check ]]; then
|
||||
if (( _zprintlevel > 1 )) print -nR $'<%= clear_line %>Checking '${_zname}'<%= ellipsis %>'
|
||||
else
|
||||
_zimfw_print -nR $'<%= clear_line %>Updating '${_zname}'<%= ellipsis %>'
|
||||
fi
|
||||
;;
|
||||
*)
|
||||
_zimfw_print_error "Unknown action ${zaction}"
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
_zimfw_tool_${ztool} ${zaction} "${@}"
|
||||
}
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
_zimfw_run_tool_action() {
|
||||
local -i zmaxprocs=0
|
||||
if [[ ${1} == reinstall ]] zmaxprocs=1
|
||||
_zimfw_source_zimrc 1 || return 1
|
||||
zargs -n 2 -P ${zmaxprocs} -- "${_znames[@]}" -- _zimfw_run_tool ${1}
|
||||
return 0
|
||||
}
|
||||
|
|
@ -1,122 +1,86 @@
|
|||
zimfw() {
|
||||
builtin emulate -L zsh -o EXTENDED_GLOB
|
||||
if [[ -z ${NO_COLOR} ]]; then
|
||||
local -r _znormal=$'\E[0m' _zbold=$'\E[1m' _zred=$'\E[31m' _znormalred=$'\E[0;31m' _zgreen=$'\E[32m' _zyellow=$'\E[33m' _znormalyellow=$'\E[0;33m'
|
||||
else
|
||||
local -r _znormal= _zbold= _zred= _znormalred= _zgreen= _zyellow= _znormalyellow=
|
||||
fi
|
||||
local -r _zerror="${_zred}<%= error %>" _zokay="${_zgreen}<%= okay %>${_znormal}" _zwarn="${_zyellow}<%= warn %>"
|
||||
local -r _zconfig=${ZIM_CONFIG_FILE:-<%= home %>/.zimrc} _zversion='<%= version %>'
|
||||
local -r zusage="Usage: ${_zbold}${0}${_znormal} <action> [${_zbold}-q${_znormal}|${_zbold}-v${_znormal}]
|
||||
local -r _zversion='<%= version %>'
|
||||
local -r zusage="Usage: %B${0}%b <action> [%B-q%b|%B-v%b]
|
||||
|
||||
Actions:
|
||||
${_zbold}build${_znormal} Build ${_zbold}${ZIM_HOME}/init.zsh${_znormal} and ${_zbold}${ZIM_HOME}/login_init.zsh${_znormal}.
|
||||
Also does ${_zbold}compile${_znormal}. Use ${_zbold}-v${_znormal} to also see its output.
|
||||
${_zbold}clean${_znormal} Clean all. Does both ${_zbold}clean-compiled${_znormal} and ${_zbold}clean-dumpfile${_znormal}.
|
||||
${_zbold}clean-compiled${_znormal} Clean Zsh compiled files.
|
||||
${_zbold}clean-dumpfile${_znormal} Clean completion dumpfile.
|
||||
${_zbold}compile${_znormal} Compile Zsh files.
|
||||
${_zbold}help${_znormal} Print this help.
|
||||
${_zbold}info${_znormal} Print zimfw and system info.
|
||||
${_zbold}list${_znormal} List all modules currently defined in ${_zbold}${_zconfig}${_znormal}.
|
||||
Use ${_zbold}-v${_znormal} to also see the modules details.
|
||||
${_zbold}init${_znormal} Same as ${_zbold}install${_znormal}, but with output tailored to be used at terminal startup.
|
||||
${_zbold}install${_znormal} Install new modules. Also does ${_zbold}build${_znormal}, ${_zbold}compile${_znormal}. Use ${_zbold}-v${_znormal} to also see their
|
||||
output, any on-pull output and skipped modules.
|
||||
${_zbold}reinstall${_znormal} Reinstall modules that failed check. Prompts for confirmation. Use ${_zbold}-q${_znormal} for
|
||||
quiet reinstall. Also does ${_zbold}build${_znormal}, ${_zbold}compile${_znormal}. Use ${_zbold}-v${_znormal} to also see their output,
|
||||
any on-pull output and skipped modules.
|
||||
${_zbold}uninstall${_znormal} Delete unused modules. Prompts for confirmation. Use ${_zbold}-q${_znormal} for quiet uninstall.
|
||||
${_zbold}check${_znormal} Check if updates for current modules are available. Use ${_zbold}-v${_znormal} to also see
|
||||
skipped and up to date modules.
|
||||
${_zbold}update${_znormal} Update current modules. Also does ${_zbold}build${_znormal}, ${_zbold}compile${_znormal}. Use ${_zbold}-v${_znormal} to also see their
|
||||
output, any on-pull output and skipped modules.
|
||||
${_zbold}check-version${_znormal} Check if a new version of zimfw is available.
|
||||
${_zbold}upgrade${_znormal} Upgrade zimfw. Also does ${_zbold}compile${_znormal}. Use ${_zbold}-v${_znormal} to also see its output.
|
||||
${_zbold}version${_znormal} Print zimfw version.
|
||||
%Bbuild%b Build %Binit.zsh%b and %Blogin_init.zsh%b
|
||||
%Bclean%b Clean all (see below)
|
||||
%Bclean-compiled%b Clean Zsh compiled files
|
||||
%Bclean-dumpfile%b Clean completion dump file
|
||||
%Bcompile%b Compile Zsh files
|
||||
%Bhelp%b Print this help
|
||||
%Binfo%b Print Zim and system info
|
||||
%Binstall%b Install new modules
|
||||
%Buninstall%b Delete unused modules
|
||||
%Bupdate%b Update current modules
|
||||
%Bupgrade%b Upgrade %Bzimfw.zsh%b
|
||||
%Bversion%b Print Zim version
|
||||
|
||||
Options:
|
||||
${_zbold}-q${_znormal} Quiet (yes to prompts and only outputs errors)
|
||||
${_zbold}-v${_znormal} Verbose (outputs more details)"
|
||||
local -Ua _znames _zroot_dirs _zdisabled_root_dirs
|
||||
local -A _zfrozens _ztools _zdirs _zurls _ztypes _zrevs _zsubmodules _zonpulls _zifs
|
||||
local -a _zfpaths _zfunctions _zcmds _zunused_dirs
|
||||
%B-q%b Quiet (yes to prompts, and only outputs errors)
|
||||
%B-v%b Verbose
|
||||
"
|
||||
local ztool
|
||||
local -a _zdisableds _zmodules _zdirs _zfpaths _zfunctions _zcmds _zmodules_zargs
|
||||
local -i _zprintlevel=1
|
||||
if (( # > 2 )); then
|
||||
print -u2 -lR "${_zred}${0}: Too many options${_znormal}" '' ${zusage}
|
||||
return 2
|
||||
print -u2 -PR "%F{red}${0}: Too many options%f"$'\n\n'${zusage}
|
||||
return 1
|
||||
elif (( # > 1 )); then
|
||||
case ${2} in
|
||||
-q) _zprintlevel=0 ;;
|
||||
-v) _zprintlevel=2 ;;
|
||||
*)
|
||||
print -u2 -lR "${_zred}${0}: Unknown option ${2}${_znormal}" '' ${zusage}
|
||||
return 2
|
||||
print -u2 -PR "%F{red}${0}: Unknown option ${2}%f"$'\n\n'${zusage}
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
|
||||
local -r _zversion_target=${ZIM_HOME}/.latest_version
|
||||
if ! zstyle -t ':zim' disable-version-check && \
|
||||
[[ ${1} != check-version && -w ${ZIM_HOME} && -w ${__ZIMFW_FILE:A:h} ]]
|
||||
then
|
||||
# If .latest_version does not exist or was not modified in the last 30 days
|
||||
[[ -f ${_zversion_target}(#qNm-30) ]]; local -r zversion_check_force=${?}
|
||||
_zimfw_check_version ${zversion_check_force} 1
|
||||
if ! zstyle -t ':zim' disable-version-check; then
|
||||
_zimfw_version_check
|
||||
fi
|
||||
|
||||
if [[ ! -w ${ZIM_HOME} && ${1} == (build|check|init|install|update|reinstall|check-version) ]]; then
|
||||
print -u2 -R "${_zred}${0}: No write permission to ${_zbold}${ZIM_HOME}${_znormalred}. Will not try to ${1}.${_znormal}"
|
||||
return 1
|
||||
fi
|
||||
local _zrestartmsg=' Restart your terminal for changes to take effect.'
|
||||
case ${1} in
|
||||
install)
|
||||
ztool="<%= render_escaped("src/tools/install.zsh.erb") %>"
|
||||
;;
|
||||
update)
|
||||
ztool="<%= render_escaped("src/tools/update.zsh.erb") %>"
|
||||
;;
|
||||
esac
|
||||
|
||||
case ${1} in
|
||||
build)
|
||||
_zimfw_source_zimrc 2 && _zimfw_build || return 1
|
||||
_zimfw_source_zimrc && _zimfw_build || return 1
|
||||
(( _zprintlevel-- ))
|
||||
_zimfw_compile
|
||||
;;
|
||||
check-dumpfile) _zimfw_check_dumpfile ;;
|
||||
clean) _zimfw_source_zimrc 0 && _zimfw_clean_compiled && _zimfw_clean_dumpfile ;;
|
||||
clean-compiled) _zimfw_source_zimrc 0 && _zimfw_clean_compiled ;;
|
||||
init) _zimfw_source_zimrc && _zimfw_build ;;
|
||||
clean) _zimfw_source_zimrc && _zimfw_clean_compiled && _zimfw_clean_dumpfile ;;
|
||||
clean-compiled) _zimfw_source_zimrc && _zimfw_clean_compiled ;;
|
||||
clean-dumpfile) _zimfw_clean_dumpfile ;;
|
||||
compile) _zimfw_source_zimrc 0 && _zimfw_compile ;;
|
||||
help) print -R ${zusage} ;;
|
||||
compile) _zimfw_source_zimrc && _zimfw_build_login_init && _zimfw_compile ;;
|
||||
help) print -PR ${zusage} ;;
|
||||
info) _zimfw_info ;;
|
||||
list)
|
||||
_zimfw_source_zimrc 3 && zargs -n 1 -- "${_znames[@]}" -- _zimfw_run_list && \
|
||||
_zimfw_list_unuseds ' (unused)'
|
||||
;;
|
||||
check)
|
||||
_zrestartmsg=
|
||||
_zimfw_run_tool_action ${1} || return 1
|
||||
install|update)
|
||||
_zimfw_source_zimrc 1 || return 1
|
||||
autoload -Uz zargs && \
|
||||
zargs -n 9 -P 10 -- "${_zmodules_zargs[@]}" -- zsh -c ${ztool} ${1} && \
|
||||
_zimfw_print -PR "<%= done %>Done with ${1}. Restart your terminal for any changes to take effect." || return 1
|
||||
(( _zprintlevel-- ))
|
||||
_zimfw_print -R "Done with ${1}." # Only printed in verbose mode
|
||||
_zimfw_source_zimrc && _zimfw_build && _zimfw_compile
|
||||
;;
|
||||
init)
|
||||
_zrestartmsg=
|
||||
_zimfw_run_tool_action install || return 1
|
||||
(( _zprintlevel-- ))
|
||||
_zimfw_print 'Done with install.' # Only printed in verbose mode
|
||||
_zimfw_source_zimrc 2 && _zimfw_build && _zimfw_compile
|
||||
;;
|
||||
install|update|reinstall)
|
||||
_zimfw_run_tool_action ${1} || return 1
|
||||
_zimfw_print -R "Done with ${1}.${_zrestartmsg}"
|
||||
(( _zprintlevel-- ))
|
||||
_zimfw_source_zimrc 2 && _zimfw_build && _zimfw_compile
|
||||
;;
|
||||
uninstall) _zimfw_source_zimrc 0 && _zimfw_list_unuseds && _zimfw_uninstall ;;
|
||||
check-version) _zimfw_check_version 1 ;;
|
||||
uninstall) _zimfw_source_zimrc && _zimfw_uninstall ;;
|
||||
upgrade)
|
||||
_zimfw_upgrade || return 1
|
||||
(( _zprintlevel-- ))
|
||||
_zimfw_source_zimrc 0 && _zimfw_compile
|
||||
_zimfw_compile
|
||||
;;
|
||||
version) print -R ${_zversion} ;;
|
||||
version) print -PR ${_zversion} ;;
|
||||
*)
|
||||
print -u2 -lR "${_zred}${0}: Unknown action ${1}${_znormal}" '' ${zusage}
|
||||
return 2
|
||||
print -u2 -PR "%F{red}${0}: Unknown action ${1}%f"$'\n\n'${zusage}
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
|
|
|||
23
src/templates/login_init.zsh.erb
Normal file
23
src/templates/login_init.zsh.erb
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
() {
|
||||
setopt LOCAL_OPTIONS CASE_GLOB EXTENDED_GLOB
|
||||
autoload -Uz zrecompile
|
||||
local zdumpfile zfile
|
||||
|
||||
# Compile the completion cache; significant speedup
|
||||
zstyle -s ':zim:completion' dumpfile 'zdumpfile' || zdumpfile=<%= home %>/.zcompdump
|
||||
if [[ -f ${zdumpfile} ]]; then
|
||||
zrecompile -p ${1} ${zdumpfile} || return 1
|
||||
fi
|
||||
|
||||
# Compile Zsh startup files
|
||||
for zfile in <%= home %>/<%= startup_files_glob %>(N-.); do
|
||||
zrecompile -p ${1} ${zfile} || return 1
|
||||
done
|
||||
|
||||
# Compile Zim scripts
|
||||
for zfile in #{zscriptglob}; do
|
||||
zrecompile -p ${1} ${zfile} || return 1
|
||||
done
|
||||
|
||||
if [[ ${1} != -q ]] print -P '<%= done %>Done with compile.'
|
||||
} "${@}"
|
||||
18
src/tools/install.zsh.erb
Normal file
18
src/tools/install.zsh.erb
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# This runs in a new shell
|
||||
readonly MODULE=${1}
|
||||
readonly DIR=${2}
|
||||
readonly URL=${3}
|
||||
readonly BRANCH=${5:+-b ${5}}
|
||||
readonly -i PRINTLEVEL=${6}
|
||||
readonly CLEAR_LINE=$'\E[2K\r'
|
||||
if [[ -e ${DIR} ]]; then
|
||||
# Already exists
|
||||
return 0
|
||||
fi
|
||||
if (( PRINTLEVEL > 0 )) print -Rn ${CLEAR_LINE}"Installing ${MODULE}<%= ellipsis %>"
|
||||
if ERR=$(command git clone ${=BRANCH} -q --recursive ${URL} ${DIR} 2>&1); then
|
||||
if (( PRINTLEVEL > 0 )) print -PR ${CLEAR_LINE}"<%= okay %>%B${MODULE}:%b Installed"
|
||||
else
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b Error during git clone%f"$'\n'${(F):- ${(f)^ERR}}
|
||||
return 1
|
||||
fi
|
||||
60
src/tools/update.zsh.erb
Normal file
60
src/tools/update.zsh.erb
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# This runs in a new shell
|
||||
readonly MODULE=${1}
|
||||
readonly DIR=${2}
|
||||
readonly URL=${3}
|
||||
readonly TYPE=${4:=branch}
|
||||
readonly REV=${5:=HEAD}
|
||||
readonly -i PRINTLEVEL=${6}
|
||||
readonly CLEAR_LINE=$'\E[2K\r'
|
||||
if (( PRINTLEVEL > 0 )) print -Rn ${CLEAR_LINE}"Updating ${MODULE}<%= ellipsis %>"
|
||||
if ! builtin cd -q ${DIR} 2>/dev/null; then
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b Not installed. Run %Bzimfw install%b to install.%f"
|
||||
return 1
|
||||
fi
|
||||
if [[ ${PWD} != $(command git rev-parse --show-toplevel 2>/dev/null) ]]; then
|
||||
# Not in repo root. Will not try to update.
|
||||
return 0
|
||||
fi
|
||||
if [[ ${URL} != $(command git config --get remote.origin.url) ]]; then
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b URL does not match. Expected ${URL}. Will not try to update.%f"
|
||||
return 1
|
||||
fi
|
||||
if [[ ${TYPE} == tag ]]; then
|
||||
if [[ ${REV} == $(command git describe --tags --exact-match 2>/dev/null) ]]; then
|
||||
if (( PRINTLEVEL > 0 )) print -PR ${CLEAR_LINE}"<%= okay %>%B${MODULE}:%b Already up to date"
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
if ! ERR=$(command git fetch -pq origin ${REV} 2>&1); then
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b Error during git fetch%f"$'\n'${(F):- ${(f)^ERR}}
|
||||
return 1
|
||||
fi
|
||||
if [[ ${TYPE} == branch ]]; then
|
||||
LOG_REV=${REV}@{u}
|
||||
else
|
||||
LOG_REV=${REV}
|
||||
fi
|
||||
LOG=$(command git log --graph --color --format='%C(yellow)%h%C(reset) %s %C(cyan)(%cr)%C(reset)' ..${LOG_REV} -- 2>/dev/null)
|
||||
if ! ERR=$(command git checkout -q ${REV} -- 2>&1); then
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b Error during git checkout%f"$'\n'${(F):- ${(f)^ERR}}
|
||||
return 1
|
||||
fi
|
||||
if [[ ${TYPE} == branch ]]; then
|
||||
if ! OUT=$(command git merge --ff-only --no-progress -n 2>&1); then
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b Error during git merge%f"$'\n'${(F):- ${(f)^OUT}}
|
||||
return 1
|
||||
fi
|
||||
# keep just first line of OUT
|
||||
OUT=${OUT%%($'\n'|$'\r')*}
|
||||
else
|
||||
OUT="Updating to ${TYPE} ${REV}"
|
||||
fi
|
||||
if ERR=$(command git submodule update --init --recursive -q 2>&1); then
|
||||
if (( PRINTLEVEL > 0 )); then
|
||||
if [[ -n ${LOG} ]] OUT=${OUT}$'\n'${(F):- ${(f)^LOG}}
|
||||
print -PR ${CLEAR_LINE}"<%= okay %>%B${MODULE}:%b ${OUT}"
|
||||
fi
|
||||
else
|
||||
print -u2 -PR ${CLEAR_LINE}"%F{red}<%= error %>%B${MODULE}:%b Error during git submodule update%f"$'\n'${(F):- ${(f)^ERR}}
|
||||
return 1
|
||||
fi
|
||||
|
|
@ -1,21 +1,18 @@
|
|||
<%
|
||||
class Zim
|
||||
attr_reader :version, :home, :min_zsh_version, :url_regex,
|
||||
:bold, :normal, :red, :normalred, :yellow, :normalyellow, :clear_line, :ellipsis, :okay, :warn, :error
|
||||
attr_reader :home, :min_zsh_version, :startup_files_glob, :version, :ellipsis, :okay, :warn, :error, :done, :failed
|
||||
|
||||
def initialize
|
||||
@version = "1.16.0-SNAPSHOT"
|
||||
@home = "${ZDOTDIR:-${HOME}}"
|
||||
@min_zsh_version = "5.2"
|
||||
# Matches {ssh,http,https,git}://{user@,}host/org/repo and {user@,}host:org/repo
|
||||
# but not file:///path/to/repo or /path/to/repo
|
||||
# ${match[3]} contains host, and ${match[4]} contains org/repo
|
||||
@url_regex = "^([^:@/]+://)?([^@]+@)?([^:/]+)[:/]([^/]+/[^/]+)/?$"
|
||||
@clear_line = "\\E[2K\\r"
|
||||
@startup_files_glob = ".z(shenv|profile|shrc|login|logout)"
|
||||
@version = "1.4.0"
|
||||
@ellipsis = " ..."
|
||||
@okay = ") "
|
||||
@okay = "%F{green})%f "
|
||||
@warn = "! "
|
||||
@error = "x "
|
||||
@done = ""
|
||||
@failed = ""
|
||||
end
|
||||
|
||||
def render(filename)
|
||||
|
|
@ -26,6 +23,10 @@ class Zim
|
|||
Dir[pattern].sort.map { |filename| render(filename) }.join("\n")
|
||||
end
|
||||
|
||||
def render_escaped(filename)
|
||||
render(filename).gsub(/(?=\$[^']|"|`)/, "\\\\").gsub(/#\{/, "$\{")
|
||||
end
|
||||
|
||||
def render_commented(filename)
|
||||
render(filename).gsub(/^(?=.)/, "# ").gsub(/^$/, "#")
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in a new issue