feat: don't skip .github dir (#441)

allow scanning for flag keys used in github workflows with
https://github.com/launchdarkly/gha-flags

Co-authored-by: Molly <[email protected]>

Author: jazanne

docs/ALIASES.md

@@ -123,3 +123,29 @@ For a file that has already been committed:
 ```sh
 git update-index --chmod=+x .launchdarkly/flagAlias.sh
 ```
+
+## Finding flags used in GitHub workflow files
+
+If you are using [launchdarkly/gha-flags](https://github.com/launchdarkly/gha-flags), your flag keys will not be wrapped in delimiters, so it is important to either configure the proper aliases or disable delimiters.
+
+Example alias configuration:
+
+```yaml
+// given flag key "enable-new-feature"
+aliases:
+  - type: kebabcase
+```
+
+```yaml
+// given flag key "enable_new_feature"
+aliases:
+  - type: snakecase
+```
+
+Example delimiter disable:
+
+```yaml
+delimiters:
+  disableDefaults: true # will find keys without surrounding delimiters like ' or "
+```
+

docs/CONFIGURATION.md

@@ -136,6 +136,6 @@ delimiters:
 
 ## Ignoring files and directories
 
-All dotfiles and patterns in `.gitignore` and `.ignore` will be excluded by default.
+All dotfiles and patterns in `.gitignore` and `.ignore` will be excluded by default, except the `.github` directory. Flags may be referenced when using [launchdarky/gha-flags](https://github.com/launchdarkly/gha-flags). If you would like to skip scanning these files, add `.github` to one of the ignore files.
 
 To ignore additional files and directories, provide a `.ldignore` file in the root directory of your Git repository. All patterns specified in `.ldignore` file will be excluded by the scanner. Patterns must follow the `.gitignore` format as specified here: https://git-scm.com/docs/gitignore#_pattern_format

search/files.go

@@ -80,11 +80,20 @@ func readFiles(ctx context.Context, files chan<- file, workspace string) error {
 		path = filepath.ToSlash(path)
 
 		// Skip directories, hidden files, and ignored files
-		if strings.HasPrefix(info.Name(), ".") || allIgnores.Match(path, isDir) {
+		if allIgnores.Match(path, isDir) {
 			if isDir {
 				return filepath.SkipDir
 			}
 			return nil
+		} else if strings.HasPrefix(info.Name(), ".") {
+			if isDir {
+				// don't skip github dir
+				if strings.HasPrefix(info.Name(), ".github") {
+					return nil
+				}
+				return filepath.SkipDir
+			}
+			return nil
 		} else if !info.Mode().IsRegular() {
 			return nil
 		}

search/files_test.go

@@ -9,24 +9,49 @@ import (
 )
 
 func Test_readFiles(t *testing.T) {
-	files := make(chan file, 8)
-	err := readFiles(context.Background(), files, "testdata")
-	require.NoError(t, err)
-	got := []file{}
-	for file := range files {
-		got = append(got, file)
-		switch file.path {
-		case "fileWithNoRefs":
-			assert.Equal(t, []string{"fileWithNoRefs"}, file.lines)
-		case "fileWithRefs":
-			assert.Equal(t, testFile.lines, file.lines)
-		case "ignoredFiles/included":
-			assert.Equal(t, []string{"IGNORED BUT INCLUDED"}, file.lines)
-		case "symlink":
-			assert.Fail(t, "Should not read symlink contents")
-		default:
-			assert.Fail(t, "Read unexpected file", file)
+	t.Run("don't ignore .github by default", func(t *testing.T) {
+		files := make(chan file, 8)
+		err := readFiles(context.Background(), files, "testdata/include-github-files")
+		require.NoError(t, err)
+		got := []file{}
+		for file := range files {
+			got = append(got, file)
+			switch file.path {
+			case "fileWithNoRefs":
+				assert.Equal(t, []string{"fileWithNoRefs"}, file.lines)
+			case "fileWithRefs", ".github/workflows/workflow.yml":
+				assert.Equal(t, testFile.lines, file.lines)
+			case "ignoredFiles/included":
+				assert.Equal(t, []string{"IGNORED BUT INCLUDED"}, file.lines)
+			case "symlink":
+				assert.Fail(t, "Should not read symlink contents")
+			default:
+				assert.Fail(t, "Read unexpected file", file)
+			}
 		}
-	}
-	assert.Len(t, got, 3, "Expected 3 valid files to have been found")
+		assert.Len(t, got, 4, "Expected 4 valid files to have been found")
+	})
+
+	t.Run("explicitly ignore .github files", func(t *testing.T) {
+		files := make(chan file, 8)
+		err := readFiles(context.Background(), files, "testdata/exclude-github-files")
+		require.NoError(t, err)
+		got := []file{}
+		for file := range files {
+			got = append(got, file)
+			switch file.path {
+			case "fileWithNoRefs":
+				assert.Equal(t, []string{"fileWithNoRefs"}, file.lines)
+			case "fileWithRefs":
+				assert.Equal(t, testFile.lines, file.lines)
+			case "ignoredFiles/included":
+				assert.Equal(t, []string{"IGNORED BUT INCLUDED"}, file.lines)
+			case "symlink":
+				assert.Fail(t, "Should not read symlink contents")
+			default:
+				assert.Fail(t, "Read unexpected file", file)
+			}
+		}
+		assert.Len(t, got, 3, "Expected 3 valid files to have been found")
+	})
 }

search/search_test.go

@@ -385,16 +385,16 @@ func Test_processFiles(t *testing.T) {
 }
 
 func Test_SearchForRefs(t *testing.T) {
-	os.Symlink("testdata/fileWithRefs", "testdata/symlink")
+	os.Symlink("testdata/exclude-github-files/fileWithRefs", "testdata/exclude-github-files/symlink")
 	want := []ld.ReferenceHunksRep{{Path: testFile.path}}
 	matcher := Matcher{
 		ctxLines: 0,
 	}
 	matcher.Elements = append(matcher.Elements,
 		NewElementMatcher("default", "", "", []string{testFlagKey, testFlagKey2}, nil),
 	)
-	t.Cleanup(func() { os.Remove("testdata/symlink") })
-	got, err := SearchForRefs("testdata", matcher)
+	t.Cleanup(func() { os.Remove("testdata/exclude-github-files/symlink") })
+	got, err := SearchForRefs("testdata/exclude-github-files", matcher)
 	require.NoError(t, err)
 	require.Len(t, got, 1)
 	require.Equal(t, want[0].Path, got[0].Path)

search/testdata/.ldignore

@@ -0,0 +1,5 @@
+someFlag
+anotherFlag
+someFlaganotherFlag
+some-flag
+another-flag