├── .github └── workflows │ ├── checklinks.yml │ └── superlinter.yml ├── .codeclimate.yml ├── README.md ├── autoupdate-zgen.plugin.zsh └── LICENSE.txt /.github/workflows/checklinks.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Check Markdown links 3 | 4 | on: push 5 | 6 | jobs: 7 | markdown-link-check: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v2.3.4 11 | - uses: gaurav-nelson/github-action-markdown-link-check@1.0.8 12 | with: 13 | use-verbose-mode: 'yes' 14 | base-branch: 'main' 15 | -------------------------------------------------------------------------------- /.github/workflows/superlinter.yml: -------------------------------------------------------------------------------- 1 | name: Super-Linter 2 | 3 | # Run this workflow every time a new commit pushed to your repository 4 | on: push 5 | 6 | jobs: 7 | # Set the job key. The key is displayed as the job name 8 | # when a job name is not provided 9 | super-lint: 10 | # Name the Job 11 | name: Lint code base 12 | # Set the type of machine to run on 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | # Checks out a copy of your repository on the ubuntu-latest machine 17 | - name: Checkout code 18 | uses: actions/checkout@v2 19 | 20 | # Runs the Super-Linter action 21 | - name: Run Super-Linter 22 | uses: github/super-linter@v3 23 | env: 24 | DEFAULT_BRANCH: main 25 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} -------------------------------------------------------------------------------- /.codeclimate.yml: -------------------------------------------------------------------------------- 1 | --- 2 | engines: 3 | pep8: 4 | enabled: true 5 | duplication: 6 | enabled: true 7 | config: 8 | languages: 9 | - "python" 10 | fixme: 11 | enabled: true 12 | exclude_paths: 13 | - config/engines.yml 14 | markdownlint: 15 | enabled: true 16 | checks: 17 | MD004: 18 | enabled: false 19 | MD013: 20 | enabled: false 21 | MD026: 22 | enabled: false 23 | MD029: 24 | enabled: false 25 | MD033: 26 | enabled: false 27 | shellcheck: 28 | enabled: true 29 | ratings: 30 | paths: 31 | - "**.md" 32 | exclude_paths: 33 | - .bundle/ 34 | - benchmarks/**/* 35 | - node_modules/**/* 36 | - bin/**/* 37 | - include/**/* 38 | - lib/**/* 39 | - License.md 40 | - spec/**/* 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # autoupdate-zgen 2 | 3 | ## Important - DEPRECATED 4 | 5 | [zgen](https://github.com/tarjoilija/zgen) is no longer getting updates. However, the [zgenom](https://github.com/jandamm/zgenom) fork is getting updates and new features, and is basically zgen but better. 6 | 7 | I recommend that you switch to zgenom and use the [autoupdate-zgenom](https://github.com/unixorn/autoupdate-zgenom/) plugin with it instead. 8 | 9 | This plugin will no longer get updates. 10 | ## Status 11 | 12 | [![License](https://img.shields.io/github/license/unixorn/autoupdate-zgen.svg)](https://opensource.org/licenses/Apache-2.0) 13 | [![Build Status](https://travis-ci.org/unixorn/autoupdate-zgen.svg?branch=master)](https://travis-ci.org/unixorn/autoupdate-zgen) 14 | [![GitHub stars](https://img.shields.io/github/stars/unixorn/autoupdate-zgen.svg)](https://github.com/unixorn/autoupdate-zgen/stargazers) 15 | [![Code Climate](https://codeclimate.com/github/unixorn/autoupdate-zgen/badges/gpa.svg)](https://codeclimate.com/github/unixorn/autoupdate-zgen) 16 | [![Issue Count](https://codeclimate.com/github/unixorn/autoupdate-zgen/badges/issue_count.svg)](https://codeclimate.com/github/unixorn/autoupdate-zgen) 17 | 18 | [zgen](https://github.com/tarjoilija/zgen) doesn't include an automatic update function like [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) does. 19 | 20 | **autoupdate-zgen** sets up easy automatic updating, both of zgenom or zgen and the plugins loaded in your configuration. 21 | 22 | Activate with `zgenom load unixorn/autoupdate-zgen` or `zgen load unixorn/autoupdate-zgen` and regenerate your `init.zsh` file. 23 | 24 | ## Configuration 25 | 26 | * Set `ZGEN_PLUGIN_UPDATE_DAYS` before calling the bundle if you don't want the default value of 7 days. 27 | * Set `ZGEN_SYSTEM_UPDATE_DAYS` before calling the bundle if you don't want the default value of 7 days. 28 | -------------------------------------------------------------------------------- /autoupdate-zgen.plugin.zsh: -------------------------------------------------------------------------------- 1 | # Copyright 2014-2021 Joe Block 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | _zgen-check-interval() { 16 | now=$(date +%s) 17 | if [[ ! -f ~/"${1}" ]]; then 18 | # We've never run, set the last run time to the dawn of time, or at 19 | # least the dawn of posix time. 20 | echo 0 > ~/"${1}" 21 | fi 22 | last_update=$(cat ~/"${1}") 23 | interval=$(expr ${now} - ${last_update}) 24 | echo "${interval}" 25 | } 26 | 27 | _zgen-check-for-updates() { 28 | if [ -z "${ZGEN_PLUGIN_UPDATE_DAYS}" ]; then 29 | ZGEN_PLUGIN_UPDATE_DAYS=7 30 | fi 31 | 32 | if [ -z "${ZGEN_SYSTEM_UPDATE_DAYS}" ]; then 33 | ZGEN_SYSTEM_UPDATE_DAYS=7 34 | fi 35 | 36 | if [ -z "${ZGEN_SYSTEM_RECEIPT_F}" ]; then 37 | if [ -n "${ZGEN_DIR}" ]; then 38 | # Since the $ZGEN_{SYSTEM|PLUGIN}_RECEIPT_F variables are with 39 | # respect to the home directory but $ZGEN_DIR is an absolute path, 40 | # $ZGEN_{SYSTEM|PLUGIN}_RECEIPT_F is set to $ZGEN_DIR (if it is defined) 41 | # with the $HOME directory as the prefix removed 42 | # (That's what the "${${ZGEN_DIR}#${HOME}}" syntax does: it removes the 43 | # "$HOME" prefix from "$ZGEN_DIR") 44 | ZGEN_SYSTEM_RECEIPT_F="${${ZGEN_DIR}#${HOME}}/.zgen_system_lastupdate" 45 | else 46 | ZGEN_SYSTEM_RECEIPT_F='.zgen_system_lastupdate' 47 | fi 48 | fi 49 | 50 | if [ -z "${ZGEN_PLUGIN_RECEIPT_F}" ]; then 51 | if [ -n "${ZGEN_DIR}" ]; then 52 | ZGEN_PLUGIN_RECEIPT_F="${${ZGEN_DIR}#${HOME}}/.zgen_plugin_lastupdate" 53 | else 54 | ZGEN_PLUGIN_RECEIPT_F='.zgen_plugin_lastupdate' 55 | fi 56 | fi 57 | 58 | local day_seconds=$(expr 24 \* 60 \* 60) 59 | local system_seconds=$(expr "${day_seconds}" \* "${ZGEN_SYSTEM_UPDATE_DAYS}") 60 | local plugins_seconds=$(expr ${day_seconds} \* ${ZGEN_PLUGIN_UPDATE_DAYS}) 61 | 62 | local last_plugin=$(_zgen-check-interval ${ZGEN_PLUGIN_RECEIPT_F}) 63 | local last_system=$(_zgen-check-interval ${ZGEN_SYSTEM_RECEIPT_F}) 64 | 65 | if [[ ${last_plugin} -gt ${plugins_seconds} ]]; then 66 | if [[ ! -z "${ZGEN_AUTOUPDATE_VERBOSE}" ]]; then 67 | echo "It has been $(expr ${last_plugin} / $day_seconds) days since your zgen plugins were updated" 68 | echo "Updating plugins" 69 | fi 70 | zgen update 71 | date +%s >! ~/${ZGEN_PLUGIN_RECEIPT_F} 72 | fi 73 | 74 | if [[ ${last_system} -gt ${system_seconds} ]]; then 75 | if [[ ! -z "${ZGEN_AUTOUPDATE_VERBOSE}" ]]; then 76 | echo "It has been $(expr ${last_plugin} / ${day_seconds}) days since your zgen was updated" 77 | echo "Updating zgen..." 78 | fi 79 | zgen selfupdate 80 | date +%s >! ~/${ZGEN_SYSTEM_RECEIPT_F} 81 | fi 82 | } 83 | 84 | # Don't update if we're running as different user than whoever 85 | # owns ~/.zgen. This prevents sudo runs from leaving root-owned 86 | # files & directories in ~/.zgen that will break future updates 87 | # by the user. 88 | # 89 | # Use ls and awk instead of stat because stat has incompatible arguments 90 | # on linux, macOS and FreeBSD. 91 | local zgen_owner=$(ls -ld ${ZGEN_DIR:-$HOME/.zgen} | awk '{print $3}') 92 | if [[ "$zgen_owner" == "$USER" ]]; then 93 | zmodload zsh/system 94 | lockfile=~/.zgen_autoupdate_lock 95 | touch "$lockfile" 96 | if ! which zsystem &> /dev/null || zsystem flock -t 1 "$lockfile"; then 97 | _zgen-check-for-updates 98 | command rm -f "$lockfile" 99 | fi 100 | unset lockfile 101 | fi 102 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | 204 | Copyright 2014-2020 Joseph Block 205 | 206 | Licensed under the Apache License, Version 2.0 (the "License"); 207 | you may not use this file except in compliance with the License. 208 | You may obtain a copy of the License at 209 | 210 | http://www.apache.org/licenses/LICENSE-2.0 211 | 212 | Unless required by applicable law or agreed to in writing, software 213 | distributed under the License is distributed on an "AS IS" BASIS, 214 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 215 | See the License for the specific language governing permissions and 216 | limitations under the License. 217 | --------------------------------------------------------------------------------