Test/lint

.gitattributes

@@ -0,0 +1,35 @@
+# Auto detect text files and perform LF normalization so files in repo had LF and client translates to CRLF on Windows
+* text=auto
+
+*.sh text eol=lf
+*.cs text diff=csharp
+*.md text diff=markdown
+*.zsh text diff=zsh eol=lf
+
+*.gitattributes text
+.gitignore text
+
+###############################
+# Git Large File System (LFS) #
+###############################
+
+#*.7z filter=lfs diff=lfs merge=lfs -text
+#*.br filter=lfs diff=lfs merge=lfs -text
+#*.gz filter=lfs diff=lfs merge=lfs -text
+#*.tar filter=lfs diff=lfs merge=lfs -text
+#*.zip filter=lfs diff=lfs merge=lfs -text
+#*.pdf filter=lfs diff=lfs merge=lfs -text
+
+#*.gif filter=lfs diff=lfs merge=lfs -text
+#*.ico filter=lfs diff=lfs merge=lfs -text
+#*.jpg filter=lfs diff=lfs merge=lfs -text
+#*.png filter=lfs diff=lfs merge=lfs -text
+#*.psd filter=lfs diff=lfs merge=lfs -text
+#*.webp filter=lfs diff=lfs merge=lfs -text
+#*.woff2 filter=lfs diff=lfs merge=lfs -text
+
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitkeep export-ignore
+
+*.gitattributes linguist-language=gitattributes

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 * @z-shell
-* @ss-o
+* @ss-o

.gitignore

@@ -1,3 +1,4 @@
+# VSCODE workspace
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
@@ -7,3 +8,93 @@
 
 # Local History for Visual Studio Code
 .history/
+
+# Repository spevcific files
+test/
+txt/
+*.txt
+*.zwc
+*.zini
+.ycm_extra_conf.py
+*deploy*key*
+*.bundle
+site*/
+other
+TODO*
+tags
+TAGS
+*.o
+*.o.c
+*.orig
+*.a
+*.so
+*.dll
+*~
+.*.sw?
+\#*
+
+CVS
+.#*
+
+# Zmodules
+zmodules/COMPILED_AT
+zmodules/Src/*.epro
+zmodules/Src/*.export
+zmodules/Src/*.mdh
+zmodules/Src/*.mdh.tmp
+zmodules/Src/*.mdhi
+zmodules/Src/*.mdhs
+zmodules/Src/*.syms
+zmodules/Src/*.dSYM
+zmodules/Src/Makemod.in
+zmodules/Src/Makemod
+zmodules/Src/[_a-zA-Z0-9]*.pro
+zmodules/Src/ansi2knr
+zmodules/Src/bltinmods.list
+zmodules/Src/cscope.out
+zmodules/Src/libzsh.so*
+zmodules/Src/modules-bltin
+zmodules/Src/modules.index
+zmodules/Src/modules.index.tmp
+zmodules/Src/modules.stamp
+zmodules/Src/patchlevel.h
+zmodules/Src/sigcount.h
+zmodules/Src/signames.c
+zmodules/Src/signames2.c
+zmodules/Src/stamp-modobjs
+zmodules/Src/stamp-modobjs.tmp
+zmodules/Src/tags
+zmodules/Src/TAGS
+zmodules/Src/version.h
+zmodules/Src/zshcurses.h
+zmodules/Src/zshpaths.h
+zmodules/Src/zshterm.h
+zmodules/Src/zshxmods.h
+zmodules/Src/zshell/Makefile.in
+zmodules/Src/zshell/*.export
+zmodules/Src/zshell/so_locations
+zmodules/Src/zshell/*.pro
+zmodules/Src/zshell/*.epro
+zmodules/Src/zshell/*.syms
+zmodules/Src/zshell/*.dSYM
+zmodules/Src/zshell/*.mdh
+zmodules/Src/zshell/*.mdhi
+zmodules/Src/zshell/*.mdhs
+zmodules/Src/zshell/*.mdh.tmp
+zmodules/Src/zshell/errnames.c
+zmodules/Src/zshell/errcount.h
+zmodules/Src/zshell/curses_keys.h
+zmodules/Config/defs.mk
+zmodules/Test/*.tmp
+
+/zmodules/META-FAQ
+/zmodules/config.cache
+/zmodules/config.h
+/zmodules/config.log
+/zmodules/config.modules
+/zmodules/config.modules.sh
+/zmodules/config.status
+/zmodules/config.status.lineno
+/zmodules/cscope.out
+/zmodules/stamp-h
+/zmodules/autom4te.cache

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: /~https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-merge-conflict
+      - id: no-commit-to-branch
+        name: Don't commit to main branch
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+        args: [--allow-multiple-documents]
+  #  - repo: /~https://github.com/koalaman/shellcheck-precommit
+  #    rev: v0.8.0
+  #    hooks:
+  #      - id: shellcheck
+  #            args: ["--severity=warning"]
+  #  - repo: /~https://github.com/thlorenz/doctoc
+  #    rev: v2.1.0
+  #    hooks:
+  #      - id: doctoc
+  - repo: /~https://github.com/pre-commit/mirrors-prettier
+    rev: v2.4.1
+    hooks:
+      - id: prettier

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021, Salvdas Lukosius & Z-Shell ZI Community
+Copyright (c) 2021, Salvydas Lukosius & Z-Shell ZI Community
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,38 @@
+all: zinit.zsh.zwc zinit-side.zsh.zwc zinit-install.zsh.zwc zinit-autoload.zsh.zwc
+
+%.zwc: %
+	lib/zcompile $<
+
+#alltest: test testB testC testD testE
+#test:
+#	make VERBOSE=$(VERBOSE) NODIFF=$(NODIFF) DEBUG=$(DEBUG) OPTDUMP=$(OPTDUMP) OPTS=$(OPTS) -C test test
+#testB:
+#	make VERBOSE=$(VERBOSE) NODIFF=$(NODIFF) DEBUG=$(DEBUG) OPTDUMP=$(OPTDUMP) OPTS="kshglob" -C test test
+#testC:
+#	make VERBOSE=$(VERBOSE) NODIFF=$(NODIFF) DEBUG=$(DEBUG) OPTDUMP=$(OPTDUMP) OPTS="noextendedglob" -C test test
+#testD:
+#	make VERBOSE=$(VERBOSE) NODIFF=$(NODIFF) DEBUG=$(DEBUG) OPTDUMP=$(OPTDUMP) OPTS="ksharrays" -C test test
+#testE:
+#	make VERBOSE=$(VERBOSE) NODIFF=$(NODIFF) DEBUG=$(DEBUG) OPTDUMP=$(OPTDUMP) OPTS="ignoreclosebraces" -C test test
+
+doc: zinit.zsh zinit-side.zsh zinit-install.zsh zinit-autoload.zsh
+	rm -rf docs/zsdoc/data docs/zsdoc/*.adoc
+	cd docs && \
+	zsd -v --scomm --cignore \
+	'(\#*FUNCTION:*{{{*|\#[[:space:]]#}}}*)' \
+	../zinit.zsh ../zinit-side.zsh ../zinit-install.zsh ../zinit-autoload.zsh
+	cd ..
+
+html: adoc
+	cd docs/zsdoc && \
+	asciidoctor zinit.zsh.adoc && \
+	asciidoctor zinit-side.zsh.adoc && \
+	asciidoctor zinit-install.zsh.adoc && \
+	asciidoctor zinit-autoload.zsh.adoc
+	cd ..
+
+clean:
+	rm -f zinit.zsh.zwc zinit-side.zsh.zwc zinit-install.zsh.zwc zinit-autoload.zsh.zwc
+	rm -rf docs/zsdoc/data
+
+.PHONY: all clean doc

README.md

@@ -15,8 +15,9 @@
 <br />
 
 [![Project license](https://img.shields.io/github/license/z-shell/zi.svg?style=flat-square)](LICENSE) [![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](/~https://github.com/z-shell/zi/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+
 </div>
-  
+
 <details>
 <summary>Table of Contents</summary>
 
@@ -26,12 +27,11 @@
 - [Usage](#usage)
 - [Roadmap](#roadmap)
 - [Support](#support)
-- [Project assistance](#project-assistance)
 - [Contributing](#contributing)
 - [Authors & contributors](#authors--contributors)
+- [Project assistance](#project-assistance)
 - [Security](#security)
 - [About](#about)
-- [License](#license)
 - [Acknowledgements](#acknowledgements)
 
 </details>
@@ -43,18 +43,17 @@
 ### Prerequisites
 
 > **[?]**
-> What are the project requirements/dependencies?
+> Work in progress.
 
 ### Installation
 
 > **[?]**
-> Describe how to install and get started with the project.
+> Work in progress.
 
 ## Usage
 
 > **[?]**
-> How does one go about using it?
-> Provide various use cases and code examples here.
+> Work in progress.
 
 ## Roadmap
 
@@ -74,46 +73,40 @@ Reach out to the maintainer at one of the following places:
 - [GitHub Discussions](/~https://github.com/z-shell/zi/discussions)
 - Contact options listed on [this GitHub profile](/~https://github.com/z-shell)
 
-## Project assistance
-
-If you want to say **thank you** or/and support active development of Z-Shell ZI:
-
-- Add a [GitHub Star](/~https://github.com/z-shell/zi) to the project.
-- Tweet about the Z-Shell ZI.
-- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.
-
-Together, we can make Z-Shell ZI **better**!
-
 ## Contributing
 
 First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
 
-Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!
+Please read [our contribution guidelines](../docs/CONTRIBUTING.md), and thank you for being involved!
 
 ## Authors & contributors
 
 The original setup of this repository is by [Z-Shell ZI Community](/~https://github.com/z-shell).
 
 For a full list of all authors and contributors, see [the contributors page](/~https://github.com/z-shell/zi/contributors).
 
+## Project assistance
+
+If you want to say **thank you** or/and support active development of Z-Shell ZI:
+
+- Add a [GitHub Star](/~https://github.com/z-shell/zi) to the project.
+- Tweet about the Z-Shell ZI.
+- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.
+
+Together, we can make Z-Shell ZI **better**!
+
 ## Security
 
 Z-Shell ZI follows good practices of security, but 100% security cannot be assured.
 Z-Shell ZI is provided **"as is"** without any **warranty**. Use at your own risk.
 
-_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._
+_For more information and to report security issues, please refer to our [security documentation](../docs/SECURITY.md)._
 
 ## About
 
 > **[?]**
-> ZI is a flexible integration manager for Z shell [(Zsh)](https://zsh.sourceforge.io/) (previously known as Zinit).
-> Z-Shell ZI is an open source community project released under the [MIT License](LICENSE).
-
-## License
-
-This project is licensed under the **MIT license**.
-
-See [LICENSE](LICENSE) for more information.
+> ZI (previously known as Zinit) is a flexible integration manager for Z shell [(Zsh)](https://zsh.sourceforge.io/).
+> Z-Shell ZI is an open source community project released under the [MIT License](../LICENSE).
 
 ## Acknowledgements
 

docs/CONTRIBUTING.md

@@ -41,4 +41,4 @@ that relate to your submission. You don't want to duplicate effort.
 3. Create your feature branch (`git checkout -b feat/amazing_feature`)
 4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) Z-Shell ZI uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.
 5. Push to the branch (`git push origin feat/amazing_feature`)
-6. [Open a Pull Request](/~https://github.com/z-shell/zi/compare?expand=1)
+6. [Open a Pull Request](/~https://github.com/z-shell/zi/compare?expand=1)

docs/man/zi.1

@@ -907,4 +907,4 @@ Whant to learn more?
 See Z-Shell News Blog: \fBhttps://z-shell.github.io\fR
 .RE 0
 
-.P
+.P

docs/zsdoc/Makefile

@@ -0,0 +1,53 @@
+# This Makefile is to convert supplied Asciidoc files into
+# other formats like pdf and man. The files contain ZI's
+# code documentation.
+# *.adoc files are generated root directory Makefile.
+
+all: man pdf
+
+# MAN
+# Converted with a2x from asciidoc package
+
+man: man/zinit.zsh.1 man/zinit-side.zsh.1 man/zinit-install.zsh.1 man/zinit-autoload.zsh.1
+
+man/zinit.zsh.1:
+	@mkdir -p man
+	a2x --verbose -L --doctype manpage --format manpage -D man zinit.zsh.adoc
+
+man/zinit-side.zsh.1:
+	@mkdir -p man
+	a2x --verbose -L --doctype manpage --format manpage -D man zinit-side.zsh.adoc
+
+man/zinit-install.zsh.1:
+	@mkdir -p man
+	a2x --verbose -L --doctype manpage --format manpage -D man zinit-install.zsh.adoc
+
+man/zinit-autoload.zsh.1:
+	@mkdir -p man
+	a2x --verbose -L --doctype manpage --format manpage -D man zinit-autoload.zsh.adoc
+
+# PDF
+# Uses asciidoctor not a2x (i.e. not asciidoc)
+
+pdf: pdf/zinit.zsh.pdf pdf/zinit-side.zsh.pdf pdf/zinit-install.zsh.pdf pdf/zinit-autoload.zsh.pdf
+
+pdf/zinit.zsh.pdf:
+	@mkdir -p pdf
+	asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit.zsh.adoc
+
+pdf/zinit-side.zsh.pdf:
+	@mkdir -p pdf
+	asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit-side.zsh.adoc
+
+pdf/zinit-install.zsh.pdf:
+	@mkdir -p pdf
+	asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit-install.zsh.adoc
+
+pdf/zinit-autoload.zsh.pdf:
+	@mkdir -p pdf
+	asciidoctor -a reproducible -b pdf -r asciidoctor-pdf -D pdf zinit-autoload.zsh.adoc
+
+clean:
+	rm -rf man pdf data
+
+.PHONY: man pdf clean