Release v0.6.0 #45

denis-tingaikin · 2025-04-13T14:45:10Z

Motivation

Fixes next issues:
1. #35
2. #43
3. #46
4. #44
5. #41

denis-tingaikin · 2025-04-13T14:53:36Z

@ldez, @firelizzard18 would be appreciated if you could review these changes.

UPD: Going to merge this next week.

Copilot

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

reader.go

analyzer.go

ldez · 2025-04-13T18:04:20Z

I suggest merging PR #47 before and rewriting the tests of this PR based on the other one.

firelizzard18 · 2025-04-14T00:17:45Z

analyzer.go

 	}

 	file := target.File
 	var header string
 	var offset = Location{
 		Position: 1,
 	}
+
+	if isNewLinewRequired(file.Comments) {
+		return NewIssueWithLocation(


Ideally this would include a fix so golangci-lint can automatically apply it. IIUC the Line value will point to the line after the comment as being the error location, so I think Fix{Actual: []string{}, Expected: []string{""}}, would be sufficient. Unfortunately my attempt to test it failed - isNewLineRequired is returning false.

@ldez Thoughts?

golangci-lint can already apply fixes.

I think the current implementation based on io.reader is hard to maintain and has some limitations.

firelizzard18 · 2025-04-14T20:16:54Z

analyzer.go

+func isNewLinewRequired(group []*ast.CommentGroup) bool {
+	if len(group[0].List) > 1 {
+		for _, item := range group[0].List {
+			if strings.HasPrefix(item.Text, "/*") {
+				return true
+			}
+		}
+	}
+
+	if len(group) < 2 {
+		return false
+	}
+	return group[0].End() >= group[1].Pos()
+}


I don't understand how this works. I tried to test adding a fix but in both cases below isNewLineRequired returns false.

/* mycompany.com SPDX-License-Identifier: Foo */ package foo

// mycompany.com // SPDX-License-Identifier: Foo package foo

It would also be nice to detect this:

// mycompany.com // SPDX-License-Identifier: Foo // Package foo package foo

ldez · 2025-04-14T20:30:38Z

@firelizzard18 FYI, I made some suggestions about the linter (not this PR) to @denis-tingaikin in DM, and one of them is to rewrite the linter to use analysis.Analyzer.

IMHO, the current implementation based on io.reader is hard to maintain and has some limitations.

1. #35 2. #43 Signed-off-by: Denis Tingaikin <[email protected]>

Signed-off-by: Denis Tingaikin <[email protected]>

Copilot

Pull Request Overview

This PR fixes header handling issues by ensuring there's an explicit check for an empty newline immediately after the header and correctly processing unicode headers. It also refactors configuration types (renaming from Configuration to Config), updates test cases accordingly, and modernizes string handling in reader.go.

Introduces a newline check after the header with a clear message.
Renames Configuration to Config and adjusts associated helper functions.
Updates tests and documentation to support unicode headers and new configuration format.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
testdata/starcomment/starcomment.yml	Updates header template and variable naming for star comment
testdata/starcomment/starcomment.go	Adjusts header processing for star block comments
testdata/nestedvalues/nestedvalues.yml	Replaces deprecated "values" with "vars"
testdata/fix/fix.yml	Corrects header placeholder from MY COMPANY to .MY_COMPANY
testdata/constvalue/constvalue.yml	Changes header variable interpolation from YEAR to .YEAR
reader.go	Converts string source to []rune and refines header parsing
go.mod	Bumps Go version from 1.21 to 1.24
config.go	Renames Configuration to Config and updates field names
cmd/go-header/main.go	Refactors main to use the new Config type
analyzer_test.go	Updates test cases reflecting the new header and config format
analyzer.go	Implements newline check for header and additional helper funcs
README.md	Updates configuration instructions to align with new config vars
.github/workflows/ci.yml	Excludes testdata folders from CI runs

Comments suppressed due to low confidence (1)

reader.go:103

The function 'min' is used here but is not defined anywhere. Consider defining a helper function (e.g., func min(a, b int) int { ... }) or use an inline comparison to determine the minimum.

minVal := min(len(r.source), r.position)

Signed-off-by: Denis Tingaikin <[email protected]>

Copilot

Pull Request Overview

This pull request implements the v1.0.0 release addressing several issues by updating version references, refactoring configuration and header analysis logic, and refreshing tests, documentation, and CI workflow settings.

Update version strings and copyright dates
Refactor configuration handling by renaming Configuration to Config and merging vars into value processing
Improve header analysis in Analyzer with enhanced newline and star block handling, plus integrate go/analysis

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
version/version.go	Update version string to "v1.0.0"
testdata/starcomment/*	Update YAML and Go files to use new header template syntax
testdata/nestedvalues/nestedvalues.yml	Switch from deprecated “values” to “vars” format
testdata/fix/fix.yml	Replace raw key formatting with dot notation (.MY_COMPANY)
testdata/constvalue/constvalue.yml	Update template syntax for constant values
reader.go	Change source type from string to []rune and rename variable
go.mod	Update Go version to 1.24 and add required tools
config.go	Rename Configuration to Config; update GetValues and other methods
cmd/go-header/main.go	Enhance command line flag handling and switch to Analyzer
analyzer_test.go	Modify tests to use t.TempDir() and adopt the new config type
analyzer.go	Refactor Analyzer to use getPerTargetValues and add newline/star block handling
analysis.go	Add new go/analysis Analyzer integration
README.md	Revise documentation and configuration examples
.go-header.yml	Update configuration format from “values” to “vars”
.github/workflows/ci.yml	Update CI workflow to use Go 1.24 and adjust file targeting

config.go

analyzer.go

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin · 2025-05-10T17:56:48Z

@ldez , @firelizzard18 I just decided to rework everything with modern go tools for fun, please have a look at #49

denis-tingaikin requested a review from Copilot April 13, 2025 14:53

Copilot AI reviewed Apr 13, 2025

View reviewed changes

reader.go Show resolved Hide resolved

analyzer.go Outdated Show resolved Hide resolved

denis-tingaikin mentioned this pull request Apr 14, 2025

tests: improve testability #47

Merged

firelizzard18 reviewed Apr 14, 2025

View reviewed changes

ldez mentioned this pull request Apr 19, 2025

feat: add golicenser linter golangci/golangci-lint#5751

Draft

denis-tingaikin added 3 commits May 8, 2025 17:51

fix issues:

9e3e45e

1. #35 2. #43 Signed-off-by: Denis Tingaikin <[email protected]>

fix ci

724119f

Signed-off-by: Denis Tingaikin <[email protected]>

rebase and add 'vars'

123ab1f

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin force-pushed the release/v0.6.0 branch from dbfdac9 to 123ab1f Compare May 8, 2025 15:15

fix tests and ci

ebb64bf

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin force-pushed the release/v0.6.0 branch from 4d85685 to ebb64bf Compare May 8, 2025 15:31

fix self check

adc22d3

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin force-pushed the release/v0.6.0 branch from a8f7ebd to 5d89dc8 Compare May 8, 2025 16:07

add star-block like headers support

0c76dad

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin force-pushed the release/v0.6.0 branch from 5d89dc8 to 0c76dad Compare May 8, 2025 16:18

denis-tingaikin requested a review from Copilot May 8, 2025 16:19

Copilot AI reviewed May 8, 2025

View reviewed changes

add analysis.Analyzer

8186b8e

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin force-pushed the release/v0.6.0 branch from 06d06b4 to 8186b8e Compare May 8, 2025 17:43

denis-tingaikin changed the title ~~fix: add check on an empty line after the header and correctly handle unicode headers~~ Release v1.0.0 May 8, 2025

denis-tingaikin added 2 commits May 8, 2025 21:33

add parallel execution support and plans

7a4c9ab

Signed-off-by: Denis Tingaikin <[email protected]>

simplify readme

167bd46

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin requested a review from Copilot May 8, 2025 18:38

Copilot AI reviewed May 8, 2025

View reviewed changes

config.go Show resolved Hide resolved

analyzer.go Show resolved Hide resolved

add fixes to be compatible with go tools

c7b2750

Signed-off-by: Denis Tingaikin <[email protected]>

denis-tingaikin force-pushed the release/v0.6.0 branch from eebdd7a to c7b2750 Compare May 8, 2025 18:57

denis-tingaikin changed the title ~~Release v1.0.0~~ WIP: Release v1.0.0 May 8, 2025

denis-tingaikin changed the title ~~WIP: Release v1.0.0~~ Release v0.6.0 May 10, 2025

denis-tingaikin closed this May 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release v0.6.0 #45

Release v0.6.0 #45

Uh oh!

denis-tingaikin commented Apr 13, 2025 •

edited

Loading

Uh oh!

denis-tingaikin commented Apr 13, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

ldez commented Apr 13, 2025

Uh oh!

firelizzard18 Apr 14, 2025

Uh oh!

denis-tingaikin May 8, 2025

Uh oh!

ldez May 8, 2025

Uh oh!

firelizzard18 Apr 14, 2025 •

edited

Loading

Uh oh!

firelizzard18 Apr 14, 2025

Uh oh!

ldez commented Apr 14, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

denis-tingaikin commented May 10, 2025

Uh oh!

Uh oh!

Release v0.6.0 #45

Release v0.6.0 #45

Uh oh!

Conversation

denis-tingaikin commented Apr 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Uh oh!

denis-tingaikin commented Apr 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ldez commented Apr 13, 2025

Uh oh!

firelizzard18 Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

denis-tingaikin May 8, 2025

Choose a reason for hiding this comment

Uh oh!

ldez May 8, 2025

Choose a reason for hiding this comment

Uh oh!

firelizzard18 Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

firelizzard18 Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

ldez commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

denis-tingaikin commented May 10, 2025

Uh oh!

Uh oh!

denis-tingaikin commented Apr 13, 2025 •

edited

Loading

denis-tingaikin commented Apr 13, 2025 •

edited

Loading

firelizzard18 Apr 14, 2025 •

edited

Loading

ldez commented Apr 14, 2025 •

edited

Loading