Initial commit

new file: .editorconfig new file: .gitattributes new file: .github/.markdownlint.yaml new file: .github/dependabot.yml new file: .github/workflows-disabled/assessor.yml new file: .github/workflows-disabled/wiki-sync.yml new file: .github/workflows-disabled/wiki-zi.yml new file: .github/workflows-disabled/wiki-zsh.yml new file: .github/workflows/code.yml new file: .github/workflows/push-code.yml new file: .github/workflows/trunk-check.yml new file: .gitignore new file: .gitmodules new file: .markdownlint.yaml new file: .trunk/bin/trunk new file: .trunk/trunk.yaml new file: .vscode/settings.json new file: LICENSE new file: code/Makefile
z-shell · Jun 9, 2022 · 1e9fec3 · 1e9fec3
commit 1e9fec3
Show file tree

Hide file tree

Showing 105 changed files with 35,244 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,57 @@
+# # Space or Tabs?
+# https://stackoverflow.com/questions/35649847/objective-reasons-for-using-spaces-instead-of-tabs-for-indentation
+# https://stackoverflow.com/questions/12093748/how-to-use-tabs-instead-of-spaces-in-a-shell-script
+#
+# Note: VIM users should use alternate marks [[[ and ]]] as the original ones can confuse nested substitutions, e.g.: ${${${VAR}}}
+#
+# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*-
+# vim: ft=zsh sw=2 ts=2 et
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md,rst}]
+trim_trailing_whitespace = false
+
+[*.{sh,bash,zsh,fish}]
+indent_style = space
+indent_size = 2
+tab_width = 2
+
+[Makefile]
+indent_style = tab
+indent_size = 4
+
+[*.{xml,json}]
+indent_style = space
+indent_size = 2
+
+[*.{css,less}]
+indent_style = space
+indent_size = 2
+
+[*.{js,jsx,html,sass}]
+indent_style = tab
+indent_size = 4
+
+[*.{py,rb}]
+indent_style = space
+indent_size = 4
+
+[*.{go,java,scala,groovy,kotlin}]
+indent_style = tab
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+tab_width = 2
+
+[CHANGELOG.md]
+indent_style = tab
+indent_size = 4
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+* text=auto
+*.md diff=markdown
+*.zsh text eol=lf diff=zsh
diff --git a/.github/.markdownlint.yaml b/.github/.markdownlint.yaml
@@ -0,0 +1,11 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false
+MD041: false
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,12 @@
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "gitsubmodule"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows-disabled/assessor.yml b/.github/workflows-disabled/assessor.yml
@@ -0,0 +1,39 @@
+name: 🏅 Plugin Assessor
+
+on:
+  schedule:
+    - cron: "30 03 01 */3 *"
+  workflow_dispatch:
+
+env:
+  TERM: xterm-256color
+
+jobs:
+  run-assessor:
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          submodules: recursive
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
+          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+      - name: 📦 Dependencies
+        run: sudo apt-get update && sudo apt-get upgrade -yq && sudo apt-get install zsh -yq
+      - name: 🚀 Run Assessor
+        run: |
+          ./render.zsh
+        working-directory: docs/zsh-plugins-commit-top
+      - name: ☑️ Commit files
+        run: |
+          cp -vf docs/zsh-plugins-commit-top/README.md wiki/zi/06-knowledge-base/Zsh-Plugins-Commit-TOP.md
+          git config --local user.email "[email protected]"
+          git config --local user.name " digital-teams [bot]"
+          git add docs/zsh-plugins-commit-top/README.md wiki/zi/06-knowledge-base/Zsh-Plugins-Commit-TOP.md
+          git commit --allow-empty -m "Zsh Plugins commit update" -a
+      - name: 📤 Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
diff --git a/.github/workflows-disabled/wiki-sync.yml b/.github/workflows-disabled/wiki-sync.yml
@@ -0,0 +1,49 @@
+---
+name: 📖 Wiki Sync
+
+on:
+  push:
+    paths:
+      - "docs/wiki/**"
+  repository_dispatch:
+    types: [docs]
+  gollum:
+
+env:
+  GIT_AUTHOR_NAME: ZI Actionbot
+  GIT_AUTHOR_EMAIL: [email protected]
+
+jobs:
+  job-sync-docs-to-wiki:
+    runs-on: ubuntu-latest
+    if: github.event_name != 'gollum'
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+      - name: 📤 Sync Docs to Wiki
+        uses: newrelic/wiki-sync-action@master
+        with:
+          source: docs/wiki
+          destination: wiki
+          token: ${{ secrets.GH_PAT }}
+          gitAuthorName: ${{ env.GIT_AUTHOR_NAME }}
+          gitAuthorEmail: ${{ env.GIT_AUTHOR_EMAIL }}
+
+  job-sync-wiki-to-docs:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'gollum'
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_PAT }}
+          ref: develop
+      - name: 📥 Sync Wiki to Docs
+        uses: newrelic/wiki-sync-action@master
+        with:
+          source: wiki
+          destination: docs/wiki
+          token: ${{ secrets.GH_PAT }}
+          gitAuthorName: ${{ env.GIT_AUTHOR_NAME }}
+          gitAuthorEmail: ${{ env.GIT_AUTHOR_EMAIL }}
+          branch: develop
diff --git a/.github/workflows-disabled/wiki-zi.yml b/.github/workflows-disabled/wiki-zi.yml
@@ -0,0 +1,26 @@
+---
+name: 📖 ZI
+
+on:
+  push:
+    paths:
+      - "wiki/zi/**"
+  workflow_dispatch:
+
+jobs:
+  deploy-wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+      - name: 🏗 Prepare wiki
+        run: make -C wiki/zsh to-wiki-pages
+      - name: 📤 Sync Docs to Wiki
+        uses: Andrew-Chen-Wang/github-wiki-action@v3
+        env:
+          WIKI_DIR: wiki/zi/
+          REPO: z-shell/zi
+          GH_TOKEN: ${{ secrets.GH_PAT }}
+          GH_MAIL: ${{ secrets.GH_MAIL }}
+          GH_NAME: ${{ github.repository_owner }}
+          #EXCLUDED_FILES: "wiki/zi/drafts/"
diff --git a/.github/workflows-disabled/wiki-zsh.yml b/.github/workflows-disabled/wiki-zsh.yml
@@ -0,0 +1,60 @@
+---
+name: 📖 Zsh
+
+on:
+  push:
+    paths:
+      - "wiki/zsh/**"
+  pull_request:
+    paths:
+      - "wiki/zsh/**"
+  workflow_dispatch:
+
+jobs:
+  generate-documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          submodules: recursive
+      - name: ⚡ Install zsdoc
+        run: |
+          sudo apt-get install -y zsh tree
+          sudo make -C lib/zsdoc install
+      - name: 💎 Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: 📝 Install asciidoctor-pdf and rouge
+        run: |
+          gem install asciidoctor-pdf rouge
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: ♻️ Generate Documentation
+        run: |
+          make -C wiki/zsh clean
+          make -C wiki/zsh all
+      - name: ♻️ Compress the Zsh Documentation
+        run: tar cvzf zsh-wiki.tar.gz wiki/zsh
+      - name: Upload zsh-wiki.tar.gz
+        uses: actions/upload-artifact@v3
+        with:
+          name: ♻️ Zsh Documentation
+          path: zsh-wiki.tar.gz
+      - uses: actions/checkout@v3
+      - name: ♻️ Prepare GitHub Pages
+        run: |
+          make -C wiki/zsh prep-gh-pages
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add code/zsh
+          git commit --allow-empty -m "Zsh Documentation Update" -a
+      - name: 📤 Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
diff --git a/.github/workflows/code.yml b/.github/workflows/code.yml
@@ -0,0 +1,47 @@
+---
+name: 📖 Code
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "30 4 * * 4"
+
+jobs:
+  deps:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          submodules: recursive
+      - name: ⚡ Install zsdoc
+        run: |
+          sudo apt-get install -y zsh tree
+          sudo make -C lib/zsdoc install
+      - name: 💎 Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: 📝 Install asciidoctor-pdf and rouge
+        run: |
+          gem install asciidoctor-pdf rouge
+      - name: ♻️ Generate Code
+        run: |
+          make -C code
+          make -C code clean
+      - name: ⭕ Trunk Check
+        run: ./.trunk/bin/trunk check --fix code
+      - name: 🏗 Compress code documentation
+        run: tar cvzf code.tar.gz code
+      - name: 📤 Upload code.tar.gz
+        uses: actions/upload-artifact@v3
+        with:
+          name: code documentation
+          path: code.tar.gz
+      - name: "🆗 Commit"
+        uses: z-shell/.github/actions/commit@main
+        with:
+          commitMessage: Code Documentation ${{ github.sha }}
+          workDir: code
+          commitUserName: digital-teams[bot]
+          commitUserEmail: [email protected]
diff --git a/.github/workflows/push-code.yml b/.github/workflows/push-code.yml
@@ -0,0 +1,31 @@
+---
+name: 🚀 Deploy Code to GH Pages
+
+on:
+  workflow_run:
+    workflows:
+      - "📖 Code"
+    types:
+      - completed
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v3
+      - name: ♻️ Prepare
+        run: |
+          mkdir -p gh-pages/code gh-pages/zsh
+          cp -vrf code/zsdoc/html gh-pages/code/
+      - name: 🚀 Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./gh-pages
+          allow_empty_commit: true
+          keep_files: true
+          user_name: digital-teams[bot]
+          user_email: [email protected]
diff --git a/.github/workflows/trunk-check.yml b/.github/workflows/trunk-check.yml
@@ -0,0 +1,16 @@
+---
+name: "⭕ Trunk Check"
+on:
+  push:
+    branches: [main]
+    tags: ["v*.*.*"]
+  pull_request:
+    types: [opened, synchronize]
+  workflow_dispatch:
+
+jobs:
+  trunk:
+    name: "⚡"
+    uses: z-shell/.github/.github/workflows/trunk.yml@main
+    secrets:
+      trunk-token: ${{ secrets.TRUNK_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local files
+.history/
+.drafts/
+.trunk/out*
+
+# Exclude from GH Pages push
+code/Makefile
+code/zsdoc/data
+code/zsdoc/Makefile
+code/zsdoc/README.md
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "lib/zsdoc"]
+path = lib/zsdoc
+url = https://github.com/z-shell/zsdoc
+[submodule "zsh-plugin-assessor"]
+path = docs/zsh-plugins-commit-top/zsh-plugin-assessor
+url = https://github.com/z-shell/zsh-plugin-assessor
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,10 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false