Merge pull request #1863 from ianlewis/1782-feature-support-parsing-stdin

feat: support reading from stdin

Author: ianlewis

.golangci.yml

@@ -548,22 +548,36 @@ linters:
   exclusions:
     # Mode of the generated files analysis.
     #
-    # - `strict`: sources are excluded by strictly following the Go generated file convention.
-    #    Source files that have lines matching only the following regular expression will be excluded: `^// Code generated .* DO NOT EDIT\.$`
-    #    This line must appear before the first non-comment, non-blank text in the file.
+    # - `strict`: sources are excluded by strictly following the Go generated
+    #    file convention.
+    #    Source files that have lines matching only the following regular
+    #    expression will be excluded: `^// Code generated .* DO NOT EDIT\.$`
+    #    This line must appear before the first non-comment, non-blank text in
+    #    the file.
     #    https://go.dev/s/generatedcode
-    # - `lax`: sources are excluded if they contain lines like `autogenerated file`, `code generated`, `do not edit`, etc.
+    # - `lax`: sources are excluded if they contain lines like
+    #   `autogenerated file`, `code generated`, `do not edit`, etc.
     # - `disable`: disable the generated files exclusion.
     #
     # Default: strict
     generated: lax
 
-    # Log a warning if an exclusion rule is unused.
-    # Default: false
-    warn-unused: true
-
     # Predefined exclusion rules.
     presets:
       - common-false-positives
       - legacy
       - std-error-handling
+
+    # Log a warning if an exclusion rule is unused.
+    # Default: false
+    warn-unused: true
+
+    # Exclude some linters from running on test files.
+    rules:
+      - path: _test\.go
+        linters:
+          - gocyclo
+          - cyclop
+          - errcheck
+          - dupl
+          - gosec

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - A new `--language` flag was added to allow users to override the language of
   files being scanned ([#1850](https://github.com/ianlewis/todos/issues/1850)).
+- Support was added for reading from standard input with the '-' filename
+  ([#1782](https://github.com/ianlewis/todos/issues/1782)).
 
 ## [`0.14.0`] - 2025-12-20
 

cmd/todos/app_test.go

@@ -120,8 +120,7 @@ func Test_TODOsApp_Walk(t *testing.T) {
 		},
 	}
 
-	d := testutils.NewTempDir(files, nil)
-	defer d.Cleanup()
+	d := testutils.NewTempDir(t, files, nil)
 
 	app := newTODOsApp()
 
@@ -152,8 +151,7 @@ func Test_TODOsApp_Walk_no_todos(t *testing.T) {
 		},
 	}
 
-	d := testutils.NewTempDir(files, nil)
-	defer d.Cleanup()
+	d := testutils.NewTempDir(t, files, nil)
 
 	app := newTODOsApp()
 

internal/scanner/scanner.go

@@ -159,7 +159,7 @@ func FromBytes(fileName string, rawContents []byte, lang, charset string) (*Comm
 	}
 
 	if lang == enry.OtherLanguage {
-		return nil, fmt.Errorf("%w: %s", ErrUnsupportedLanguage, lang)
+		return nil, fmt.Errorf("%w: %s: language could not be detected", ErrUnsupportedLanguage, fileName)
 	}
 
 	// Detect the language encoding.

internal/scanner/scanner_test.go

@@ -3878,20 +3878,27 @@ func TestFromFile(t *testing.T) {
 			t.Parallel()
 			// Create a temporary file.
 			// NOTE: File extensions are used as hints so the file name must be part of the suffix.
-			f := testutils.Must(os.CreateTemp(t.TempDir(), "*."+testCase.name))
+			f, err := os.CreateTemp(t.TempDir(), "*."+testCase.name)
+			testutils.Check(t, err)
+
 			defer f.Close()
 
 			var w io.Writer
 
 			w = f
 
 			if testCase.charset != "" {
-				e := testutils.Must(ianaindex.IANA.Encoding(testCase.charset))
+				e, encErr := ianaindex.IANA.Encoding(testCase.charset)
+				testutils.Check(t, encErr)
+
 				w = e.NewEncoder().Writer(f)
 			}
 
-			_ = testutils.Must(w.Write(testCase.src))
-			_ = testutils.Must(f.Seek(0, io.SeekStart))
+			_, err = w.Write(testCase.src)
+			testutils.Check(t, err)
+
+			_, err = f.Seek(0, io.SeekStart)
+			testutils.Check(t, err)
 
 			s, err := FromFile(f, testCase.lang, testCase.scanCharset)
 			if diff := cmp.Diff(testCase.err, err, cmpopts.EquateErrors()); diff != "" {
@@ -3922,8 +3929,11 @@ func TestFromBytes(t *testing.T) {
 			text := tc.src
 
 			if tc.charset != "" {
-				e := testutils.Must(ianaindex.IANA.Encoding(tc.charset))
-				text = testutils.Must(e.NewDecoder().Bytes(tc.src))
+				e, err := ianaindex.IANA.Encoding(tc.charset)
+				testutils.Check(t, err)
+
+				text, err = e.NewDecoder().Bytes(tc.src)
+				testutils.Check(t, err)
 			}
 
 			s, err := FromBytes(tc.name, text, tc.lang, tc.scanCharset)

internal/testutils/gitrepo.go

@@ -17,6 +17,7 @@ package testutils
 import (
 	"os"
 	"path/filepath"
+	"testing"
 	"time"
 
 	"github.com/go-git/go-git/v5"
@@ -31,14 +32,17 @@ type TestRepo struct {
 
 // NewTestRepo creates a new TestRepo with the given files committed into a
 // single commit in the repo.
-func NewTestRepo(dir, author, email string, files []*File, links []*Symlink) *TestRepo {
+func NewTestRepo(t *testing.T, dir, author, email string, files []*File, links []*Symlink) *TestRepo {
+	t.Helper()
+
 	testRepo := &TestRepo{
 		dir: dir,
 	}
+	repoDir, err := git.PlainInit(testRepo.dir, false)
+	testRepo.repo = Must(t, repoDir, err)
 
-	testRepo.repo = Must(git.PlainInit(testRepo.dir, false))
-
-	worktree := Must(testRepo.repo.Worktree())
+	worktree, err := testRepo.repo.Worktree()
+	Check(t, err)
 
 	const readWriteExec = os.FileMode(0o700)
 
@@ -47,47 +51,51 @@ func NewTestRepo(dir, author, email string, files []*File, links []*Symlink) *Te
 			fullPath := filepath.Join(testRepo.dir, f.Path)
 
 			// Create necessary sub-directories.
-			Check(os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
+			Check(t, os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
 
 			// Write the file
-			Check(os.WriteFile(fullPath, f.Contents, f.Mode))
+			Check(t, os.WriteFile(fullPath, f.Contents, f.Mode))
 
 			// git add <file>
-			_ = Must(worktree.Add(f.Path))
+			_, err := worktree.Add(f.Path)
+			Check(t, err)
 		}
 
 		// git commit <file>
-		_ = Must(worktree.Commit("add files", &git.CommitOptions{
+		_, err := worktree.Commit("add files", &git.CommitOptions{
 			Author: &object.Signature{
 				Name:  author,
 				Email: email,
 				When:  time.Now(),
 			},
-		}))
+		})
+		Check(t, err)
 	}
 
 	if len(links) > 0 {
 		for _, link := range links {
 			fullPath := filepath.Join(testRepo.dir, link.Path)
 
 			// Create necessary sub-directories.
-			Check(os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
+			Check(t, os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
 
 			// Create the symbolic link.
-			Check(os.Symlink(link.Target, fullPath))
+			Check(t, os.Symlink(link.Target, fullPath))
 
 			// git add <file>
-			_ = Must(worktree.Add(link.Path))
+			_, err := worktree.Add(link.Path)
+			Check(t, err)
 		}
 
 		// git commit <file>
-		_ = Must(worktree.Commit("add links", &git.CommitOptions{
+		_, err := worktree.Commit("add links", &git.CommitOptions{
 			Author: &object.Signature{
 				Name:  author,
 				Email: email,
 				When:  time.Now(),
 			},
-		}))
+		})
+		Check(t, err)
 	}
 
 	return testRepo

internal/testutils/gitrepo_test.go

@@ -39,11 +39,10 @@ func TestTempRepo(t *testing.T) {
 	t.Parallel()
 
 	testCases := map[string]struct {
-		author      string
-		email       string
-		files       []*File
-		links       []*Symlink
-		expectPanic bool
+		author string
+		email  string
+		files  []*File
+		links  []*Symlink
 	}{
 		"no files": {
 			author: "John Doe",
@@ -71,18 +70,6 @@ func TestTempRepo(t *testing.T) {
 				},
 			},
 		},
-		"bad file": {
-			author: "John Doe",
-			email:  "john@doe.com",
-			files: []*File{
-				{
-					Path:     "../../../../../../../testfile.txt",
-					Contents: []byte("foo"),
-					Mode:     0o600,
-				},
-			},
-			expectPanic: true,
-		},
 		"multi-file": {
 			author: "John Doe",
 			email:  "john@doe.com",
@@ -154,16 +141,17 @@ func TestTempRepo(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			t.Parallel()
 
-			defer func() {
-				if r := recover(); r != nil && !testCase.expectPanic {
-					t.Fatalf("unexpected panic: %v", r)
-				}
-			}()
+			tmpDir := NewTempDir(t, nil, nil)
 
-			tmpDir := NewTempDir(nil, nil)
-			defer tmpDir.Cleanup()
+			d := NewTestRepo(
+				t,
+				tmpDir.Dir(),
+				testCase.author,
+				testCase.email,
+				testCase.files,
+				testCase.links,
+			)
 
-			d := NewTestRepo(tmpDir.Dir(), testCase.author, testCase.email, testCase.files, testCase.links)
 			baseDir := d.Dir()
 
 			// Check that the temporary directory exists.

internal/testutils/tempdir.go

@@ -17,6 +17,7 @@ package testutils
 import (
 	"os"
 	"path/filepath"
+	"testing"
 )
 
 // TempDir is a temporary directory which is set up with a directory structure
@@ -49,43 +50,33 @@ type Symlink struct {
 
 // NewTempDir creates a new TempDir. This creates a new temporary directory and
 // fills it with the files given. Intermediate directories are created
-// automatically with 0700 permissions. This function panics if an error occurs
-// when creating the files.
-func NewTempDir(files []*File, links []*Symlink) *TempDir {
-	d := &TempDir{}
+// automatically with 0700 permissions. This function calls t.Fatal if an error
+// occurs when creating the files.
+func NewTempDir(t *testing.T, files []*File, links []*Symlink) *TempDir {
+	t.Helper()
 
-	d.dir = Must(os.MkdirTemp("", "testutils"))
+	d := &TempDir{}
 
-	cleanup, cancel := WithCancel(func() {
-		d.Cleanup()
-	}, nil)
-	defer cleanup()
+	d.dir = t.TempDir()
 
 	const readWriteExec = os.FileMode(0o700)
 
 	for _, file := range files {
 		fullPath := filepath.Join(d.dir, file.Path)
-		Check(os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
-		Check(os.WriteFile(fullPath, file.Contents, file.Mode))
+		Check(t, os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
+		Check(t, os.WriteFile(fullPath, file.Contents, file.Mode))
 	}
 
 	for _, link := range links {
 		fullPath := filepath.Join(d.dir, link.Path)
-		Check(os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
-		Check(os.Symlink(link.Target, fullPath))
+		Check(t, os.MkdirAll(filepath.Dir(fullPath), readWriteExec))
+		Check(t, os.Symlink(link.Target, fullPath))
 	}
 
-	cancel()
-
 	return d
 }
 
 // Dir returns the path to the directory.
 func (d *TempDir) Dir() string {
 	return d.dir
 }
-
-// Cleanup deletes the test directory.
-func (d *TempDir) Cleanup() {
-	Check(os.RemoveAll(d.dir))
-}