tuned example plugins

Author: daveshanley

cmd/lint.go

@@ -203,7 +203,7 @@ func GetLintCommand() *cobra.Command {
 					}
 					rules = append(rules, pterm.BulletListItem{
 						Level:       0,
-						Text:        fmt.Sprintf("%s: (%s)", rule.Id, rule.Name),
+						Text:        fmt.Sprintf("%s: (%s)", rule.Id, rule.Description),
 						TextStyle:   pterm.NewStyle(pterm.FgLightMagenta),
 						BulletStyle: pterm.NewStyle(pterm.FgLightCyan),
 						Bullet:      fmt.Sprintf("► %s[%d]", sp, x),

plugin/plugin_loader.go

@@ -84,11 +84,12 @@ func LoadFunctions(path string, silence bool) (*Manager, error) {
 			// register core functions with this custom function.
 			RegisterCoreFunctions(function)
 
-			// register this function with the plugin manager
-			pm.RegisterFunction(fName, function)
+			// register this function with the plugin manager using the schema name
+			schemaName := function.GetSchema().Name
+			pm.RegisterFunction(schemaName, function)
 
 			if !silence {
-				pterm.Info.Printf("Registered custom function: '%s' -> available for use in rulesets\n", fName)
+				pterm.Info.Printf("Registered custom function: '%s' -> available for use in rulesets\n", schemaName)
 			}
 		}
 	}

plugin/sample/js/check_for_name_and_id.js

@@ -1,6 +1,13 @@
 // Copyright 2023 Princess Beef Heavy Industries / Dave Shanley.
 // SPDX-License-Identifier: MIT
 
+function getSchema() {
+    return {
+        "name": "checkForNameAndId",
+        "description": "Checks that input has the correct name and id values"
+    };
+}
+
 function runRule(input) {
 
     // create an array to hold the results

plugin/sample/js/use_core_function.js

@@ -1,6 +1,13 @@
 // Copyright 2023 Princess Beef Heavy Industries / Dave Shanley.
 // SPDX-License-Identifier: MIT
 
+function getSchema() {
+    return {
+        "name": "useCoreFunction",
+        "description": "Demonstrates using a vacuum core function within a custom JavaScript function"
+    };
+}
+
 function runRule(input) {
 
     // create an array to hold the results

plugin/sample/js/use_function_options.js

@@ -1,6 +1,13 @@
 // Copyright 2023 Princess Beef Heavy Industries / Dave Shanley.
 // SPDX-License-Identifier: MIT
 
+function getSchema() {
+    return {
+        "name": "useFunctionOptions",
+        "description": "Demonstrates how to use function options passed from rulesets"
+    };
+}
+
 function runRule(input) {
     // extract function options from context
     const functionOptions = context.ruleAction.functionOptions

plugin/sample/js/useless_func.js

@@ -3,7 +3,8 @@
 
 function getSchema() {
     return {
-        "name": "useless_func_modified_name",
+        "name": "uselessFunc",
+        "description": "A demo function that always returns multiple messages regardless of input",
         "properties": [
             {
                 "name": "mickey",

rulesets/examples/sample-plugin-ruleset.yaml

@@ -8,7 +8,7 @@ rules:
     formats: [oas2, oas3]
     given: $
     then:
-      function: useless_func
+      function: uselessFunc
     howToFix: You can't, it's just an example.
   sample-paths-rule:
     description: Load a custom function that checks for a single path
@@ -17,5 +17,5 @@ rules:
     formats: [ oas2, oas3 ]
     given: $.paths
     then:
-      function: check_single_path
+      function: checkSinglePath
     howToFix: use a spec with only a single path defined.