devicetree-language-server 0.4.10 → 0.5.1

package/README.md

@@ -19,30 +19,31 @@ This extension needs a client that supports Configuration Capability. The format
 
 ```typescript
 interface Context {
-  ctxName?: string | number;
-  cwd?: string;
-  includePaths?: string[];
-  dtsFile: string;
-  overlays?: string[];
-  bindingType?: BindingType;
-  zephyrBindings?: string[];
-  deviceOrgTreeBindings?: string[];
-  deviceOrgBindingsMetaSchema?: string[];
-  lockRenameEdits?: string[];
+	ctxName?: string | number;
+	cwd?: string;
+	includePaths?: string[];
+	dtsFile: string;
+	overlays?: string[];
+	bindingType?: BindingType;
+	zephyrBindings?: string[];
+	deviceOrgTreeBindings?: string[];
+	deviceOrgBindingsMetaSchema?: string[];
+	lockRenameEdits?: string[];
+	compileCommands?: string;
 }
 
 interface Settings {
-  cwd?: string;
-  defaultBindingType?: BindingType;
-  defaultZephyrBindings?: string[];
-  defaultDeviceOrgTreeBindings?: string[];
-  defaultDeviceOrgBindingsMetaSchema?: string[];
-  defaultIncludePaths?: string[];
-  contexts?: Context[];
-  preferredContext?: string | number;
-  defaultLockRenameEdits?: string[];
-  autoChangeContext?: boolean;
-  allowAdhocContexts?: boolean;
+	cwd?: string;
+	defaultBindingType?: BindingType;
+	defaultZephyrBindings?: string[];
+	defaultDeviceOrgTreeBindings?: string[];
+	defaultDeviceOrgBindingsMetaSchema?: string[];
+	defaultIncludePaths?: string[];
+	contexts?: Context[];
+	preferredContext?: string | number;
+	defaultLockRenameEdits?: string[];
+	autoChangeContext?: boolean;
+	allowAdhocContexts?: boolean;
 }
 ```
 
@@ -78,18 +79,18 @@ EOF
 
 ```json
 {
-  "devicetree": {
-    "cwd": "/Users/user/Workspace/linux/",
-    "defaultIncludePaths": ["include"],
-    "defaultBindingType": "DevicetreeOrg",
-    "defaultDeviceOrgBindingsMetaSchema": [
-      "/Users/user/Workspace/linuxBindings/dt-schema/dtschema/meta-schemas" // https://github.com/devicetree-org/dt-schema/tree/main/dtschema/meta-schemas
-    ],
-    "defaultDeviceOrgTreeBindings": [
-      "/Users/user/Workspace/linuxBindings/dt-schema/dtschema/schemas", // https://github.com/devicetree-org/dt-schema/tree/main/dtschema/schemas
-      "/Users/user/Workspace/linux/Documentation/devicetree/bindings" // https://github.com/torvalds/linux/tree/master/Documentation/devicetree/bindings
-    ]
-  }
+	"devicetree": {
+		"cwd": "/Users/user/Workspace/linux/",
+		"defaultIncludePaths": ["include"],
+		"defaultBindingType": "DevicetreeOrg",
+		"defaultDeviceOrgBindingsMetaSchema": [
+			"/Users/user/Workspace/linuxBindings/dt-schema/dtschema/meta-schemas" // https://github.com/devicetree-org/dt-schema/tree/main/dtschema/meta-schemas
+		],
+		"defaultDeviceOrgTreeBindings": [
+			"/Users/user/Workspace/linuxBindings/dt-schema/dtschema/schemas", // https://github.com/devicetree-org/dt-schema/tree/main/dtschema/schemas
+			"/Users/user/Workspace/linux/Documentation/devicetree/bindings" // https://github.com/torvalds/linux/tree/master/Documentation/devicetree/bindings
+		]
+	}
 }
 ```
 
@@ -122,10 +123,10 @@ Every element in the document will have document symbols to help navigate the do
 #### Types
 
 - Supports standard types as defined in chapter 2 of Devicetree Specification Release v0.4
-  - Reports property type mismatch errors
-  - Reports prop-encoded-values errors when these need to follow some pattern e.g interrupts
-  - Compares the node address and ensures that it matches the reg property, and that the reg values use the appropriate number of values as defined by other properties
-  - And more... (See Chapter 2 of Devicetree Specification Release v0.4 https://devicetree.org)
+    - Reports property type mismatch errors
+    - Reports prop-encoded-values errors when these need to follow some pattern e.g interrupts
+    - Compares the node address and ensures that it matches the reg property, and that the reg values use the appropriate number of values as defined by other properties
+    - And more... (See Chapter 2 of Devicetree Specification Release v0.4 https://devicetree.org)
 
 ### Document Formatting
 
@@ -144,19 +145,19 @@ Completions are context aware of the document state on the line the action is re
 - Node path completion
 - Label reference completion in property assign values
 - Delete Node:
-  - Suggests appropriate type e.g. by reference or node name
-  - Does not suggest keyword if no delete is possible
+    - Suggests appropriate type e.g. by reference or node name
+    - Does not suggest keyword if no delete is possible
 - Delete Property:
-  - Suggests property names available in that context
-  - Does not suggest keyword if no delete is possible
+    - Suggests property names available in that context
+    - Does not suggest keyword if no delete is possible
 - Default values for standard types (e.g state)
 
 ### Code Actions
 
 - Adds missing syntax e.g. ';', '<', '>', ',' etc...
 - Removes syntactically incorrect spaces:
-  - Between node name, '@' and address
-  - In node path reference
+    - Between node name, '@' and address
+    - In node path reference
 - Removes ';' when used without any statement
 - Suggests solutions for incomplete /delete-node/ keywords
 - Suggests solutions for incomplete /delete-property/ keywords
@@ -204,7 +205,7 @@ Given that in some cases the files included in a devicetree might come from an S
 ### Road Map
 
 - Formatting
-  - Clean up trailing white spaces
+    - Clean up trailing white spaces
 - Implement syntax for Ternary operator
 - Implement "Device Node Requirements" (chapter 3 - Devicetree Specification Release v0.4)
 - Write more unit tests