Commit9b26e71

committed

Correct readme filename regular expression

Missing parentheses resulted in the regular expression matching files that are not recognized as a readme by GitHub.

1 parent15c986b commit9b26e71Copy full SHA for 9b26e71

File tree

-1

lines changed

internal/rule/rulefunction
- rulefunction.go
- testdata/general/no-readme
  - notreadme.md

-1

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ type Type func() (result ruleresult.Type, output string)`
`35`	`35`	`// MissingReadme checks if the project has a readme that will be recognized by GitHub.`
`36`	`36`	`funcMissingReadme() (result ruleresult.Type,outputstring) {`
`37`	`37`	`// https://github.com/github/markup/blob/master/README.md`
`38`		-readmeRegexp:=regexp.MustCompile(`(?i)^readme\.(markdown)\|(mdown)\|(mkdn)\|(md)\|(textile)\|(rdoc)\|(org)\|(creole)\|(mediawiki)\|(wiki)\|(rst)\|(asciidoc)\|(adoc)\|(asc)\|(pod)\|(txt)$`)
	`38`	+readmeRegexp:=regexp.MustCompile(`(?i)^readme\.((markdown)\|(mdown)\|(mkdn)\|(md)\|(textile)\|(rdoc)\|(org)\|(creole)\|(mediawiki)\|(wiki)\|(rst)\|(asciidoc)\|(adoc)\|(asc)\|(pod)\|(txt))$`)
`39`	`39`
`40`	`40`	`// https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes#about-readmes`
`41`	`41`	`ifpathContainsRegexpMatch(projectdata.ProjectPath(),readmeRegexp)\|\|`

File renamed without changes.

Comments

(0)