Unmarking file with "-linguist-generated" broken in GitHub Preview

[HaraldNordgren]

Describe the bug

-linguist-generated to unmark files doesn't work.

Have a file starting like this and try to get linguist NOT to see it as a generated file:

package resolver

// This file will be automatically regenerated based on the schema, any resolver implementations
// will be copied through when generating and any unknown code will be moved to the end.
// Code generated by github.com/99designs/gqlgen version v0.17.74

import (
...

Expected behaviour

File is not marked as generated anymore.

Related discussion

99designs/gqlgen#3763

Additional notes

[lildude]

The -linguist-generated override does work, and we even have a test for it, so this is not likely a bug and as such I've converted this to a classification discussion.

The most likely explanation is the file isn't only being considered as generated by Linguist and there is something else at play - most likely it's also being considered vendored, which means you'll need to use two overrides.

You've not provided a link to a repo experiencing this issue so I did a search for *.resolvers.go but couldn't find any files that contained the // Code generated by… line (not surprising as I wouldn't expect GitHub's search to index generated files) so I cloned the first repo I found searching for path:*.resolvers.go - https://github.com/graphikDB/graphik - and got testing:

➜ head -5 graphik/gql/schema.resolvers.go
package gql

// This file will be automatically regenerated based on the schema, any resolver implementations
// will be copied through when generating and any unknown code will be moved to the end.

➜ github-linguist graphik/gql/schema.resolvers.go
graphik/gql/schema.resolvers.go: 718 lines (670 sloc)
  type:      Text
  mime type: text/plain
  language:  Go
➜ github-linguist graphik/ --breakdown | grep resolvers.go
gql/schema.resolvers.go
➜

Great! It's not considered generated without that line. Lets add the line:

➜ vi graphik/gql/schema.resolvers.go
➜ git -C graphik commit -m 'Add generated by'
[master efd7ceb] Add generated by
 1 file changed, 9 insertions(+), 5 deletions(-)
➜ head -5 graphik/gql/schema.resolvers.go
package gql

// This file will be automatically regenerated based on the schema, any resolver implementations
// will be copied through when generating and any unknown code will be moved to the end.
// Code generated by github.com/99designs/gqlgen version v0.17.74
➜ github-linguist graphik/gql/schema.resolvers.go
graphik/gql/schema.resolvers.go: 722 lines (673 sloc)
  type:      Text
  mime type: text/plain
  language:  Go
  appears to be generated source code
➜ github-linguist graphik/ --breakdown | grep resolvers.go
➜ 

Great! It's now being considered generated. Lets override linguist using -linguist-generated:

➜ echo "\n**/*.resolvers.go -linguist-generated" >> graphik/.gitattributes
➜ cat graphik/.gitattributes
/gen/grpc/csharp/* linguist-vendored
/gen/grpc/js/* linguist-vendored
/gen/grpc/java/* linguist-vendored
/gen/grpc/python/* linguist-vendored
/gen/grpc/php/* linguist-vendored
/gen/gql/docs/* linguist-vendored
/gen/grpc/docs/* linguist-vendored
**/*.resolvers.go -linguist-generated
➜ git -C graphik add .
➜ git -C graphik commit -m 'Add override'
[master 4393b2c] Add override
 1 file changed, 2 insertions(+), 1 deletion(-)
➜ github-linguist graphik/gql/schema.resolvers.go
graphik/gql/schema.resolvers.go: 722 lines (673 sloc)
  type:      Text
  mime type: text/plain
  language:  Go
➜ github-linguist graphik/ --breakdown | grep resolvers.go
gql/schema.resolvers.go
➜ 

And 🎉 the schema.resolver.go file is no longer considered generated thus proving the override works as expected.

As I mentioned before, something else is likely at play.

If you can provide a link to a repo experiencing the problem, I can take a look and provide an explanation.

[HaraldNordgren]

Hi @lildude, here is a minimal example where the issue appears: https://github.com/HaraldNordgren/linguist-issue/pull/1/files

[HaraldNordgren]

Using the old GitHub experience (turning off the preview), then it looks like it should.

I think what you said about caching doesn't seem to hold (at least for the old experience). This is good because it makes debugging easier when linguist changes show up directly before merging the PR.

[lildude]

Using the old GitHub experience (turning off the preview), then it looks like it should.

... and ...

I reported it here as a bug with preview: https://github.com/orgs/community/discussions/163932#discussioncomment-14881485

Ah ha! Good find and thanks for reporting it.

[HaraldNordgren]

@lildude Do you also work on the GitHub Preview and have time to fix the issue there? 🤗

[lildude]

Unfortunately, I don't.

[HaraldNordgren]

Alright, thanks for you help so far! 🤗

[lildude]

Hey, you deleted your comment whilst I was repling so I'll reply anyway 😁

I created a PR to fix the docs as well, they misleading on how to set a negative condition for linguist-generated since linguist-generated=false doesn't actually work

🤨 It most definitely does work:

➜ cat graphik/.gitattributes
/gen/grpc/csharp/* linguist-vendored
/gen/grpc/js/* linguist-vendored
/gen/grpc/java/* linguist-vendored
/gen/grpc/python/* linguist-vendored
/gen/grpc/php/* linguist-vendored
/gen/gql/docs/* linguist-vendored
/gen/grpc/docs/* linguist-vendored
**/*.resolvers.go linguist-generated=false
➜ github-linguist graphik/gql/schema.resolvers.go
graphik/gql/schema.resolvers.go: 722 lines (673 sloc)
  type:      Text
  mime type: text/plain
  language:  Go
➜ github-linguist graphik/ --breakdown | grep resolvers.go
gql/schema.resolvers.go
➜ 

The use of linguist-blah=(true|false) is historic and Linguist-specific. The correct approach for setting and unsetting is as per the .gitattributes docs which Linguist supports as of #4780, ie

• Set: linguist-blah
• Unset: -linguist-blah

So if you're going to propose a change to the docs, I'd recommend using the formal approach, not the Linguist-specific approach. It's what we document in our own project docs.

[HaraldNordgren]

My bad, yes it works!

Updated the PR now: github/docs#41130

It's good to clarify how to unset it to not leave users on their own with this 🤗

[lildude]

I've just seen your update to the PR. Thanks 🙇