feat: add skip files to linter (#236)

Author: zoolsher

cmd/rslint/api.go

@@ -134,10 +134,11 @@ func (h *IPCHandler) HandleLint(req api.LintRequest) (*api.LintResponse, error)
 	}
 
 	// Run linter
-	lintedFilesCount, err := linter.RunLinter(
+	lintedFilesCount, err := 		linter.RunLinter(
 		programs,
 		false, // Don't use single-threaded mode for IPC
 		allowedFiles,
+		utils.ExcludePaths,
 		func(sourceFile *ast.SourceFile) []linter.ConfiguredRule {
 			return utils.Map(rulesWithOptions, func(r RuleWithOption) linter.ConfiguredRule {
 

cmd/rslint/cmd.go

@@ -481,6 +481,7 @@ func runCMD() int {
 		programs,
 		singleThreaded,
 		nil,
+		utils.ExcludePaths,
 		func(sourceFile *ast.SourceFile) []linter.ConfiguredRule {
 			activeRules := rslintconfig.GlobalRuleRegistry.GetEnabledRules(rslintConfig, sourceFile.FileName())
 			return activeRules

cmd/rslint/lsp.go

@@ -505,6 +505,7 @@ func runLintWithPrograms(uri lsproto.DocumentUri, programs []*compiler.Program,
 		programs,
 		false, // Don't use single-threaded mode for LSP
 		[]string{filename},
+		utils.ExcludePaths,
 		func(sourceFile *ast.SourceFile) []linter.ConfiguredRule {
 			activeRules := config.GlobalRuleRegistry.GetEnabledRules(rslintConfig, sourceFile.FileName())
 			return activeRules

internal/linter/linter.go

@@ -21,7 +21,7 @@ type ConfiguredRule struct {
 
 // when allowedFiles is passed as nil which means all files are allowed
 // when allowedFiles is passed as slice, only files in the slice are allowed
-func RunLinter(programs []*compiler.Program, singleThreaded bool, allowFiles []string, getRulesForFile func(sourceFile *ast.SourceFile) []ConfiguredRule, onDiagnostic func(diagnostic rule.RuleDiagnostic)) (int32, error) {
+func RunLinter(programs []*compiler.Program, singleThreaded bool, allowFiles []string, skipFiles []string, getRulesForFile func(sourceFile *ast.SourceFile) []ConfiguredRule, onDiagnostic func(diagnostic rule.RuleDiagnostic)) (int32, error) {
 
 	wg := core.NewWorkGroup(singleThreaded)
 
@@ -34,9 +34,15 @@ func RunLinter(programs []*compiler.Program, singleThreaded bool, allowFiles []s
 			wg.Queue(func() {
 				for _, file := range program.GetSourceFiles() {
 					p := string(file.Path())
-					// skip lint node_modules and bundled files
-					// FIXME: we may have better api to tell whether a file is a bundled file or not
-					if strings.Contains(p, "/node_modules/") || strings.Contains(p, "bundled:") {
+					// skip files based on skipFiles parameter
+					skipFile := false
+					for _, skipPattern := range skipFiles {
+						if strings.Contains(p, skipPattern) {
+							skipFile = true
+							break
+						}
+					}
+					if skipFile {
 						continue
 					}
 					// only lint allowedFiles if allowedFiles is not empty

internal/rule_tester/rule_tester.go

@@ -80,6 +80,7 @@ func RunRuleTester(rootDir string, tsconfigPath string, t *testing.T, r *rule.Ru
 			[]*compiler.Program{program},
 			true,
 			allowedFiles,
+			[]string{}, // No files to skip in test environment
 			func(sourceFile *ast.SourceFile) []linter.ConfiguredRule {
 				return []linter.ConfiguredRule{
 					{

internal/utils/utils.go

@@ -183,3 +183,6 @@ func IsStrWhiteSpace(r rune) bool {
 	// WhiteSpace
 	return unicode.Is(unicode.Zs, r)
 }
+
+// ExcludePaths contains paths that should be excluded from linting
+var ExcludePaths = []string{"/node_modules/", "bundled:"}