report(docs): deduplicate package headers into single doc files

Emin-ACIKGOZ · Emin-ACIKGOZ · commit 068e2ef5f11c · 2026-02-20T23:01:28.000+03:00
diff --git a/cmd/apply.go b/cmd/apply.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package cmd implements the command-line commands for scbake.
 package cmd
 
 import (
diff --git a/cmd/doc.go b/cmd/doc.go
@@ -0,0 +1,2 @@
+// Package cmd implements the command-line commands for scbake.
+package cmd
diff --git a/cmd/list.go b/cmd/list.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package cmd implements the command-line commands for scbake.
 package cmd
 
 import (
diff --git a/cmd/new.go b/cmd/new.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package cmd implements the command-line commands for scbake.
 package cmd
 
 import (
diff --git a/cmd/root.go b/cmd/root.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package cmd implements the command-line commands for scbake.
 package cmd
 
 import (
diff --git a/internal/core/doc.go b/internal/core/doc.go
@@ -0,0 +1,2 @@
+// Package core contains the execution logic for running a scaffold plan.
+package core
diff --git a/internal/core/executor.go b/internal/core/executor.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package core contains the execution logic for running a scaffold plan.
 package core
 
 import (
diff --git a/internal/core/run.go b/internal/core/run.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package core contains the central execution and planning logic.
 package core
 
 import (
diff --git a/internal/filesystem/transaction/doc.go b/internal/filesystem/transaction/doc.go
@@ -0,0 +1,2 @@
+// Package transaction provides a filesystem-based undo log for atomic file operations.
+package transaction
diff --git a/internal/filesystem/transaction/manager.go b/internal/filesystem/transaction/manager.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package transaction provides a filesystem-based undo log for atomic file operations.
 package transaction
 
 import (
diff --git a/internal/manifest/doc.go b/internal/manifest/doc.go
@@ -0,0 +1,2 @@
+// Package manifest provides functions for reading and writing the scbake manifest file (scbake.toml).
+package manifest
diff --git a/internal/manifest/io.go b/internal/manifest/io.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package manifest provides functions for reading and writing the scbake manifest file (scbake.toml).
 package manifest
 
 import (
diff --git a/internal/preflight/checks.go b/internal/preflight/checks.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package preflight contains essential checks run before executing a scaffolding plan.
 package preflight
 
 import (
diff --git a/internal/preflight/doc.go b/internal/preflight/doc.go
@@ -0,0 +1,2 @@
+// Package preflight contains essential checks run before executing a scaffolding plan.
+package preflight
diff --git a/internal/types/doc.go b/internal/types/doc.go
@@ -0,0 +1,2 @@
+// Package types holds the core data structures for the scbake manifest and tasks.
+package types
diff --git a/internal/types/manifest.go b/internal/types/manifest.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package types holds the core data structures for the scbake manifest and tasks.
 package types
 
 // Manifest is the root structure of the scbake.toml file.
diff --git a/internal/types/plan.go b/internal/types/plan.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package types holds the core data structures for the scbake manifest and tasks.
 package types
 
 import (
diff --git a/internal/types/priority.go b/internal/types/priority.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package types holds the core data structures for the scbake manifest and tasks.
 package types
 
 import (
diff --git a/internal/util/doc.go b/internal/util/doc.go
@@ -0,0 +1,2 @@
+// Package util provides general utility functions used across the scbake project.
+package util
diff --git a/internal/util/fileutil/doc.go b/internal/util/fileutil/doc.go
@@ -0,0 +1,2 @@
+// Package fileutil provides centralized constants for filesystem metadata and permissions.
+package fileutil
diff --git a/internal/util/fileutil/names.go b/internal/util/fileutil/names.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package fileutil provides centralized constants for filesystem metadata and permissions.
 package fileutil
 
 const (
diff --git a/internal/util/sanitize.go b/internal/util/sanitize.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package util provides general utility functions used across the scbake project.
 package util
 
 import (
diff --git a/pkg/lang/doc.go b/pkg/lang/doc.go
@@ -0,0 +1,2 @@
+// Package lang provides the registry and interface for language-specific tasks.
+package lang
diff --git a/pkg/lang/go/doc.go b/pkg/lang/go/doc.go
@@ -0,0 +1,2 @@
+// Package golang provides the task handler for initializing Go projects.
+package golang
diff --git a/pkg/lang/go/go.go b/pkg/lang/go/go.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package golang provides the task handler for initializing Go projects.
 package golang
 
 import (
diff --git a/pkg/lang/registry.go b/pkg/lang/registry.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package lang provides the registry and interface for language-specific tasks.
 package lang
 
 import (
diff --git a/pkg/lang/spring/doc.go b/pkg/lang/spring/doc.go
@@ -0,0 +1,2 @@
+// Package spring provides the task handler for initializing Spring Boot projects.
+package spring
diff --git a/pkg/lang/spring/spring.go b/pkg/lang/spring/spring.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package spring provides the task handler for initializing Spring Boot projects.
 package spring
 
 import (
diff --git a/pkg/lang/svelte/doc.go b/pkg/lang/svelte/doc.go
@@ -0,0 +1,2 @@
+// Package svelte provides the task handler for initializing Svelte projects.
+package svelte
diff --git a/pkg/lang/svelte/svelte.go b/pkg/lang/svelte/svelte.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package svelte provides the task handler for initializing Svelte projects.
 package svelte
 
 import (
diff --git a/pkg/tasks/create_directory.go b/pkg/tasks/create_directory.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package tasks defines the executable units of work used in a scaffolding plan.
 package tasks
 
 import (
diff --git a/pkg/tasks/create_template.go b/pkg/tasks/create_template.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package tasks defines the executable units of work used in a scaffolding plan.
 package tasks
 
 import (
diff --git a/pkg/tasks/doc.go b/pkg/tasks/doc.go
@@ -0,0 +1,2 @@
+// Package tasks defines the executable units of work used in a scaffolding plan.
+package tasks
diff --git a/pkg/tasks/exec_command.go b/pkg/tasks/exec_command.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package tasks defines the executable units of work used in a scaffolding plan.
 package tasks
 
 import (
diff --git a/pkg/templates/ci_github/ci_github.go b/pkg/templates/ci_github/ci_github.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package cighub provides the task handler for setting up GitHub Actions CI.
 package cighub
 
 import (
diff --git a/pkg/templates/ci_github/doc.go b/pkg/templates/ci_github/doc.go
@@ -0,0 +1,2 @@
+// Package cighub provides the task handler for setting up GitHub Actions CI.
+package cighub
diff --git a/pkg/templates/devcontainer/devcontainer.go b/pkg/templates/devcontainer/devcontainer.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package devcontainer provides the task handler for setting up Dev Containers (VS Code).
 package devcontainer
 
 import (
diff --git a/pkg/templates/devcontainer/doc.go b/pkg/templates/devcontainer/doc.go
@@ -0,0 +1,2 @@
+// Package devcontainer provides the task handler for setting up Dev Containers (VS Code).
+package devcontainer
diff --git a/pkg/templates/doc.go b/pkg/templates/doc.go
@@ -0,0 +1,2 @@
+// Package templates provides the registry and interface for tooling template handlers.
+package templates
diff --git a/pkg/templates/editorconfig/doc.go b/pkg/templates/editorconfig/doc.go
@@ -0,0 +1,2 @@
+// Package editorconfig provides the task handler for setting up universal editor configuration.
+package editorconfig
diff --git a/pkg/templates/editorconfig/editorconfig.go b/pkg/templates/editorconfig/editorconfig.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package editorconfig provides the task handler for setting up universal editor configuration.
 package editorconfig
 
 import (
diff --git a/pkg/templates/git/doc.go b/pkg/templates/git/doc.go
@@ -0,0 +1,2 @@
+// Package git provides the template handler for initializing a Git repository.
+package git
diff --git a/pkg/templates/git/git.go b/pkg/templates/git/git.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package git provides the template handler for initializing a Git repository.
 package git
 
 import (
diff --git a/pkg/templates/go_linter/doc.go b/pkg/templates/go_linter/doc.go
@@ -0,0 +1,2 @@
+// Package golinter provides the task handler for setting up Go linting via golangci-lint.
+package golinter
diff --git a/pkg/templates/go_linter/go_linter.go b/pkg/templates/go_linter/go_linter.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package golinter provides the task handler for setting up Go linting via golangci-lint.
 package golinter
 
 import (
diff --git a/pkg/templates/makefile/doc.go b/pkg/templates/makefile/doc.go
@@ -0,0 +1,2 @@
+// Package makefile provides the task handler for setting up a universal Makefile.
+package makefile
diff --git a/pkg/templates/makefile/makefile.go b/pkg/templates/makefile/makefile.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package makefile provides the task handler for setting up a universal Makefile.
 package makefile
 
 import (
diff --git a/pkg/templates/maven_linter/doc.go b/pkg/templates/maven_linter/doc.go
@@ -0,0 +1,2 @@
+// Package mavenlinter provides the task handler for setting up Maven Checkstyle linting.
+package mavenlinter
diff --git a/pkg/templates/maven_linter/maven_linter.go b/pkg/templates/maven_linter/maven_linter.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package mavenlinter provides the task handler for setting up Maven Checkstyle linting.
 package mavenlinter
 
 import (
diff --git a/pkg/templates/registry.go b/pkg/templates/registry.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package templates provides the registry and interface for tooling template handlers.
 package templates
 
 import (
diff --git a/pkg/templates/svelte_linter/doc.go b/pkg/templates/svelte_linter/doc.go
@@ -0,0 +1,2 @@
+// Package sveltelinter provides the task handler for setting up Svelte linting via ESLint.
+package sveltelinter
diff --git a/pkg/templates/svelte_linter/svelte_linter.go b/pkg/templates/svelte_linter/svelte_linter.go
@@ -1,7 +1,6 @@
 // Copyright 2025 Emin Salih Açıkgöz
 // SPDX-License-Identifier: gpl3-or-later
 
-// Package sveltelinter provides the task handler for setting up Svelte linting via ESLint.
 package sveltelinter
 
 import (

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package cmd implements the command-line commands for scbake.`
	`2`	`+package cmd`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package core contains the execution logic for running a scaffold plan.`
	`2`	`+package core`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package transaction provides a filesystem-based undo log for atomic file operations.`
	`2`	`+package transaction`