feat: IntelliSense

* Syntax highlighting.
* Priority levels coloring.

add: README.md and CHANGELOG.md

Author: seishinsha

CHANGELOG.md

@@ -1,9 +1,13 @@
 # Change Log
 
-All notable changes to the extension extension will be documented in this file.
-
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
-
 ## [Unreleased]
-
-- Initial release
+- Syntax highlighting.
+- Rule validation.
+
+## [0.0.1] - Initial release
+### Added
+- Autocompletion for top-level elements.
+- Autocompletion for event access.
+- Syntax highlighting.
+- Priority levels coloring.
+- File icons.

README.md

@@ -1,44 +1,33 @@
-# README
+# Falco Rules for VS Code
 
-VS Code Extension to help wrtting, editing and testing Falco rule files. 
+A simple extension that assists in wrtting, editing and testing [Falco rule files](https://falco.org/docs/rules/).
 
-## Proposed Features
+Take a look at the [Changelog](CHANGELOG.md) to learn about new features.
 
-1. IntelliSense
-   - Autocompletion
-     - **jevt** Field Class: generic ways to access _json_ events
-     - **ka** Field Class: Access _K8s Audit Log_ Events
-   - Syntax highlighting
-2. File tidying up
-   - Append _new line character_ if the file doesn't end with one.
-3. Rule validation
-4. File icon [x]
+## Features
 
-## Implemented Features
+### IntelliSense
+Autocompletion for the following top-level code snippets:
+- **rule** Creates the scaffold for a new rule.
+- **list** Creates the scaffold for a new list.
+- **macro** Creates the scaffold for a new macro.
 
-1. File icon
+Autocompletion for the most usual access to events:
+- **jevt** Generic ways to access _json_ events.
+- **ka** Access _K8s Audit Log_ events.
 
-## Requirements
-
-None.
-
-## Extension Settings
-
-None as of yet.
+Syntax highlighting
 
-This will include any VS Code settings through the `contributes.configuration` extension point.
+Priority levels coloring
 
-For example:
+### File tidying up
+Appends _new line character_ if the rule file doesn't end with one (this is work in progress).
 
-This extension contributes the following settings:
+### Rule validation
+This is work in progress.
 
-* `myExtension.enable`: enable/disable this extension
-* `myExtension.thing`: set to `blah` to do something
-
-## Known Issues
+### File icon
+Helps identifying rule files.
 
+## Requirements
 None.
-
-## Release Notes
-
-No releases yet.

colorthemes/vs-dark-rule-theme.json

@@ -0,0 +1,76 @@
+{
+    "name": "vs-dark-rule-theme",
+    "type": "dark",
+    "colors": {
+        "editor.background": "#1B1B1B",
+        "editor.foreground": "#00BCD4",
+        "editor.lineHighlightBackground": "#2B2B2B"
+    },
+    "tokenColors": [
+        {
+            "name": "Italic",
+            "scope": [
+                "comment"
+            ],
+            "settings": {
+                "fontStyle": "italic"
+            }
+        },
+        {
+            "name": "Bold",
+            "scope": [
+                "rule.definition",
+                "rule.description",
+                "rule.condition",
+                "rule.output",
+                "rule.priority",
+                "rule.tags.tag",
+                "rule.source",
+                "rule.enabled",
+                "rule.append",
+                "list.definition",
+                "list.items.tag",
+                "macro.definition"
+            ],
+            "settings": {
+                "fontStyle": "bold",
+                "foreground": "#00BCD4"
+            }
+        },
+        {
+            "name": "Blue",
+            "scope": ["rule.jevt", "rule.K8s.event"],
+            "settings": {"foreground": "#00BCD4"}
+        },
+        {
+            "name": "Peach Puff",
+            "scope": ["rule.boolean"],
+            "settings": {"foreground": "#EBCFB2"}
+        },
+        {
+            "name": "Green Pantone",
+            "scope": ["rule.priority.level.info", "rule.priority.level.notice"],
+            "settings": {"foreground": "#4DAA57"}
+        },
+        {
+            "name": "Mango Tango",
+            "scope": ["rule.priority.level.warning", "rule.priority.level.error"],
+            "settings": {"foreground": "#F0803C"}
+        },
+        {
+            "name": "International Orange",
+            "scope": ["rule.priority.level.critical", "rule.priority.level.alert", "rule.priority.level.emergency"],
+            "settings": {"foreground": "#BA1200"}
+        },
+        {
+            "name": "Gray",
+            "scope": [
+                "rule.yaml",
+                "rule.priority.level.debug"
+            ],
+            "settings": {
+                "foreground": "#4b6869"
+            }
+        }
+    ]
+}

languages/rules-language.json

@@ -0,0 +1,25 @@
+{
+    "comments": {
+      "lineComment": "#"
+    },
+    "brackets": [["{", "}"], ["[", "]"], ["(", ")"]],
+    "autoClosingPairs": [
+      { "open": "{", "close": "}" },
+      { "open": "[", "close": "]" },
+      { "open": "(", "close": ")" },
+      { "open": "\"", "close": "\"", "notIn": ["string"] }
+    ],
+    "autoCloseBefore": ",=<> \n\t",
+    "surroundingPairs": [
+      ["{", "}"],
+      ["[", "]"],
+      ["(", ")"],
+      ["\"", "\""]
+    ],
+    "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)",
+    "indentationRules": {
+      "increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",
+      "decreaseIndentPattern": "^((?!.*?\\/\\*).*\\*/)?\\s*[\\}\\]].*$"
+    }
+  }
+  

package.json

@@ -14,7 +14,8 @@
 	},
 	"homepage": "https://github.com/sysdiglabs/vscode-falco#readme",
 	"categories": [
-		"Snippets"
+		"Snippets",
+		"Themes"
 	],
 	"icon": "fileicons/images/shovel.png",
 	"activationEvents": [
@@ -35,22 +36,36 @@
 				"path": "./fileicons/sysdig-icon-theme.json"
 			}
 		],
+		"languages": [
+			{
+				"id": "rules",
+				"extensions": [".yaml"],
+				"aliases": ["Rules", "yaml"],
+				"configuration": "./languages/rules-language.json"
+			}
+		],
 		"grammars": [
 			{
-				"injectTo": [
-					"source.yaml"
-				],
-				"scopeName": "todo-comment.injection",
+				"language": "rules",
+				"scopeName": "rule.yaml",
 				"path": "./syntaxes/rule.tmGrammar.json"
 			}
 		],
+		"themes": [
+			{
+				"id": "vs-dark-rule-theme",
+				"label": "rules-dark-theme",
+				"uiTheme": "vs-dark",
+				"path": "./colorthemes/vs-dark-rule-theme.json"
+			}
+		],
 		"snippets": [
 			{
-				"language": "yaml",
+				"language": "rules",
 				"path": "./snippets/top-level-snippets.json"
 			},
 			{
-				"language": "yaml",
+				"language": "rules",
 				"path": "./snippets/field-class-snippets.json"
 			}
 		]