Merge pull request #3 from KerickHowlett/feature/update-packages

feature/update-packages

Author: KerickHowlett

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.md,*.yml,*.lua}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+indent_size = 4

.gitattributes

@@ -0,0 +1,94 @@
+# Treat all Go files in this repo as binary, with no git magic updating
+# line endings. Windows users contributing to Go will need to use a
+# modern version of git and editors capable of LF line endings.
+
+*.go -text diff=golang eol=lf
+
+
+# Apply override to all files in the directory
+*.md linguist-detectable eol=lf
+
+# Common settings that generally should always be used with your language specific settings
+
+# Auto detect text files and perform LF normalization
+*          text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+# Documents
+*.bibtex   text diff=bibtex
+*.doc      diff=astextplain
+*.DOC      diff=astextplain
+*.docx     diff=astextplain
+*.DOCX     diff=astextplain
+*.dot      diff=astextplain
+*.DOT      diff=astextplain
+*.pdf      diff=astextplain
+*.PDF      diff=astextplain
+*.rtf      diff=astextplain
+*.RTF      diff=astextplain
+*.md       text diff=markdown
+*.mdx      text diff=markdown
+*.tex      text diff=tex
+*.adoc     text
+*.textile  text
+*.mustache text
+*.csv      text eol=crlf
+*.tab      text
+*.tsv      text
+*.txt      text
+*.sql      text
+*.epub     diff=astextplain
+
+# Graphics
+*.png      binary
+*.jpg      binary
+*.jpeg     binary
+*.gif      binary
+*.tif      binary
+*.tiff     binary
+*.ico      binary
+# SVG treated as text by default.
+*.svg      text
+# If you want to treat it as binary,
+# use the following line instead.
+# *.svg    binary
+*.eps      binary
+
+# Scripts
+*.bash     text eol=lf
+*.fish     text eol=lf
+*.sh       text eol=lf
+*.zsh      text eol=lf
+# These are explicitly windows files and should use crlf
+*.bat      text eol=crlf
+*.cmd      text eol=crlf
+*.ps1      text eol=crlf
+
+# Serialisation
+*.json     text
+*.toml     text
+*.xml      text
+*.yaml     text
+*.yml      text
+
+# Archives
+*.7z       binary
+*.gz       binary
+*.tar      binary
+*.tgz      binary
+*.zip      binary
+
+# Text files where line endings should be preserved
+*.patch    -text
+
+#
+# Exclude files from exporting
+#
+
+.gitattributes export-ignore
+.gitignore     export-ignore
+.gitkeep       export-ignore
+

.github/workflows/go.yml

@@ -1,28 +1,28 @@
 name: Go
 on: [push]
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
+      - name: Set up Go 1.20
+        uses: actions/setup-go@v1
+        with:
+          go-version: 1.20
+        id: go
 
-    - name: Set up Go 1.16
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.16
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v1
 
-    - name: Build
-      run: make build
+      - name: Build
+        env:
+          GOOS: windows
+        run: go build -o wsl2-ssh-bridge.exe -ldflags -H=windowsgui main.go
 
-    - name: Upload artifact
-      uses: actions/upload-artifact@v1.0.0
-      with:
-        # Artifact Name
-        name: wsl2-ssh-pageant.exe
-        # The directory containing files to upload.
-        path: wsl2-ssh-pageant.exe
+      - name: Upload artifact
+        uses: actions/upload-artifact@v1.0.0
+        with:
+          # Artifact Name
+          name: wsl2-ssh-bridge.exe
+          # The directory containing files to upload.
+          path: wsl2-ssh-bridge.exe

.vscode/extensions.json

@@ -1,9 +1,12 @@
 {
     "recommendations": [
-        "ms-vscode.makefile-tools",
-        "yzhang.markdown-all-in-one",
-        "davidanson.vscode-markdownlint",
-        "streetsidesoftware.code-spell-checker",
-        "golang.go"
-    ]
+		"bierner.markdown-emoji",
+		"bierner.markdown-preview-github-styles",
+		"davidanson.vscode-markdownlint",
+		"editorconfig.editorconfig",
+		"golang.go",
+		"ms-vscode.makefile-tools",
+		"streetsidesoftware.code-spell-checker",
+		"yzhang.markdown-all-in-one",
+	]
 }

.vscode/settings.json

@@ -1,12 +1,63 @@
 {
+	"[go.mod]": {
+		"editor.defaultFormatter": "golang.go"
+	},
+	"[go]": {
+		"editor.defaultFormatter": "golang.go"
+	},
+	"[markdown]": {
+		"editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
+		"editor.quickSuggestions": {
+			"comments": "on",
+			"other": "on",
+			"strings": "on"
+		},
+		"editor.wordWrap": "off",
+		"files.trimTrailingWhitespace": false
+	},
+	"cSpell.enabled": true,
+	"cSpell.spellCheckOnlyWorkspaceFiles": true,
     "cSpell.words": [
+		"apenwarr",
+		"Basepath",
         "benpye",
+		"COPYDATA",
+		"fixconsole",
+		"hwnd",
+		"killagent",
+		"logfile",
         "nohup",
         "setsid",
         "simlink",
         "socat",
+		"winio",
         "Yubico's",
-        "Yubikey",
-        "killagent",
-    ]
+		"Yubikey"
+	],
+	"editor.formatOnSave": true,
+	"go.autocompleteUnimportedPackages": true,
+	"go.formatTool": "goformat",
+	"go.toolsManagement.autoUpdate": true,
+	"go.useLanguageServer": true,
+	"go.vetFlags": [
+		"-unsafeptr=false"
+	],
+	"gopls": {
+		"analyses": {
+			"unsafeptr": false
+		}
+	},
+	"markdownlint.config": {
+		"line-length": {
+			"code_blocks": false,
+			"tables": false
+		},
+		"no-duplicate-heading": {
+			"siblings_only": true
+		},
+		"no-trailing-punctuation": {
+			"punctuation": ".,;:!。，；：！？"
+		}
+	},
+	"markdownlint.run": "onSave"
 }

Makefile

@@ -1,9 +1,22 @@
+all: listen
 
 build:
-	GOOS=windows go build -o wsl2-ssh-pageant.exe -ldflags -H=windowsgui main.go
+	@echo "Building wsl2-ssh-bridge..."
+	@GOOS=windows go build -o wsl2-ssh-bridge.exe -ldflags -H=windowsgui main.go
 
+SSH_PATH := "${USERPROFILE}/.ssh/"
 install: build
-	mv wsl2-ssh-pageant.exe ~/.ssh/
+	@echo "Installing wsl2-ssh-bridge..."
+	@mkdir -p "${SSH_PATH}"
+	@mv wsl2-ssh-bridge.exe "${SSH_PATH}"
 
+IS_INSTALLED := $(shell [ -e where socat > NUL 2>&1 ] && echo 0 || echo 1)
 listen: build
-	socat UNIX-LISTEN:ssh.sock,fork EXEC:./wsl2-ssh-pageant.exe
+	@echo "Attempting to establish WSL2/SSH Bridge..."
+ifeq ($(IS_INSTALLED), 0)
+	@socat UNIX-LISTEN:ssh.sock,fork EXEC:"${SSH_PATH}/wsl2-ssh-bridge.exe"
+	@echo "WSL2/SSH Bridge has been successfully established!"
+else
+	@echo "[ERROR]: Please install socat first!"
+endif
+