optics-framework-lsp 1.0.0__tar.gz

optics_framework_lsp-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

optics_framework_lsp-1.0.0/PKG-INFO

@@ -0,0 +1,347 @@
+Metadata-Version: 2.4
+Name: optics-framework-lsp
+Version: 1.0.0
+Summary: Language server and linter for optics-framework csv test suites
+Keywords: lsp,language-server,optics-framework,linter,test-automation,csv
+Author: Bishwa Bhusan Saha
+Author-email: Bishwa Bhusan Saha <77796630+kun-codes@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
+Requires-Dist: pygls>=2.1.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/mozarkai/optics-framework-lsp
+Project-URL: Repository, https://github.com/mozarkai/optics-framework-lsp
+Project-URL: Issues, https://github.com/mozarkai/optics-framework-lsp/issues
+Description-Content-Type: text/markdown
+
+<h1 align="center">optics-framework-lsp</h1>
+
+<p align="center">
+  A language server and linter for
+  <a href="https://mozarkai.github.io/optics-framework/">optics-framework</a> test suites.
+</p>
+
+<p align="center">
+  <a href="https://github.com/mozarkai/optics-framework-lsp/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="License"></a>
+  <img src="https://img.shields.io/badge/python-3.14%2B-blue" alt="Python 3.14+">
+</p>
+
+---
+
+An optics suite is CSV files referring to each other by name, and nothing checks that those
+names line up. This does, across the whole project, over LSP while you type or as one command.
+Its rules come from optics-framework's own readers, so it agrees with the runtime.
+
+## Install
+
+```sh
+uv tool install optics-framework-lsp
+```
+
+Or from a checkout, for development:
+
+```sh
+uv sync
+```
+
+---
+
+# The linter
+
+`optics-lsp lint` reports every problem in a suite in one shot. Point it at a project:
+
+```console
+$ optics-lsp lint ~/projects/my_project
+```
+
+Line numbers are 1-based, matching your editor's status bar. A whole project takes about
+60 ms including process start, because nothing on this path imports any LSP machinery.
+
+**The exit code is 0 whenever validation ran**, findings or not. Non-zero means the input could
+not be read at all. Which severities should block a pipeline is your policy, so read `status`
+if you want that decision made for you.
+
+<details>
+<summary><b>JSON, for another program</b></summary>
+
+Add `--json` for the machine-readable form. A caller holding uploaded files in memory, with
+nothing on disk, can pipe them in instead and skip the filesystem entirely:
+
+```console
+$ echo '{"files": [{"name": "modules.csv", "content": "module_name,module_step\nM,Sleep\n"}]}' \
+    | optics-lsp lint
+```
+
+Reading on stdin always answers JSON:
+
+```json
+{
+  "status": "FAIL",
+  "analyzed": { "modules.csv": "modules" },
+  "skipped": [],
+  "diagnostics": [
+    {
+      "uri": "modules.csv",
+      "severity": "error",
+      "code": "keyword-arity",
+      "message": "'Sleep' takes 1-1 params, got 0",
+      "row": 2,
+      "range": { "startLine": 1, "startColumn": 0, "endLine": 2, "endColumn": 0 },
+      "source": "optics"
+    }
+  ]
+}
+```
+
+`row` is 1-based for a person, `range` is 0-based for an editor. Diagnostics arrive sorted by
+file then row, so a caller need not re-sort.
+
+Shelling out from Node: pass the arguments as an array with the payload on stdin rather than
+interpolating either into a shell string, and raise `maxBuffer` past its 1 MB default. 
+
+</details>
+
+<details>
+<summary><b><code>analyzed</code> and <code>skipped</code>: which files were even looked at</b></summary>
+
+File kind comes from the header row, not the filename. `analyzed` says what each file became
+(`test_cases`, `modules`, `elements`, `error_definitions`); `skipped` lists the CSVs whose
+header matched none of those.
+
+optics ignores those files too, so a skipped file is usually a dataset and fine. But a
+`test_cases` file with a typo in its header lands there as well, and would otherwise be
+indistinguishable from a clean one.
+
+</details>
+
+## What it reports
+
+Two severities, and the line between them is one question: **does optics fail, or does it run
+and do something you probably didn't mean?**
+
+Errors are a name that resolves to nothing, or a call the keyword rejects:
+
+| code | meaning |
+| --- | --- |
+| `module-not-found` | a test step names a module no file defines |
+| `keyword-not-found` | a module step is neither a keyword nor another module |
+| `keyword-arity` | a keyword got too few or too many params |
+| `element-not-found` | a `${ref}` has no element and nothing binds it |
+
+Warnings mean it loads, but a row you wrote isn't doing what it looks like:
+
+| code | meaning |
+| --- | --- |
+| `duplicate-module`, `duplicate-test-case` | the later definition wins, wherever the files sit |
+| `duplicate-element` | a file repeats an entire element row |
+| `duplicate-error-code`, `duplicate-match-string` | error definitions merge across files, so these clash |
+| `error-definition-incomplete` | a row missing a column, so it never matches |
+| `csv-too-few-columns` | the reader skips the row |
+| `csv-too-many-columns` | the extra cells are dropped |
+| `csv-whitespace-line` | a row of nothing but separators |
+
+---
+
+# The language server
+
+Run with no arguments and it speaks LSP over stdio. Unknown flags are ignored rather than
+rejected, so a client that insists on passing `--stdio` needs no special handling.
+
+One workspace folder is one project. Cross-file rules mean a single edit can change
+diagnostics anywhere in the suite, so the whole folder is revalidated on every change, and the
+server asks the client to watch `**/*.csv` so a git checkout is picked up too. Open buffers
+override what is on disk. Dot folders are never descended into, because a project's `.venv` holds
+optics-framework's own sample CSVs and images, which would invent element and module names the
+project does not have.
+
+## Features
+
+<details open>
+<summary><b>Diagnostics</b></summary>
+
+Everything from the linter section above, live, across the whole project. Because resolution
+is a project-wide question, defining an element in one file clears the `element-not-found` in
+another without touching it.
+
+</details>
+
+<details>
+<summary><b>Completion</b></summary>
+
+Aware of which column you are in, because in a CSV the column *is* the context.
+
+| where the cursor is | what is offered |
+| --- | --- |
+| an empty file | the four header rows, since the header decides the file's kind |
+| `module_step` | every keyword **and** every module in the project, since a step can be either |
+| a param cell | what that particular keyword accepts at that position |
+| `test_step`, `module_name` | modules that already exist, since both columns continue a block |
+| `element_name` | names used somewhere but never defined |
+| any `element_id*` | template image filenames found anywhere in the project |
+| `test_case` | existing test cases, plus the lifecycle names (`Suite Setup`, …) not yet used |
+
+Param completion is specific rather than generic. `Read Data`'s second param offers the
+project's data files; `Invoke API`'s first offers `collection.api` identifiers parsed out of
+the project's YAML; `Run Loop` and `Execute Module` offer modules, written bare. Params with a
+documented set of values offer exactly those. `direction` gives `up`, `down`, `left`, `right`;
+`rule` gives `any`, `all`; `element_state` gives `visible`, `invisible`, `enabled`, `disabled`.
+`Condition` alternates condition and target, so it offers modules in the target slots and
+modules-or-variables in the others, with `!` inversion preserved.
+
+Accepting a param the header does not yet cover **widens the header in the same edit**, because
+`csv.DictReader` drops cells the header does not name and the param would otherwise silently
+vanish.
+
+</details>
+
+<details>
+<summary><b>Hover</b></summary>
+
+A keyword's real signature and the framework's own docstring, which is where the accepted
+values are actually written:
+
+```
+Press Element(element, repeat='1', offset_x='0', offset_y='0', index='0',
+              aoi_x='0', aoi_y='0', aoi_width='100', aoi_height='100', event_name=None)
+
+Press a specified element.
+
+:param element: The element to be pressed (text, xpath or image).
+:param repeat: Number of times to repeat the press.
+:param index: Index of the element if multiple matches are found.
+:param aoi_width: Width percentage of Area of Interest (0-100). Default: 100.
+```
+
+Defaults are rendered as `name='value'`, so what an omitted cell falls back to is visible
+without reading the source.
+
+</details>
+
+<details>
+<summary><b>Signature help</b></summary>
+
+The keyword's params with the column you are in marked active, retriggering on every comma,
+which is how you tell param 4 from param 5 in a row of commas.
+
+</details>
+
+<details>
+<summary><b>Goto definition</b></summary>
+
+From a step to the module it runs, or from a `${ref}` to the elements it reads. Every `${name}`
+in the cell is offered, not just one: a fallback element is several rows, and so is
+`${a} == ${b}`.
+
+Two details it gets right. A `module_step` naming something that is *also* a keyword resolves
+to the keyword, so a same-named module is not offered, mirroring what the runner does. And
+`Condition`'s `!Name` inversion is stripped the same way the runner strips it.
+
+</details>
+
+<details>
+<summary><b>Find references</b></summary>
+
+Every place a name is used across the project, optionally including where it is bound. Works
+on test cases, modules, elements and error codes, the things the project owns. A keyword
+belongs to the framework, and an image, data file or API identifier names something outside
+the CSVs, so neither comes back from here.
+
+</details>
+
+<details>
+<summary><b>Rename</b></summary>
+
+Renames across every file that writes the name, with prepare-rename so the client can reject
+an invalid position before you start typing. This is the feature that most needs to be
+project-wide: the runner keys everything by name, so a rename that misses one cell quietly
+changes what runs instead of failing loudly.
+
+</details>
+
+<details>
+<summary><b>Document symbols</b></summary>
+
+One file's outline: what it defines, and the rows making each one up:
+
+```
+Open App          [Function]  2 steps
+    Launch App    [Method]
+    Sleep         [Method]    2
+Login             [Function]  1 step
+    Press Element [Method]    ${btn}
+```
+
+</details>
+
+<details>
+<summary><b>Semantic tokens</b></summary>
+
+Highlighting a CSV grammar cannot express, because the meaning of a cell depends on the column
+above it and on the rest of the project:
+
+| token | what it marks |
+| --- | --- |
+| `keyword` | the header row, the names that decide what the file is |
+| `class` | a test case |
+| `function` | a module, wherever it is named |
+| `method` | a step that resolves to a framework keyword |
+| `variable` | `${name}`, and an `element_name` that defines one |
+| `string` | a locator, a data file, an API identifier |
+| `enumMember` | an error code, and a param with a documented set of values |
+| `operator` | the `!` that inverts a `Condition` |
+
+A framework keyword also carries the `defaultLibrary` modifier, so themes colour it apart from
+a module of the same shape, which they would otherwise draw identically.
+
+</details>
+
+---
+
+## The keyword catalog
+
+`src/optics_framework_lsp/keywords.py` is generated and holds **49 keywords from
+optics-framework 1.9.3**: each one's params, which are required, the defaults, and the
+framework's own docstring, which is where hover text and the param values come from.
+
+It is compiled in rather than read from your environment. Importing `optics_framework.api.*`
+pulls numpy, cv2, pandas and skimage through `common.optics_builder`, needing a 342 MB install
+and failing outright if any one of those is broken, leaving a project with no keyword
+diagnostics at all and no explanation why.
+
+To refresh it for a new optics release:
+
+```sh
+python scripts/update_catalog.py ~/src/optics-framework
+python scripts/update_catalog.py --check    # exits 1 if the committed table is stale
+```
+
+Signatures are read with `ast`, never imported, which is what lets the script run against a
+bare checkout or a `--no-deps` install and makes it usable for diffing two releases. It refuses
+to run if one of the four API classes gains a base class, since that would mean keywords it
+cannot see. A test runs `--check`, so a stale table fails the suite.
+
+## Development
+
+```sh
+uv run pytest tests/ -q
+```
+
+One test needs optics-framework itself and skips without it; point `OPTICS_PROBE_VENV` at a
+virtualenv that has it to run that one.
+
+The engine is deliberately protocol-free. `validate()` returns plain `Finding` objects and each
+transport converts at its own boundary: `server.py` to `lsprotocol` diagnostics, `lint.py` to
+JSON. `import lsprotocol.types` alone costs ~290 ms, which a long-lived server pays once and a
+per-call command would pay every time. `tests/test_lint.py` asserts the lint path imports
+neither pygls nor lsprotocol, so it stays that way.
+
+## License
+
+Apache 2.0.