chore: add website (#6)

Author: manuelarte

.codespellrc

@@ -1,3 +1,4 @@
 [codespell]
 # Comma separated list of words to be ignored. Words must be lowercased.
 ignore-words-list = decorder
+skip = **/package-lock.json,**/pnpm-lock.yaml,**/node_modules/**,./web/playground/dist/*

.github/dependabot.yml

@@ -1,9 +1,8 @@
 ---
-
 version: 2
 updates:
-  - package-ecosystem: "gomod"  # See documentation for possible values
-    directory: "/"              # Location of package manifests
+  - package-ecosystem: "gomod"
+    directory: "/"
     schedule:
       interval: "weekly"
     groups:
@@ -21,3 +20,15 @@ updates:
     commit-message:
       prefix: "chore"
       include: "scope"
+  - package-ecosystem: "npm"
+    directory: "web/playground"
+    schedule:
+      interval: "weekly"
+    groups:
+      all-deps:
+        applies-to: version-updates
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/pages.yml

@@ -0,0 +1,40 @@
+name: pages.yml
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+on:
+  workflow_dispatch:
+  push:
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 23
+          cache: 'npm'
+          cache-dependency-path: web/playground/package-lock.json
+      - name: install dependencies
+        run: npm install ./web/playground
+      - name: build
+        run: npm run build --prefix ./web/playground
+      - name: setup Pages
+        uses: actions/configure-pages@v4
+      - name: upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './web/playground/dist'
+      - name: deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.markdownlint-cli2.jsonc

@@ -5,7 +5,8 @@
   "gitignore": true,
   // Define glob expressions to ignore
   "ignores": [
-    "LICENSE.md"
+    "LICENSE.md",
+    "*/node_modules/*.md"
   ],
   "config": {
     // MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md

internal/cmd/lint.go renamed to commands/lint.go

@@ -1,15 +1,16 @@
-package cmd
+package commands
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
 	"runtime/debug"
 
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
-	"github.com/manuelarte/golangci-lint-linter/internal"
-	"github.com/manuelarte/golangci-lint-linter/internal/linters"
+	"github.com/manuelarte/golangci-lint-linter/linters"
+	"github.com/manuelarte/golangci-lint-linter/models"
 )
 
 //nolint:gochecknoglobals // color red
@@ -30,29 +31,13 @@ func RegisterLintCommand() *cobra.Command {
 	return rootCMD
 }
 
-//nolint:gocognit // TODO: refactor later
-func run(cmd *cobra.Command, args []string) {
-	path := args[0]
-
-	isFix, err := cmd.Flags().GetBool("fix")
+func Lint(input []byte, isFix bool) (models.Golangci, []models.Report, error) {
+	golangci, err := models.Parse(input)
 	if err != nil {
-		errorMsg := errorColor.Sprintf("Error reading flag fix: %s\n", err)
-		cmd.PrintErrln(errorMsg)
-
-		return
-	}
-
-	golangci, err := readYamlFile(path)
-	if err != nil {
-		errorMsg := errorColor.Sprintf("Error reading yaml file: %s\n", err)
-		cmd.PrintErrf(errorMsg)
-
-		return
+		return nil, nil, fmt.Errorf("error reading yaml file: %w", err)
 	}
 
-	cmd.Printf("Linting: %q\n", path)
-
-	allReports := make([]internal.Report, 0)
+	allReports := make([]models.Report, 0)
 
 	for _, linter := range getAllLinters() {
 		linterReports := linter.Lint(golangci)
@@ -61,51 +46,71 @@ func run(cmd *cobra.Command, args []string) {
 			if fixer, ok := linter.(linters.Fixer); ok {
 				errFix := fixer.Fix(golangci)
 				if errFix != nil {
-					errorMsg := errorColor.Sprintf("Error applying fix: %s", errFix)
-					cmd.PrintErrf("%s\n", errorMsg)
-					os.Exit(1)
+					return nil, nil, fmt.Errorf("error applying fix: %w", errFix)
 				}
 			}
 		} else {
 			allReports = append(allReports, linterReports...)
 		}
 	}
 
-	cmd.Printf("Found: %d issue(s)\n", len(allReports))
+	return golangci, allReports, nil
+}
 
-	for _, report := range allReports {
-		errorMsg := errorColor.Sprintf("%s", report)
-		cmd.PrintErrf("%s\n", errorMsg)
+func run(cmd *cobra.Command, args []string) {
+	path := args[0]
+
+	isFix, err := cmd.Flags().GetBool("fix")
+	if err != nil {
+		errorMsg := errorColor.Sprintf("Error reading flag fix: %s\n", err)
+		cmd.PrintErrln(errorMsg)
+
+		return
 	}
 
+	input, errReadingFile := os.ReadFile(filepath.Clean(path))
+	if errReadingFile != nil {
+		errorMsg := errorColor.Sprintf("Error reading file: %s\n", errReadingFile)
+		cmd.PrintErrf(errorMsg)
+
+		return
+	}
+
+	cmd.Printf("Linting: %q\n", path)
+
+	golangciFixed, reports, err := Lint(input, isFix)
+	if err != nil {
+		errorMsg := errorColor.Sprintf("Error Linting %s: %s\n", path, err)
+		cmd.PrintErrf(errorMsg)
+		os.Exit(1)
+	}
+
+	cmd.Printf("Found: %d issue(s)\n", len(reports))
+
 	if isFix {
-		fixedFile, errM := golangci.Marshal()
+		fixedBytes, errM := golangciFixed.Marshal()
 		if errM != nil {
 			errorMsg := errorColor.Sprintf("Error Marshaling file: %s\n", errM)
 			cmd.PrintErrf(errorMsg)
 			os.Exit(1)
 		}
 
-		err = os.WriteFile(path, fixedFile, 0o600)
+		err = os.WriteFile(path, fixedBytes, 0o600)
 		if err != nil {
 			errorMsg := errorColor.Sprintf("Error writing file: %s\n", err)
 			cmd.PrintErrf(errorMsg)
 			os.Exit(1)
 		}
 	}
 
-	if len(allReports) > 0 {
-		os.Exit(1)
+	for _, report := range reports {
+		errorMsg := errorColor.Sprintf("%s", report)
+		cmd.PrintErrf("%s\n", errorMsg)
 	}
-}
 
-func readYamlFile(path string) (internal.Golangci, error) {
-	input, errReadingFile := os.ReadFile(filepath.Clean(path))
-	if errReadingFile != nil {
-		return internal.YamlGolangci{}, errReadingFile
+	if len(reports) > 0 {
+		os.Exit(1)
 	}
-
-	return internal.Parse(input)
 }
 
 func getAllLinters() []linters.Linter {

internal/linters/model.go

@@ -3,23 +3,27 @@ package linters
 import (
 	"fmt"
 
-	"github.com/manuelarte/golangci-lint-linter/internal"
+	"github.com/manuelarte/golangci-lint-linter/models"
 )
 
 var _ Linter = new(DisabledLintersWithReason)
 
 type DisabledLintersWithReason struct {
-	rule internal.RuleCode
+	rule models.RuleCode
 }
 
 func NewDisabledLintersWithReason() *DisabledLintersWithReason {
 	return &DisabledLintersWithReason{
-		rule: internal.GC021,
+		rule: models.GC021,
 	}
 }
 
-func (l DisabledLintersWithReason) Lint(golangci internal.Golangci) []internal.Report {
-	reports := make([]internal.Report, 0)
+func (l DisabledLintersWithReason) Rule() models.RuleCode {
+	return l.rule
+}
+
+func (l DisabledLintersWithReason) Lint(golangci models.Golangci) []models.Report {
+	reports := make([]models.Report, 0)
 
 	linters, ok := golangci.GetLinters()
 	if !ok {
@@ -34,7 +38,7 @@ func (l DisabledLintersWithReason) Lint(golangci internal.Golangci) []internal.R
 	for i, disable := range disabled {
 		_, hasComment := golangci.GetComment(fmt.Sprintf("$.linters.disable[%d]", i))
 		if !hasComment {
-			reports = append(reports, internal.Report{
+			reports = append(reports, models.Report{
 				Rule:    l.rule,
 				Message: fmt.Sprintf("linters.disable.%s does not have a reason", disable),
 			})

internal/linters/disabled_linters_with_reason.go renamed to linters/disabled_linters_with_reason.go

@@ -3,7 +3,7 @@ package linters
 import (
 	"testing"
 
-	"github.com/manuelarte/golangci-lint-linter/internal"
+	"github.com/manuelarte/golangci-lint-linter/models"
 )
 
 func TestDisabledLintersWithReason_Lint(t *testing.T) {
@@ -51,7 +51,7 @@ linters:
 
 	for name, test := range testCases {
 		t.Run(name, func(t *testing.T) {
-			golangci, err := internal.Parse(test.input)
+			golangci, err := models.Parse(test.input)
 			if err != nil {
 				t.Fatal(err)
 			}

internal/linters/disabled_linters_with_reason_test.go renamed to linters/disabled_linters_with_reason_test.go

@@ -5,26 +5,31 @@ import (
 	"slices"
 
 	"github.com/manuelarte/golangci-lint-linter/internal"
+	"github.com/manuelarte/golangci-lint-linter/models"
 )
 
 var _ Linter = new(LinterFieldsSorted)
 
 type LinterFieldsSorted struct {
-	rule          internal.RuleCode
+	rule          models.RuleCode
 	expectedOrder map[string]int
 }
 
 func NewLinterFieldsSorted() *LinterFieldsSorted {
 	expectedOrder := map[string]int{"default": 0, "enable": 1, "disable": 2, "settings": 3, "exclusions": 4}
 
 	return &LinterFieldsSorted{
-		rule:          internal.GC013,
+		rule:          models.GC013,
 		expectedOrder: expectedOrder,
 	}
 }
 
-func (l LinterFieldsSorted) Lint(golangci internal.Golangci) []internal.Report {
-	reports := make([]internal.Report, 0)
+func (l LinterFieldsSorted) Rule() models.RuleCode {
+	return l.rule
+}
+
+func (l LinterFieldsSorted) Lint(golangci models.Golangci) []models.Report {
+	reports := make([]models.Report, 0)
 
 	linters, ok := golangci.GetLinters()
 	if !ok {
@@ -45,7 +50,7 @@ func (l LinterFieldsSorted) Lint(golangci internal.Golangci) []internal.Report {
 	})
 
 	if !internal.EqualArray(fields, sorted) {
-		reports = append(reports, internal.Report{
+		reports = append(reports, models.Report{
 			Rule:    l.rule,
 			Message: "linters fields are not sorted",
 		})
@@ -54,7 +59,7 @@ func (l LinterFieldsSorted) Lint(golangci internal.Golangci) []internal.Report {
 	return reports
 }
 
-func (l LinterFieldsSorted) Fix(golangci internal.Golangci) error {
+func (l LinterFieldsSorted) Fix(golangci models.Golangci) error {
 	linters, ok := golangci.GetLinters()
 	if !ok {
 		return nil