Clean up readme

Author: zph

Diff for: .gitignore

@@ -1 +1 @@
-./bin/polylint
+/bin/polylint

Diff for: Makefile

@@ -19,3 +19,6 @@ test:
 
 test-watch:
 	watchexec -e go,yml,yaml -- go test -v .
+
+benchmark:
+	hyperfine --ignore-failure -- "./bin/polylint --config examples/simple.yaml run ~/src/runbook"

Diff for: README.md

@@ -2,99 +2,27 @@
 
 # Features
 
-- [ ] Standard linters built using golang functions
-  - [ ] contains
-  - [ ] regexp match
-- [ ] Ignore mechanisms
-  - [x] Ignore full file
-    - [x] polylint disable-for-file=$RULE_ID
-  - [x] Ignore next line
-    - [x] polylint disable-next-line=$RULE_ID
-    - [x] polylint disable=$RULE_ID
-  - [ ] Ignore from lint runner via cli for file-level ignores
-- [ ] Types of rules
-  - [x] line
-  - [ ] file content
-  - [ ] file path
-- [ ] Builtin linters configured for use in config file
-- [ ] Plugin linters configured for use in config file
-  - [ ] otto / goja / v8go
-  - [ ] supports line / file / path types
-- [ ] Use cobra for CLI
-- [ ] Replace argv[0] option to accept:
-  - a directory
-  - many files passed as argv
-  - a testing config file used as virtual filesystem
-- [ ] Ensure that we confirm uniqueness of rule ids at the  beginning of run during a pre-flight check
-- [ ] Build in a way to source rules from remote locations, via path + sha?
-  - [ ] ie re-usable plugin infrastructure
-  - make it an includes that is cached and pulled at runtime w/ SHAs
-- [ ] Rename rules to... rules or validations?
-- [ ] Add validation that the version of config file is supported
+- Simple and fast golang based builtin linting functions
+- Extensible embedded javascript based linters
+- Linting configurations can be `included` and referenced from external file or via http(s)
+- Each rule contains a severity, path match, path exclusions
 
 # Configuration
 
 ## Configuration Language
 
-```yaml
----
-version: 1.0
-rules:
-- id: no-print
-  description: "Don't use print()"
-  recommendation: "Use logging instead."
-  severity: low
-  link: https://docs.openstack.org/bandit/latest/plugins/b302_no_print.html
-  include_paths: '\.py$'
-  exclude_paths: null
-  fn:
-    type: builtin
-    scope: line
-    name: contains
-    args: ['print(']
-- id: no-print-js
-  description: "Don't use print()"
-  recommendation: "Use logging instead."
-  severity: low
-  link: https://docs.openstack.org/bandit/latest/plugins/b302_no_print.html
-  include_paths: '\.py$'
-  exclude_paths: null
-  fn:
-    type: js
-    scope: line
-    name: printRule
-    body: |
-      function printRule(path, idx, line) {
-        return line.contains('print')
-      }
-- id: no-print-js-file-level
-  description: "Don't use print()"
-  recommendation: "Use logging instead."
-  severity: low
-  link: https://docs.openstack.org/bandit/latest/plugins/b302_no_print.html
-  include_paths: '\.py$'
-  exclude_paths: null
-  fn:
-    type: js
-    scope: file
-    name: printRule
-    body: |
-      function printRule(path, idx, file) {
-        return file.contains('print')
-      }
-```
-
+See [config](examples/simple.yaml)
 
 # Benchmarks
 
-## 2024-04-08
+## 2024-04-11
 
 Using test repo https://github.com/zph/runbook
 commit f290434f61a2d2b975cdcdcad060c4e01d2cdfc3 (HEAD -> main, tag: 0.3.0, origin/main, origin/HEAD)
 
 ```
-❯ hyperfine -- "./bin/polylint ~/src/runbook"
-Benchmark 1: ./bin/polylint ~/src/runbook
-  Time (mean ± σ):     281.4 ms ±   1.3 ms    [User: 155.5 ms, System: 133.5 ms]
-  Range (min … max):   279.1 ms … 282.7 ms    10 runs
+❯ hyperfine --ignore-failure -- "./bin/polylint --config examples/simple.yaml run ~/src/runbook"
+Benchmark 1: ./bin/polylint --config examples/simple.yaml run ~/src/runbook
+  Time (mean ± σ):     379.2 ms ±   3.7 ms    [User: 251.0 ms, System: 142.4 ms]
+  Range (min … max):   374.4 ms … 384.6 ms    10 runs
 ```

Diff for: TODO.md

@@ -0,0 +1,40 @@
+# TODO
+
+- [x] Standard linters built using golang functions
+  - [x] contains
+  - [x] regexp match
+- [x] Ignore mechanisms
+  - [x] Ignore full file
+    - [x] polylint disable-for-file=$RULE_ID
+  - [x] Ignore next line
+    - [x] polylint disable-next-line=$RULE_ID
+    - [x] polylint disable=$RULE_ID
+  - [x] Ignore for path match
+    - [x] polylint disable-for-path=$RULE_ID,$RULE_ID2
+- [x] Types of rules
+  - [x] line
+  - [x] file content
+  - [x] file path
+- [ ] Builtin linters configured for use in config file
+- [x] Plugin linters configured for use in config file
+  - [x] otto / goja / v8go
+  - [x] supports line / file / path types
+- [x] Use cobra for CLI
+- [x] Build in a way to source rules from remote locations, via path + sha?
+  - [x] ie re-usable plugin infrastructure
+  - [x] support include statements
+  - [x] support SHA hash requirement for includes
+  - [ ] support caching
+- [x] Rename rules to... rules or validations?
+- [x] Add validation that the version of config file is supported
+- [ ] Ensure that we confirm uniqueness of rule ids at the  beginning of run during a pre-flight check
+- [x] Replace argv[0] option to accept:
+  - a directory
+  - many files passed as argv
+  - [deferred]a testing config file used as virtual filesystem
+- [ ] Set the severity threshold for what constitutes a non-zero exit code
+- [ ] Add pluggable output reporters
+  - [ ] Textual / table based reporter
+  - [ ] Colored output
+  - [ ] JSON reporter
+- [ ] Configurable logging (log levels for debugging and k/v log values)

Diff for: cmd/run.go

@@ -27,66 +27,70 @@ to quickly create a Cobra application.`,
 	Run:  RunCmd,
 }
 
-func Run(cmd *cobra.Command, args []string) (int, error) {
+func Run(cmd *cobra.Command, args []string) (int, []error) {
 	var exitCode int
 	exitCode = 0
-	if len(args) == 1 {
-		// We're treating this as a root folder
-	} else {
-		// Treat this as individual files
-	}
-	root := args[0]
-	configRaw, err := os.ReadFile(cfgFile)
-	if err != nil {
-		panic(err)
-	}
-	cfg, err := pl.LoadConfigFile(string(configRaw))
-
-	if err != nil {
-		fmt.Printf("error loading config: %v\n", err)
-		return exitCode, err
-	}
-
-	err = filepath.Walk(root, func(path string, info fs.FileInfo, err error) error {
+	var errs []error
+	for _, root := range args {
+		configRaw, err := os.ReadFile(cfgFile)
 		if err != nil {
-			fmt.Printf("error accessing path %q: %v\n", path, err)
-			return err
+			panic(err)
 		}
+		cfg, err := pl.LoadConfigFile(string(configRaw))
 
-		// Check if the file has the extension
-		if !info.IsDir() {
-			content, err := os.ReadFile(path)
+		if err != nil {
+			fmt.Printf("error loading config: %v\n", err)
+			return exitCode, []error{err}
+		}
 
+		err = filepath.Walk(root, func(path string, info fs.FileInfo, err error) error {
 			if err != nil {
-				fmt.Printf("error reading file %q: %v\n", path, err)
+				fmt.Printf("error accessing path %q: %v\n", path, err)
 				return err
 			}
 
-			result, err2 := pl.ProcessFile(string(content), path, cfg)
-			if err2 != nil {
-				return fmt.Errorf("error processing file %q: %v", path, err2)
-			}
+			// Check if the file has the extension
+			if !info.IsDir() {
+				content, err := os.ReadFile(path)
 
-			if len(result.Findings) > 0 {
-				fmt.Printf("\n%s: violations count %d\n", result.Path, len(result.Findings))
-				for idx, finding := range result.Findings {
-					// TODO: figure out why the rule embedded is wrong
-					fmt.Printf("%d: %s:%d %s %s\n", idx+1, result.Path, finding.LineNo, finding.RuleId, finding.Rule.Description)
+				if err != nil {
+					fmt.Printf("error reading file %q: %v\n", path, err)
+					return err
+				}
+
+				result, err2 := pl.ProcessFile(string(content), path, cfg)
+				if err2 != nil {
+					return fmt.Errorf("error processing file %q: %v", path, err2)
 				}
-				exitCode = 1
-			}
-		}
 
-		return nil
-	})
+				if len(result.Findings) > 0 {
+					fmt.Printf("\n%s: violations count %d\n", result.Path, len(result.Findings))
+					for idx, finding := range result.Findings {
+						// TODO: figure out why the rule embedded is wrong
+						fmt.Printf("%d: %s:%d %s %s\n", idx+1, result.Path, finding.LineNo, finding.RuleId, finding.Rule.Description)
+					}
+					exitCode = 1
+				}
+			}
 
-	return exitCode, err
+			return nil
+		})
+		errs = append(errs, err)
+	}
+	nonNilErrors := make([]error, 0)
+	for _, e := range errs {
+		if e != nil {
+			nonNilErrors = append(nonNilErrors, e)
+		}
+	}
+	return exitCode, nonNilErrors
 }
 
 func RunCmd(cmd *cobra.Command, args []string) {
-	exitCode, err := Run(cmd, args)
-	if err != nil {
-		panic(err)
+	exitCode, errs := Run(cmd, args)
+	if len(errs) > 0 {
+		fmt.Printf("Errors: %+v", errs)
+		panic(errs)
 	}
 	os.Exit(exitCode)
 }