Initial commit

Author: bilby91

.github/workflows/ci.yml

@@ -0,0 +1,96 @@
+name: Continious Integration
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+          cache: true
+
+      - name: Download dependencies
+        run: go mod download
+
+      - name: Run tests
+        run: go test -race -coverprofile=coverage.out -covermode=atomic ./...
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.out
+          fail_ci_if_error: false
+        continue-on-error: true
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+          cache: true
+
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: latest
+          args: --timeout=5m
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    needs: [test, lint]
+    strategy:
+      matrix:
+        goos: [linux, darwin, windows]
+        goarch: [amd64, arm64]
+        exclude:
+          - goos: windows
+            goarch: arm64
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+          cache: true
+
+      - name: Build binary
+        env:
+          GOOS: ${{ matrix.goos }}
+          GOARCH: ${{ matrix.goarch }}
+        run: |
+          VERSION=$(git describe --tags --always --dirty 2>/dev/null || echo "dev")
+          OUTPUT_NAME=opencligen-${{ matrix.goos }}-${{ matrix.goarch }}
+          if [ "${{ matrix.goos }}" = "windows" ]; then
+            OUTPUT_NAME="${OUTPUT_NAME}.exe"
+          fi
+          go build -ldflags "-X main.version=${VERSION}" -o ${OUTPUT_NAME} ./cmd/opencligen
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: opencligen-${{ matrix.goos }}-${{ matrix.goarch }}
+          path: opencligen-*
+          retention-days: 7

.golangci.yml

@@ -0,0 +1,69 @@
+run:
+  timeout: 5m
+  modules-download-mode: readonly
+
+linters:
+  enable:
+    # Default linters
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    # Additional linters
+    - gofmt
+    - goimports
+    - misspell
+    - unconvert
+    - bodyclose
+    - nilerr
+    - exportloopref
+    - gocritic
+    - revive
+
+linters-settings:
+  gofmt:
+    simplify: true
+  goimports:
+    local-prefixes: github.com/crunchloop/opencligen
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - performance
+    disabled-checks:
+      - hugeParam
+  revive:
+    rules:
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: exported
+      - name: increment-decrement
+      - name: var-naming
+      - name: var-declaration
+      - name: package-comments
+        disabled: true
+      - name: range
+      - name: receiver-naming
+      - name: indent-error-flow
+      - name: empty-block
+      - name: superfluous-else
+      - name: unreachable-code
+
+issues:
+  exclude-rules:
+    # Exclude some linters from running on tests files
+    - path: _test\.go
+      linters:
+        - errcheck
+        - gocritic
+    # Exclude template files from most checks
+    - path: \.tmpl$
+      linters:
+        - all
+  max-issues-per-linter: 50
+  max-same-issues: 10

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing to opencligen
+
+Thank you for your interest in contributing to opencligen! This document provides guidelines and instructions for contributing.
+
+## Development Setup
+
+### Prerequisites
+
+- Go 1.22 or later
+- Make (optional, but recommended)
+- golangci-lint (for linting)
+
+### Getting Started
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/crunchloop/opencligen.git
+   cd opencligen
+   ```
+
+2. Install dependencies:
+   ```bash
+   go mod download
+   ```
+
+3. Run tests:
+   ```bash
+   make test
+   # or
+   go test ./...
+   ```
+
+4. Run linting:
+   ```bash
+   make lint
+   # or
+   golangci-lint run
+   ```
+
+5. Build the binary:
+   ```bash
+   make build
+   # or
+   go build -o bin/opencligen ./cmd/opencligen
+   ```
+
+## Making Changes
+
+### Code Style
+
+- Follow standard Go conventions and idioms
+- Run `make fmt` before committing to format code
+- Ensure all linting checks pass with `make lint`
+- Add tests for new functionality
+
+### Testing
+
+- Write tests for any new functionality
+- Ensure all existing tests pass before submitting a PR
+- Aim for at least 80% test coverage for new code
+- Run `make coverage` to check coverage
+
+### Commit Messages
+
+- Use clear, concise commit messages
+- Start with a verb in imperative mood (e.g., "Add", "Fix", "Update")
+- Reference related issues when applicable
+
+## Pull Request Process
+
+1. Fork the repository and create a feature branch
+2. Make your changes and ensure all tests pass
+3. Update documentation if needed
+4. Submit a pull request with a clear description of the changes
+
+## Project Structure
+
+```
+opencligen/
+├── cmd/opencligen/     # CLI entry point
+├── internal/
+│   ├── spec/          # OpenAPI spec parsing
+│   ├── plan/          # CLI command planning
+│   ├── gen/           # Code generation
+│   └── runtime_skel/  # Runtime library skeleton
+├── .github/workflows/ # CI/CD configuration
+└── Makefile          # Build automation
+```
+
+## Questions?
+
+If you have questions or need help, please open an issue on GitHub.

Makefile

@@ -0,0 +1,66 @@
+.PHONY: build test lint coverage clean install help
+
+# Build variables
+BINARY_NAME := opencligen
+VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
+BUILD_TIME := $(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
+LDFLAGS := -ldflags "-X main.version=$(VERSION) -X main.buildTime=$(BUILD_TIME)"
+
+# Default target
+all: lint test build
+
+## build: Build the binary
+build:
+	go build $(LDFLAGS) -o bin/$(BINARY_NAME) ./cmd/opencligen
+
+## test: Run all tests
+test:
+	go test -race ./...
+
+## lint: Run golangci-lint
+lint:
+	golangci-lint run
+
+## coverage: Run tests with coverage report
+coverage:
+	go test -race -coverprofile=coverage.out -covermode=atomic ./...
+	go tool cover -func=coverage.out
+	@echo ""
+	@echo "To view HTML coverage report, run: go tool cover -html=coverage.out"
+
+## coverage-html: Generate and open HTML coverage report
+coverage-html: coverage
+	go tool cover -html=coverage.out -o coverage.html
+	@echo "Coverage report generated: coverage.html"
+
+## clean: Remove build artifacts
+clean:
+	rm -rf bin/
+	rm -f coverage.out coverage.html
+
+## install: Install the binary to GOPATH/bin
+install:
+	go install $(LDFLAGS) ./cmd/opencligen
+
+## fmt: Format code
+fmt:
+	go fmt ./...
+	goimports -w -local github.com/crunchloop/opencligen .
+
+## vet: Run go vet
+vet:
+	go vet ./...
+
+## mod-tidy: Tidy go modules
+mod-tidy:
+	go mod tidy
+
+## check: Run all checks (fmt, vet, lint, test)
+check: fmt vet lint test
+
+## help: Show this help message
+help:
+	@echo "Usage: make [target]"
+	@echo ""
+	@echo "Targets:"
+	@sed -n 's/^## //p' $(MAKEFILE_LIST) | column -t -s ':' | sed 's/^/  /'