feat(mvp): mvp

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+end_of_line = lf
+insert_final_newline = false
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.lua]
+indent_size = 2

.github/workflows/ci.yml

@@ -0,0 +1,105 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+concurrency:
+  group: ${{ github.ref }}-ci
+  cancel-in-progress: true
+jobs:
+  pr_conventional_commit:
+    name: Conventional Commit
+    if: ${{ github.ref != 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ytanikin/PRConventionalCommits@1.1.0
+        with:
+          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert","break"]'
+  luacheck:
+    name: Lua Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: JohnnyMorganz/stylua-action@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --config-path .stylua.toml ./ ./spec
+      - uses: lunarmodules/luacheck@v1
+        with:
+          args: giturlparser.lua  --config .luacheckrc
+      - uses: stevearc/nvim-typecheck-action@v1
+        with:
+          path: giturlparser.lua
+          level: Information
+          configpath: ".luarc.json"
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        if: ${{ github.ref != 'refs/heads/main' }}
+        with:
+          commit_message: "chore(pr): auto-commit"
+          push_options: "--force"
+  unit_test:
+    name: Unit Test
+    strategy:
+      matrix:
+        lua_version: ["5.1.5","5.2.4","5.3.5","luajit-2.1.0-beta3"]
+    needs:
+      - luacheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: leafo/gh-actions-lua@v10
+        with:
+          luaVersion: ${{ matrix.lua_version }}
+      - uses: leafo/gh-actions-luarocks@v4
+      - name: Install Luacov
+        run: |
+          echo 'pwd'
+          echo $PWD
+          echo 'ls-1'
+          ls -lha
+          luarocks  install luacov
+          luarocks  install cluacov
+      - uses: lunarmodules/busted@v2
+        with:
+            args:  .
+      #- name: Generate Coverage Reports
+      #  shell: bash
+      #  run: |
+      #    echo "ls ."
+      #    ls -l .
+      #    echo "run luacov"
+      #    luacov
+      #    echo "ls ."
+      #    ls -l .
+      #    echo "cat ./luacov.report.out"
+      #    cat ./luacov.report.out
+      #- uses: codecov/codecov-action@v3
+      #  with:
+      #    files: luacov.report.out
+      #  env:
+      #    CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+  release:
+    name: Release
+    if: ${{ github.ref == 'refs/heads/main' }}
+    needs:
+      - unit_test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: simple
+          package-name: giturlparser.lua
+      - uses: actions/checkout@v4
+      - uses: rickstaa/action-create-tag@v1
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          tag: stable
+          message: "Current stable release: ${{ steps.release.outputs.tag_name }}"
+          tag_exists_error: false
+          force_push_tag: true

.luacheckrc

@@ -0,0 +1,5 @@
+globals = { "describe", "before_each", "it", "assert" }
+max_line_length = 500
+unused = false
+unused_args = false
+exclude_files = {}

.luacov

@@ -0,0 +1,4 @@
+modules = {
+    ["giturlparser"] = "giturlparser.lua",
+}
+exclude = {}

.luarc.json

@@ -0,0 +1,4 @@
+{
+  "diagnostics.globals": ["describe", "before_each", "it", "jit"],
+  "workspace.checkThirdParty": "Disable"
+}

.stylua.toml

@@ -0,0 +1,4 @@
+column_width = 80
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 2

README.md

@@ -4,13 +4,18 @@ Pure Lua implemented git URL parsing library, e.g. the output of `git remote get
 
 ## Features
 
-* [ ] Single lua file & zero dependencies.
+* [ ] Single file & zero dependency.
 * [ ] Compatible with lua-5.1/luajit-2.
 * [ ] Compatible with RFC 3689.
 
 ## Install
 
-## API References
+## API
+
+## References
+
+1. [What are the supported git url formats?](https://stackoverflow.com/questions/31801271/what-are-the-supported-git-url-formats)
+2. [4.1 Git on the Server - The Protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols)
 
 ## Development
 

codecov.yml

@@ -0,0 +1,8 @@
+coverage:
+  status:
+    project:
+      default:
+        threshold: 90%
+    patch:
+      default:
+        threshold: 90%

giturlparser-dev-1.rockspec

@@ -0,0 +1,19 @@
+package = "giturlparser"
+version = "dev-1"
+source = {
+  url = "git+https://github.com/linrongbin16/giturlparser.lua.git",
+}
+description = {
+  summary = "Pure Lua implemented git URL parsing library.",
+  detailed = "Pure Lua implemented git URL parsing library.",
+  homepage = "https://github.com/linrongbin16/giturlparser.lua",
+  license = "MIT",
+}
+dependencies = {
+}
+build = {
+  type = "builtin",
+  modules = {
+    giturlparser = "giturlparser.lua",
+  },
+}