{"id":31667848,"url":"https://github.com/mskjel/cicode-vscode-extension","last_synced_at":"2026-03-16T21:05:58.335Z","repository":{"id":316622201,"uuid":"1063590621","full_name":"MSkjel/cicode-vscode-extension","owner":"MSkjel","description":"Syntax highlighting, navigation, autocomplete for Cicode","archived":false,"fork":false,"pushed_at":"2025-10-02T21:00:48.000Z","size":103,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-02T21:28:55.126Z","etag":null,"topics":["aveva","cicode","scada","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MSkjel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2025-09-24T20:57:09.000Z","updated_at":"2025-10-02T21:00:34.000Z","dependencies_parsed_at":"2025-09-25T18:13:32.432Z","dependency_job_id":"d5355558-40ed-4bd3-822d-4391cbb622e9","html_url":"https://github.com/MSkjel/cicode-vscode-extension","commit_stats":null,"previous_names":["mskjel/cicode-vscode-extension"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/MSkjel/cicode-vscode-extension","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MSkjel%2Fcicode-vscode-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MSkjel%2Fcicode-vscode-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MSkjel%2Fcicode-vscode-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MSkjel%2Fcicode-vscode-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MSkjel","download_url":"https://codeload.github.com/MSkjel/cicode-vscode-extension/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MSkjel%2Fcicode-vscode-extension/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278872155,"owners_count":26060525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"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":["aveva","cicode","scada","vscode-extension"],"created_at":"2025-10-08T00:48:24.922Z","updated_at":"2026-03-16T21:05:58.329Z","avatar_url":"https://github.com/MSkjel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cicode for VS Code\n\nA VS Code extension providing syntax highlighting, IntelliSense, and navigation for **Cicode**, the scripting language used in AVEVA Plant SCADA (Citect).\n\n\u003e **Disclaimer:** This project is not affiliated with or endorsed by AVEVA. It is a community-driven tool to improve the Cicode development experience in VS Code.\n\n## Features\n\n### Syntax Highlighting\n\nFull syntax highlighting for `.ci` files including:\n\n- Keywords, operators, and control flow\n- Function declarations and calls\n- Variables and type annotations\n- Strings with escape sequences\n- Comments (line `//`, `!`, `|` and block `/* */`)\n- Doc comments ([Doxygen](https://www.doxygen.nl/manual/xmlcmds.html) XML commands with `/** **/` and `///` style)\n- Format picture specifiers (`:###,##0.00`)\n\n### IntelliSense\n\n- **Autocompletion** for functions (built-in and user-defined)\n- **Signature help** with parameter documentation\n- **Hover information** showing function signatures and docs\n\n### Navigation\n\n- **Go to Definition** for functions and variables\n- **Find All References** across your workspace\n- **Rename Symbol** for variables and parameters\n- **Document Outline** showing functions in the current file\n- **Workspace Symbol Search** (`Ctrl+T`) to find any function\n\n### Diagnostics\n\n- Undefined function warnings\n- Argument count validation\n- Duplicate function detection\n- Unused variable warnings\n- Line length and indentation checks\n\n### Formatting\n\n- Basic code formatter with configurable options\n- Consistent indentation for control blocks\n\n### Built-in Functions\n\n- Automatically parses function documentation from your Plant SCADA installation\n- Falls back to packaged builtins if Plant SCADA is not installed\n- Hover over built-in functions to see docs with a link to open the full help page\n\n## Installation\n\n1. Install from the VS Code Marketplace, or\n2. Download the `.vsix` file and install via `Extensions: Install from VSIX...`\n\n## Configuration\n\n| Setting                                            | Default                                    | Description                                                                                                                                                             |\n|----------------------------------------------------|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `cicode.avevaPath`                                 | `C:/Program Files (x86)/AVEVA Plant SCADA` | Path to AVEVA Plant SCADA installation. The extension auto-finds help files.                                                                                            |\n| `cicode.codeLens.enable`                           | `true`                                     | Show CodeLens references above function definitions                                                                                                                     |\n| `cicode.diagnostics.enable`                        | `true`                                     | Enable diagnostics (undefined functions, duplicates)                                                                                                                    |\n| `cicode.diagnostics.ignoredFunctions`              | `[]`                                       | Regex patterns for function names to exclude from undefined and argument count checks                                                                                   |\n| `cicode.diagnostics.ignoredUndeclaredVariables`    | `[]`                                       | Regex patterns for variable names to exclude from the undeclared variable check                                                                                         |\n| `cicode.diagnostics.warnUndeclaredVariables`       | `false`                                     | Warn about variables that are used but never declared                                                                                                                   |\n| `cicode.format.enable`                             | `true`                                     | Enable the code formatter                                                                                                                                               |\n| `cicode.format.maxConsecutiveBlankLines`           | `1`                                        | Max blank lines to allow                                                                                                                                                |\n| `cicode.hover.showHelpLink`                        | `true`                                     | Show \"Open full help\" link in hovers                                                                                                                                    |\n| `cicode.indexing.excludePatterns`                  | `[]`                                       | Regular expressions matched against workspace-relative file paths to exclude from indexing                                                                              |\n| `cicode.lint.enable`                               | `true`                                     | Enable lint diagnostics                                                                                                                                                 |\n| `cicode.lint.maxLineLength`                        | `160`                                      | Warn when lines exceed this length (0 = disable)                                                                                                                        |\n| `cicode.lint.maxCallNestingDepth`                  | `5`                                        | Warn when function calls are nested deeper than this level (0 = disable)                                                                                                |\n| `cicode.lint.maxBlockNestingDepth`                 | `6`                                        | Warn when control flow blocks are nested deeper than this level (0 = disable)                                                                                           |\n| `cicode.lint.warnMixedIndent`                      | `true`                                     | Warn on mixed tabs/spaces                                                                                                                                               |\n| `cicode.lint.warnUnusedVariables`                  | `true`                                     | Warn about unused variables                                                                                                                                             |\n| `cicode.lint.warnMissingSemicolons`                | `true`                                     | Warn when declarations lack semicolons                                                                                                                                  |\n| `cicode.lint.warnKeywordCase`                      | `false`                                    | Suggest uppercase keywords                                                                                                                                              |\n| `cicode.lint.warnMagicNumbers`                     | `false`                                    | Warn about hardcoded numbers                                                                                                                                            |\n| `cicode.documentation.docskeleton.useBlockComment` | `Block comment`                            | Style of comments used for the doc comment skeleton, where comments can either be surrounded by `/** ... */` or each line begins with `///`                             |\n| `cicode.documentation.docskeleton.doxygenStyle`    | `XML Doxygen commands`                     | The style of Doxygen commands to be used by the doc comment skeleton, which can be either XML style commands, Javadoc commands (`@`), or regular Doxygen commands (`\\`) |\n\n## Commands\n\n| Command                             | Description                                              |\n| ----------------------------------- | -------------------------------------------------------- |\n| `Cicode: Rebuild Builtin Functions` | Re-parse built-in functions from help files              |\n| `Cicode: Reindex All Files`         | Rebuild the workspace index                              |\n| `Cicode: Open Help for Symbol`      | Open AVEVA help page for the symbol under cursor         |\n| `Cicode: Insert Doc Skeleton`       | Insert a doc comment template above the current function |\n\n## Keybindings\n\n| Key          | Command                                     |\n| ------------ | ------------------------------------------- |\n| `Ctrl+Alt+D` | Insert Doc Skeleton (when in a Cicode file) |\n\n## Doc Comments\n\nThe extension supports both [Doxygen XML](https://www.doxygen.nl/manual/xmlcmds.html), and [regular Doxygen commands](https://www.doxygen.nl/manual/commands.html) doc comments for documenting your functions:\n\n```cicode\n// Example of XML style doc comment\n/// \u003csummary\u003e\n/// Calculates the area of a rectangle.\n/// \u003c/summary\u003e\n/// \u003cparam name=\"width\"\u003eThe width of the rectangle.\u003c/param\u003e\n/// \u003cparam name=\"height\"\u003eThe height of the rectangle.\u003c/param\u003e\n/// \u003creturns\u003eThe calculated area.\u003c/returns\u003e\nFUNCTION CalculateArea(REAL width, REAL height)\n    RETURN width * height;\nEND\n```\n\n```cicode\n// Example of Javadoc style doc comment\n/**\n * @brief Calculates the area of a rectangle.\n * @param width The width of the rectangle.\n * @param height The height of the rectangle.\n * @returns The calculated area.\n */\nFUNCTION CalculateArea(REAL width, REAL height)\n    RETURN width * height;\nEND\n```\nUse `Ctrl+Alt+D` to automatically generate a doc skeleton for the function at your cursor.\n\nThe style of doc comment can be configured in the `cicode.documentation.docskeleton.useBlockComment` and `cicode.documentation.docskeleton.doxygenStyle` configuration options.\n## Debugger\n\nThe extension includes a debugger that lets you set breakpoints and inspect local variables in Cicode while a Plant SCADA runtime is running.\n\n### Requirements\n\n- AVEVA Plant SCADA must be running on the same machine\n- The Cicode runtime must be running\n\n### How to use\n\n1. Open the **Run and Debug** panel (`Ctrl+Shift+D`)\n2. Add a launch configuration of type **\"Cicode: Attach to SCADA Runtime\"** (VS Code will offer to add one automatically)\n3. Click **Start Debugging** (or press `F5`)\n4. Set breakpoints by clicking the gutter in any `.ci` file\n5. Trigger the Cicode function in the runtime. Execution will pause at your breakpoint\n6. Inspect local variables in the **Variables** panel\n7. Use **Continue** (`F5`), **Step Over** (`F10`), **Step Into** (`F11`), or **Step Out** (`Shift+F11`) to control execution\n\n### What it can do\n\n- Set and remove breakpoints\n- Conditional breakpoints with simple comparisons against local variables (e.g. `myVar == 5`, `myVar = \"SomeCoolString\"`)\n- Pause at breakpoints and inspect local variable values\n- Step over, into, and out of functions\n- Show the current stopped location in the editor\n\n### What it cannot do\n\n- **Evaluate arbitrary expressions** or watch expressions\n- **Modify variable values** at runtime\n- **Complex conditions** in breakpoints (only simple `==`, `!=`, `\u003c`, `\u003e` comparisons against local variables)\n- **Debug across multiple machines**\n- **Pause the runtime**\n\n\u003e **Note:** Removing a breakpoint while execution is paused will take effect when you next continue. The debugger reconnects in the background to clear the runtime breakpoint.\n\n## Requirements\n\n- VS Code 1.88.0 or higher\n- For built-in function docs: AVEVA Plant SCADA installation (optional, packaged fallback available)\n\n## Links\n\n- [GitHub Repository](https://github.com/MSkjel/cicode-vscode-extension)\n- [Report Issues](https://github.com/MSkjel/cicode-vscode-extension/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmskjel%2Fcicode-vscode-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmskjel%2Fcicode-vscode-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmskjel%2Fcicode-vscode-extension/lists"}