feat: skip "examples" directory check for output extensions

checker_module.go

@@ -2,7 +2,9 @@ package k6lint
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"io/fs"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -149,3 +151,52 @@ func (mc *moduleChecker) types(_ context.Context, dir string) *checkResult {
 
 	return checkFailed("no `index.d.ts` file found")
 }
+
+//nolint:forbidigo
+func (mc *moduleChecker) examples(_ context.Context, dir string) *checkResult {
+	if mc.exe == "" {
+		return checkFailed("can't build")
+	}
+
+	if !mc.js {
+		return checkPassed("skipped due to output extension")
+	}
+
+	dir = filepath.Join(dir, "examples")
+
+	info, err := os.Stat(dir)
+	if err != nil {
+		if errors.Is(err, os.ErrNotExist) {
+			return checkFailed("missing `examples` directory")
+		}
+
+		return checkError(err)
+	}
+
+	if !info.IsDir() {
+		return checkFailed("`examples` is not a directory")
+	}
+
+	hasRegular := false
+
+	err = filepath.WalkDir(dir, func(_ string, entry fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if entry.Type().IsRegular() {
+			hasRegular = true
+		}
+
+		return nil
+	})
+	if err != nil {
+		return checkError(err)
+	}
+
+	if hasRegular {
+		return checkPassed("found `examples` as examples directory")
+	}
+
+	return checkFailed("no examples found in the `examples` directory")
+}

checks.go

@@ -39,12 +39,12 @@ func checkDefinitions(official bool) []checkDefinition {
 		{id: CheckerModule, score: 2, fn: modCheck.hasGoModule},
 		{id: CheckerReplace, score: 2, fn: modCheck.hasNoReplace},
 		{id: CheckerReadme, score: 5, fn: checkerReadme},
-		{id: CheckerExamples, score: 2, fn: checkerExamples},
 		{id: CheckerLicense, score: 5, fn: checkerLicense},
 		{id: CheckerGit, score: 1, fn: gitCheck.isWorkDir},
 		{id: CheckerVersions, score: 5, fn: gitCheck.hasVersions},
 		{id: CheckerBuild, score: 5, fn: modCheck.canBuild},
 		{id: CheckerSmoke, score: 2, fn: modCheck.smoke},
+		{id: CheckerExamples, score: 2, fn: modCheck.examples},
 		{id: CheckerTypes, score: 2, fn: modCheck.types},
 	}