docs: format document

Co-authored-by: leaanthony <leaanthony@users.noreply.github.com>

.eslintignore

@@ -1 +0,0 @@
-runtime/assets/default.html

.eslintrc

@@ -1,30 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es6": true,
-        "node": true,
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 2016,
-        "sourceType": "module",
-    },
-    "rules": {
-        "indent": [
-            "error",
-            "tab"
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ]
-    }
-}

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -14,6 +14,10 @@ body:
         - Search the issue tracker using [this link](https://github.com/wailsapp/wails/issues?q=is%3Aissue+).
         - Search the [discussion forums](https://github.com/wailsapp/wails/discussions?discussions_q=type+your+issue+here).
         - Read the [Troubleshooting Guide](https://wails.io/docs/next/guides/troubleshooting).
+        - Create a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) and link to it in the issue.
+        - If your issue is related to TypeScript generation, please open a ticket and create a PR with a failing test case.
+        TS tests can be found [here](https://github.com/wailsapp/wails/tree/master/v2/internal/binding/binding_test). Remember to add
+        your test to the `binding_test.go` file.
         - Try to fix it yourself. Keep a list of things you have done to fix the problem.   
 
         If after doing all the above, the problem remains, please continue with this ticket providing *all* the information requested.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,9 @@
 blank_issues_enabled: true
 contact_links:
+  - name: Discord Chat
+    url: https://discord.gg/BrRSWTaxVK
+    about: Ask questions and discuss with other Wails users in real time.
+
   - name: GitHub Community Discussions
     url: https://github.com/wailsapp/wails/discussions
     about: If your question is not a feature or a bug, please go to the discussion panel and retrieve if your question already exists before submitting.

.github/pull_request_template.md

@@ -0,0 +1,43 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also
+include relevant motivation and context. List any dependencies that are required
+for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to
+      not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce. Please also list any relevant details for your
+test configuration using `wails doctor`.
+
+- [ ] Windows
+- [ ] macOS
+- [ ] Linux
+
+## Test Configuration
+
+Please paste the output of `wails doctor`. If you are unable to run this
+command, please describe your environment in as much detail as possible.
+
+# Checklist:
+
+- [ ] I have updated `website/src/pages/changelog.mdx` with details of this PR
+- [ ] My code follows the general coding style of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

.github/workflows/build-and-test.yml

@@ -0,0 +1,118 @@
+name: Build + Test v2
+
+on:
+  push:
+    branches: [release/*, master]
+  workflow_dispatch:
+
+jobs:
+  test_go:
+    name: Run Go Tests
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.18, 1.19]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
+
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Run tests (mac)
+        if: matrix.os == 'macos-latest'
+        env:
+          CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
+        working-directory: ./v2
+        run: go test -v ./...
+
+      - name: Run tests (!mac)
+        if: matrix.os != 'macos-latest'
+        working-directory: ./v2
+        run: go test -v ./...
+
+  test_js:
+    name: Run JS Tests
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: v2/internal/frontend/runtime
+
+      - name: Run tests
+        run: npm test
+        working-directory: v2/internal/frontend/runtime
+
+  test_templates:
+    name: Test Templates
+    needs: test_go
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        template:
+          [
+            svelte,
+            svelte-ts,
+            vue,
+            vue-ts,
+            react,
+            react-ts,
+            preact,
+            preact-ts,
+            lit,
+            lit-ts,
+            vanilla,
+            vanilla-ts,
+            plain,
+          ]
+        go-version: [1.18, 1.19]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Build Wails CLI
+        run: |
+          cd ./v2/cmd/wails
+          go install
+          wails -help
+
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
+
+      - name: Generate template '${{ matrix.template }}'
+        run: |
+          mkdir -p ./test-${{ matrix.template }}
+          cd ./test-${{ matrix.template }}
+          wails init -n ${{ matrix.template }} -t ${{ matrix.template }} -ci
+          cd ${{ matrix.template }}
+          wails build -v 2

.github/workflows/build_and_test.yml

@@ -1,69 +0,0 @@
-name: Build + Test
-
-on:
-  push:
-    branches: [ release/*, master ]
-  workflow_dispatch:
-
-jobs:
-  test:
-    name: Run Go Tests
-    if: github.repository == 'wailsapp/wails'
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        go-version: [ 1.18, 1.19 ]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Install linux dependencies
-        if: matrix.os == 'ubuntu-latest'
-        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
-
-      - name: Set up Go 1.18
-        uses: actions/setup-go@v3
-        with:
-          go-version: ${{ matrix.go-version }}
-
-      - name: Run tests
-        run: go test -v ./...
-
-  test_templates:
-    name: Test Templates
-    needs: test
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: true
-      matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        template: [ svelte, svelte-ts, vue, vue-ts, react, react-ts, preact, preact-ts, lit, lit-ts, vanilla, vanilla-ts, plain ]
-        go-version: [ 1.18, 1.19 ]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: ${{ matrix.go-version }}
-
-      - name: Build Wails CLI
-        run: |
-          cd ./v2/cmd/wails
-          go install
-          wails -help
-
-      - name: Install linux dependencies
-        if: matrix.os == 'ubuntu-latest'
-        run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
-
-      - name: Generate template '${{ matrix.template }}'
-        run: |
-          mkdir -p ./test-${{ matrix.template }}
-          cd ./test-${{ matrix.template }}
-          wails init -n ${{ matrix.template }} -t ${{ matrix.template }} -ci
-          cd ${{ matrix.template }}
-          wails build -v 2

.github/workflows/check_docs.yml

@@ -1,25 +0,0 @@
-name: Check Docs
-on:
-  pull_request:
-    branches: [ 'feature/*' ]
-
-jobs:
-  docs:
-    name: Website Updated
-    if: github.repository == 'wailsapp/wails'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v11.1
-        id: verify-changed-files
-        with:
-          files: |
-            website/**/*.mdx
-            website/**/*.md
-
-      - name: Run step only when files change.
-        if: steps.verify-changed-files.outputs.files_changed != 'true'
-        run: |
-          echo "Feature branch does not contain any changes to the website."

.github/workflows/format-markdown-files.yml

@@ -0,0 +1,37 @@
+name: Format Markdown Files
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+
+jobs:
+  format_markdown_files:
+    runs-on: ubuntu-latest
+    if: github.repository == 'wailsapp/wails'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+
+      - name: Install Task
+        uses: arduino/setup-task@v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Format All Markdown Files
+        run: task format-all-md
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "docs: format document"
+          title: "docs: format document"
+          body: "- [x] Format all Markdown(x) documents"
+          branch: chore/format-markdown-files
+          delete-branch: true
+          draft: false

.github/workflows/generate-sponsor-image.yml

@@ -7,17 +7,18 @@ on:
 
 jobs:
   update-sponsors:
+    name: Update Sponsors
     runs-on: ubuntu-latest
     if: github.repository == 'wailsapp/wails'
     steps:
       - uses: actions/checkout@v3
 
-      - name: Set node
+      - name: Set Node
         uses: actions/setup-node@v2
         with:
           node-version: 16.x
 
-      - name: Update sponsors
+      - name: Update Sponsors
         run: cd scripts/sponsors && chmod 755 ./generate-sponsor-image.sh && ./generate-sponsor-image.sh
         env:
           SPONSORKIT_GITHUB_TOKEN: ${{ secrets.SPONSORS_TOKEN }}

.github/workflows/label-sponsors.yml

@@ -1,15 +0,0 @@
-name: Label sponsors
-on:
-  pull_request:
-    types: [ opened ]
-  issues:
-    types: [ opened ]
-jobs:
-  build:
-    name: is-sponsor-label
-    if: github.repository == 'wailsapp/wails'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: JasonEtco/is-sponsor-label-action@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr.yml

@@ -1,30 +1,39 @@
 name: PR Checks
+
 on:
   pull_request:
   pull_request_review:
-    types: [ submitted ]
+    types: [submitted]
 
 jobs:
-  check_branch_name:
+  check_docs:
+    name: Check Docs
+    if: ${{github.repository == 'wailsapp/wails' && contains(github.head_ref,'feature/')}}
     runs-on: ubuntu-latest
-    if: github.repository == 'wailsapp/wails'
-    name: Check branch name
     steps:
-      - run: |
-          if ! [[ "$(echo ${GITHUB_HEAD_REF} | cut -d "/" -f1)" =~ (feature|bugfix|release|chore) ]]; then
-            echo "PRs are only accepted for branches starting with: feature/, bugfix/, chore/ or release/"
-            exit 1
-          fi
-        shell: bash
+      - uses: actions/checkout@v3
 
-  test:
+      - name: Verify Changed files
+        uses: tj-actions/verify-changed-files@v11.1
+        id: verify-changed-files
+        with:
+          files: |
+            website/**/*.mdx
+            website/**/*.md
+
+      - name: Run step only when files change.
+        if: steps.verify-changed-files.outputs.files_changed != 'true'
+        run: |
+          echo "::warning::Feature branch does not contain any changes to the website."
+
+  test_go:
     name: Run Go Tests
     runs-on: ${{ matrix.os }}
     if: github.event.review.state == 'approved'
     strategy:
       matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        go-version: [ 1.18, 1.19 ]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.18, 1.19]
 
     steps:
       - name: Checkout code
@@ -34,10 +43,19 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
         run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config
 
-      - name: Set up Go 1.18
+      - name: Setup Go
         uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go-version }}
 
-      - name: Run tests
+      - name: Run tests (mac)
+        if: matrix.os == 'macos-latest'
+        env:
+          CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13
+        working-directory: ./v2
+        run: go test -v ./...
+
+      - name: Run tests (!mac)
+        if: matrix.os != 'macos-latest'
+        working-directory: ./v2
         run: go test -v ./...

.github/workflows/push-to-crowdin.yml

@@ -1,38 +0,0 @@
-name: Push files to Crowdin
-
-on:
-  push:
-    branches: [master]
-  workflow_dispatch:
-
-jobs:
-  docs:
-    name: Push files to Crowdin
-    if: github.repository == 'wailsapp/wails'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v11.1
-        id: verify-changed-files
-        with:
-          files: |
-            website/**/*.mdx
-            website/**/*.md
-            website/**/*.json
-
-      - name: Set node
-        if: steps.verify-changed-files.outputs.files_changed != 'true'
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16.x
-
-      - name: Push files
-        env:
-          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
-        run: |
-          cd website
-          corepack enable
-          pnpm install
-          pnpm run crowdin push -b master

.github/workflows/sync-translated-documents.yml

@@ -0,0 +1,41 @@
+name: Sync Translations
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sync-translated-documents:
+    runs-on: ubuntu-latest
+    if: github.repository == 'wailsapp/wails'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+
+      - name: Install Task
+        uses: arduino/setup-task@v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Sync Translated Documents
+        env:
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+        working-directory: ./website
+        run: task crowdin:pull
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "docs: sync translations"
+          title: "docs: sync translations"
+          body: "- [x] Sync translated documents"
+          branch: chore/sync-translations
+          labels: translation
+          delete-branch: true
+          draft: true

.github/workflows/test_js.yml

@@ -1,32 +0,0 @@
-name: Test JS
-
-on:
-  push:
-    branches: [ release/*, master ]
-  workflow_dispatch:
-
-jobs:
-  test:
-    name: Run JS Tests
-    if: github.repository == 'wailsapp/wails'
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [16.x]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Install dependencies
-        run: npm install
-        working-directory: v2/internal/frontend/runtime
-
-      - name: Run tests
-        run: npm test
-        working-directory: v2/internal/frontend/runtime

.github/workflows/upload-source-documents.yml

@@ -0,0 +1,41 @@
+name: Upload Source Documents
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  push_files_to_crowdin:
+    name: Push files to Crowdin
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Verify Changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v35
+        with:
+          files: |
+            website/**/*.mdx
+            website/**/*.md
+            website/**/*.json
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+
+      - name: Setup Task
+        uses: arduino/setup-task@v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload source documents
+        if: steps.changed-files.outputs.any_changed == 'true'
+        env:
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+        working-directory: ./website
+        run: task crowdin:push

.gitignore

@@ -31,3 +31,8 @@ v2/test/kitchensink/frontend/package.json.md5
 v2/cmd/wails/internal/commands/initialise/templates/testtemplates/
 .env
 /website/static/img/.cache.json
+
+/v3/.task
+/v3/examples/build/bin/testapp
+/websitev3/site/
+/v3/examples/plugins/bin/testapp

.goreleaser.yml

@@ -1,34 +0,0 @@
-# This is an example goreleaser.yaml file with some sane defaults.
-# Make sure to check the documentation at http://goreleaser.com
-
-builds:
-- env:
-  - CGO_ENABLED=0
-  goos:
-    - windows
-    - linux
-    - darwin
-  goarch:
-    - 386
-    - amd64
-  ignore:
-  - goos: darwin
-    goarch: 386
-  main: ./cmd/wails/main.go
-archive:
-  replacements:
-    darwin: Darwin
-    linux: Linux
-    windows: Windows
-    386: i386
-    amd64: x86_64
-checksum:
-  name_template: 'checksums.txt'
-snapshot:
-  name_template: "{{ .Tag }}-next"
-changelog:
-  sort: asc
-  filters:
-    exclude:
-    - '^docs:'
-    - '^test:'

.hound.yml

@@ -1,6 +0,0 @@
-jshint:
-  config_file: .jshintrc
-eslint:
-  enabled: true
-  config_file: .eslintrc
-  ignore_file: .eslintignore