{"id":49359705,"url":"https://github.com/opm/opm-flow-editor-support","last_synced_at":"2026-04-27T16:00:27.959Z","repository":{"id":353938344,"uuid":"1219893839","full_name":"OPM/opm-flow-editor-support","owner":"OPM","description":"Text editor support for reservoir simulation keywords","archived":false,"fork":false,"pushed_at":"2026-04-26T09:48:38.000Z","size":114,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-26T11:24:21.247Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OPM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-24T10:26:06.000Z","updated_at":"2026-04-26T09:48:43.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/OPM/opm-flow-editor-support","commit_stats":null,"previous_names":["opm/opm-flow-editor-support"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/OPM/opm-flow-editor-support","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPM%2Fopm-flow-editor-support","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPM%2Fopm-flow-editor-support/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPM%2Fopm-flow-editor-support/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPM%2Fopm-flow-editor-support/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OPM","download_url":"https://codeload.github.com/OPM/opm-flow-editor-support/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OPM%2Fopm-flow-editor-support/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32343571,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-27T16:00:19.291Z","updated_at":"2026-04-27T16:00:27.945Z","avatar_url":"https://github.com/OPM.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# opm-flow-editor-support\n\nVS Code extension providing editor support for OPM Flow simulation deck files,\nbacked by the full [OPM Flow reference manual](https://github.com/OPM/opm-reference-manual).\n\n## Install\n\n### From the VS Code Marketplace\n\n1. Open the **Extensions** view (`Ctrl+Shift+X` / `Cmd+Shift+X`).\n2. Search for **OPM Flow** and click **Install**.\n\nOr from the command palette: `ext install magne-sjaastad.opm-flow-editor-support`.\n\nMarketplace listing: \u003chttps://marketplace.visualstudio.com/items?itemName=magne-sjaastad.opm-flow-editor-support\u003e\n\n### From a GitHub Release\n\n1. **Download the `.vsix` file** from the [Releases page](https://github.com/OPM/opm-flow-editor-support/releases/latest).\n   Look for a file named `opm-flow-editor-support-\u003cversion\u003e.vsix` under the release assets.\n\n2. **Open VS Code.**\n\n3. **Open the Extensions view** — press `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (macOS),\n   or click the Extensions icon in the Activity Bar on the left.\n\n4. **Open the extension menu** — click the `⋯` (three-dot) button at the top-right corner\n   of the Extensions panel.\n\n5. **Choose \"Install from VSIX…\"** from the dropdown.\n\n6. **Browse to the downloaded `.vsix` file** and click **Install**.\n\n7. VS Code will install the extension and prompt you to reload the window.\n   Click **Reload Window** (or press `Ctrl+Shift+P` → `Reload Window`).\n\n8. **Verify**: Open any `.data` or `.sch` file. Keywords should be highlighted, and\n   hovering over a keyword should show its documentation tooltip.\n\n\u003e **Note 1:** If you previously installed the extension, VS Code may ask whether to replace\n\u003e the existing version. Confirm to upgrade.\n\n\u003e **Note 2:** If another extension is registered for the same simulator deck file types, it\n\u003e may take precedence over this one — for example the E100/E300 extension listed\n\u003e under [References](#references). Disable or uninstall the conflicting extension\n\u003e if you want the features in the OPM Flow plugin to apply to `.data`/`.DATA`/`.inc`/`.INC` files.\n\n\n## Features\n\n- **Syntax highlighting** for section headers, keywords, comments, record\n  terminators, numbers, repeat markers, and template variables.\n- **Keyword autocompletion** for OPM Flow keywords (including OPM-specific\n  extensions like `PYACTION`), with every valid section and a one-line\n  summary shown inline.\n- **Value autocompletion** inside records: when the parameter at the\n  current column has known string options (e.g. `OPEN`/`SHUT`/`AUTO`\n  for `COMPDAT` STATUS), the suggestion list shows them.\n- **Hover tooltips** showing all valid sections for the keyword, a summary,\n  parameter table (with parameter type and dimension where known), and\n  example. Hovering over a value in a data record shows the matching\n  parameter column. For multi-record keywords (`WELSEGS`, `VFPPROD`,\n  `COMPSEGS`, `ACTIONX`, `TUNING`, …) the hover resolves the parameter\n  against the record the cursor is in.\n- **Diagnostics** — squiggles flag unrecognised keywords, keywords placed in\n  the wrong section (e.g. `WELSPECS` outside `SCHEDULE`), records with too\n  many values (per-record arity for multi-record keywords; the message\n  names which record overflowed), missing per-record `/` terminators,\n  and missing closing `/` on record-list and cell-property-array blocks.\n- **Docs sidebar panel** that follows the cursor — full documentation for the\n  keyword under the cursor, with the active parameter row highlighted.\n  Multi-record keywords are rendered as one parameter table per record\n  with a heading per record.\n- **Collapsible sections and keywords** — fold section blocks (from one\n  section keyword to the next) or individual keywords in the gutter.\n- **Align Record Columns** — tidy up record blocks so every column lines up;\n  handles comment lines inside the group and aligns to heading comments above\n  the group.\n- **Add Column Headers** — insert a `--` heading comment with parameter names\n  from the reference manual and align the record group to those positions\n  (idempotent). For multi-record keywords the names come from the record\n  the group belongs to (e.g. `ISEG1`, `ISEG2`, … for a `WELSEGS` segment row).\n- **INCLUDE file navigation** — `Ctrl+click` a quoted path on an `INCLUDE`\n  statement to open the referenced file.\n- **Generate Keyword Reference** — opens a Markdown document listing all\n  keywords grouped by section, useful for uploading as AI-chat context.\n\n## References\n\n- [equinor/vscode-lang-e100e300](https://github.com/equinor/vscode-lang-e100e300) — VS Code language extension for Eclipse E100/E300 decks\n\n## Development\n\nSee [DEVELOPMENT.md](DEVELOPMENT.md) for repo layout, clone/build instructions,\nhow to regenerate the keyword index, and the release process.\n\n## License\n\n[GPL-3.0-only](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopm%2Fopm-flow-editor-support","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopm%2Fopm-flow-editor-support","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopm%2Fopm-flow-editor-support/lists"}