https://github.com/trinitronx/vscode-acpeye
Fork of williamwu-hj.AcpiHelper VSCode extension with fixes & custom config file support.
https://github.com/trinitronx/vscode-acpeye
Last synced: 8 months ago
JSON representation
Fork of williamwu-hj.AcpiHelper VSCode extension with fixes & custom config file support.
- Host: GitHub
- URL: https://github.com/trinitronx/vscode-acpeye
- Owner: trinitronx
- Created: 2025-06-01T18:44:18.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-08T18:32:25.000Z (11 months ago)
- Last Synced: 2025-09-18T14:52:48.506Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 16 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
This extension is used to provide description to ACPI predefine names (methods and PNPID). Mouse hover will triger the hints.
This is based on ACPI Spec version 6.4, https://uefi.org/specs/ACPI/6.4/, and the language definiation is based on CPP.
## Configuration Properties
The extension can be configured through VS Code settings:
| Property | Type | Default | Description | Notes |
|--------------------------------|-----------|---------|-------------|-------|
| `acpihelper.configPath` | `string` | `""` | Path to a custom JSON configuration file containing additional ACPI keywords and descriptions. If empty, only the built-in ACPI specification keywords will be used. | Format of the file is a JSON list of Object Literals, each having "`KeyWord`" and "`Desc`" keys and values. |
| `acpihelper.includeUserConfig` | `boolean` | `false` | When enabled, the extension will load keywords and descriptions from the custom configuration file specified in `configPath`. When disabled, only the built-in ACPI specification keywords will be shown. | The default is to use the example `AcpiCfg.json` config included with this extension. Set `includeUserConfig` to `true` (checked) and set `configPath` to an empty string `""` (no text) to disable the default config and only use the standard ACPI specification keywords. |
### Configuration File Format
The custom configuration file should be a JSON array of Object Literals, where each object has the following structure:
```json
[
{
"KeyWord": "YOUR_KEYWORD",
"Desc": "Description of the keyword"
},
{
"KeyWord": "ANOTHER_KEYWORD",
"Desc": "Another description"
}
]
```
### Example Configuration
```json
{
"acpihelper.configPath": "/path/to/your/acpi-config.json",
"acpihelper.includeUserConfig": true
}
```
currently, the auto-complete is not implemented yet.
William Wu