linti 0.4.2__tar.gz

linti-0.4.2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

linti-0.4.2/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.4
+Name: linti
+Version: 0.4.2
+Summary: A linter for TM1 TI scripts
+Author-email: Florian Scherzberg <florian.scherzberg@deutschebahn.com>
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]>=0.9.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# Linti
+
+## Description
+
+A linter for TM1 TurboIntegrator (TI) code that enforces consistent formatting and best practices. Originally started as an internal project at Deutsche Bahn AG, it is now opened to the community. Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Name Origin
+
+The name "Linti" is a wordplay on "lint" and "TI" (TurboIntegrator). The "-i" ending is commonly used in German nicknames and was chosen intentionally as a small tribute to the project's German roots.
+
+## Motivation
+
+TurboIntegrator processes are the backbone of any TM1 application, yet there has never been a dedicated linter for TI code. Teams rely on manual code reviews and informal conventions that inevitably drift 
+over time. We built Linti to close that gap — giving TM1 developers the same kind of automated quality checks that are standard in every other programming ecosystem.
+
+We decided to open-source Linti because the TM1 community is relatively small. A linter only becomes truly useful when it reflects the collective experience of many teams, not just one. By publishing it, we hope to invite contributions from other TM1 practitioners and give back to a community that has always been generous with knowledge.
+
+## Compatibility Notice
+
+This project is an independent compatibility tool for TurboIntegrator (TI) scripts used in TM1.
+
+It is not affiliated with, endorsed by, sponsored by, or maintained by IBM. TM1, Planning Analytics, and related product names are referenced for compatibility and identification purposes only.
+
+## Feature
+
+* Lexer
+* Linter
+* Rules
+* Parser (AST)
+* Formatter
+
+## Soonish
+
+* Loader feature (e.g., TI from JSON)
+
+## Install via Pypi
+
+The linter is available on PyPI and can be installed using `pip install linti`.
+
+## Configuration
+
+The linter can be configured using a `linti.yaml` configuration file. The file is automatically discovered and loaded from the same directory as the TI file being analyzed.
+
+### Automatic Configuration Discovery
+
+Place a `linti.yaml` file in your project. The linter searches upward from the file being linted until it finds a `linti.yaml`, reaches a project root (`.git`, `pyproject.toml`, `setup.cfg`, `setup.py`), or hits the filesystem root.
+
+```bash
+my-project/
+├── linti.yaml              # Applies to all TI files below
+├── processes/
+│   ├── process1.ti
+│   └── process2.ti
+└── special/
+    ├── linti.yaml          # Overrides for this directory
+    └── process3.ti
+```
+
+When you run `linti processes/process1.ti`, the linter walks up and finds `my-project/linti.yaml`. Files in `special/` use their own local config instead.
+
+### Custom Configuration File
+
+You can also specify a custom configuration file:
+
+```bash
+linti process.ti --config custom-config.yaml
+```
+
+### Configuration Options
+
+A typical `linti.yaml` file looks like this:
+
+```yaml
+rules:
+  # F110 - Keyword Casing
+  # Enforces consistent casing for keywords (IF, ENDIF, ELSE, WHILE, END)
+  # Supported styles: uppercase, lowercase, camelcase
+  keyword_casing:
+    enabled: true
+    style: uppercase
+
+  # F310 - Block Indentation
+  # Enforces indentation for IF/WHILE blocks
+  # size: number of spaces per indentation level
+  indentation:
+    enabled: true
+    size: 4
+
+  # N110 - Variable Prefix Naming
+  # Enforces TM1 naming conventions
+  # - Numeric variables must start with 'n'
+  # - String variables must start with 's'
+  variable_prefix:
+    enabled: true
+    # Allow constants to start with 'c' (e.g., cRate, cMessage)
+    # When enabled, constants may only be assigned once.
+    allow_constant_prefix: false
+```
+
+`rules.one_space_before_equals` has been removed with rule `F210`. If it is still present in an older config, linti warns and ignores it.
+
+### All rules
+
+For a complete reference of all linting rules with detailed configuration examples and usage instructions, see [ALL_RULES.md](ALL_RULES.md).
+
+### Disabling Rules
+
+To disable a specific rule, set `enabled: false`:
+
+```yaml
+rules:
+  keyword_casing:
+    enabled: false
+  variable_prefix:
+    enabled: true
+```
+
+### Inline Suppression (`noqa`)
+
+You can suppress specific rules directly in TI code using `# noqa` comments.
+TI uses `#` for comments, so the syntax feels natural.
+
+#### Trailing comment — suppress current line
+
+```
+nVar=1;  # noqa: F220
+```
+
+#### Standalone comment — suppress the next code line
+
+```
+# noqa: F110
+if(nVar = 1);
+```
+
+#### Procedure-level — first comment before any code suppresses the entire file/procedure
+
+```
+# noqa: S320, S310
+ExecuteCommand(sCmd, 1);
+RunProcess(pProcess);
+```
+
+#### Region — suppress a block of lines
+
+```
+# noqa-begin: F110
+if(nVar = 1);
+endif;
+# noqa-end: F110
+```
+
+Multiple rule IDs can be combined with commas: `# noqa: F110, N110, S220`
+
+## CLI Usage
+
+### Basic Usage
+
+```bash
+# Lint a single file
+linti process.ti
+
+# Lint with additional debug output
+linti process.ti --tokens
+linti process.ti --ast
+linti process.ti --tokens --ast
+
+# Lint with custom configuration
+linti process.ti --config my-config.yaml
+
+# Auto-fix issues
+linti process.ti --auto-fix
+
+# Lint a YAML ProcessObject file
+linti process.yaml --auto-fix
+
+# Lint all YAML files in a directory
+linti processes/ --auto-fix
+```
+
+### Command Help
+
+```bash
+linti --help
+```
+
+### Selecting Specific Rules
+
+Use the `--select` option to run only specific rules or groups of rules:
+
+```bash
+# Run a specific rule
+linti process.ti --select F110
+
+# Run all rules in a category (e.g., all Format rules)
+linti process.ti --select F
+
+# Run all rules in a subcategory (e.g., all F1xx - Casing rules)
+linti process.ti --select F1
+
+# Run multiple rules or groups (comma-separated)
+linti process.ti --select F110,S220
+linti process.ti --select F,N1,S3
+
+# Combining with other options
+linti process.ti --select F --auto-fix
+linti process.ti --select N,S --tokens
+```
+
+**Selection patterns:**
+- `D`, `F`, `N`, `S` – Select all rules in a category
+- `D4`, `F1`, `F2`, `F3`, `N1`, `N2`, `S1`, `S2`, `S3` – Select all rules in a subcategory
+- `D410`, `F110`, `S220` – Select a specific rule
+
+### Listing Rules
+
+Use the `explain` subcommand to inspect available rules and view detailed guidance for one rule.
+
+```bash
+# List all rules with short description and auto-fix support
+linti explain
+
+# Explain a specific rule in detail
+linti explain F110
+```
+
+
+## Rule Groups
+
+Rules are organized into three main categories, each with a hierarchical numbering scheme. The categorization helps identify the type of violation and group related rules together.
+
+### Format Rules (F1xx, F2xx, F3xx)
+Formatting and code style rules:
+
+- **F1xx - Casing**: Keyword capitalization and case consistency
+  - `F110` - Keyword Casing
+  
+- **F2xx - Spacing**: Whitespace and spacing requirements
+  - `F220` - Whitespace Around Operators
+  - `F230` - Whitespace After Comma
+  - `F240` - No Space Before Semicolon
+  - `F250` - One Space Inside Parentheses
+  - `F260` - No Multiple Spaces
+  - `F270` - No Trailing Whitespace
+  
+- **F3xx - Structure**: Indentation, line breaks, and code layout
+  - `F310` - Block Indentation
+  - `F320` - One Statement Per Line
+
+### Naming Rules (N1xx, N2xx)
+Variable and parameter naming conventions:
+
+- **N1xx - Prefix Naming**: Variable prefix conventions (n, s, c prefixes)
+  - `N110` - Variable Prefix Naming
+  
+- **N2xx - Metadata Naming**: Naming conventions for specific declarations
+  - `N210` - Parameter Naming
+  - `N220` - Data Source Variable Naming
+
+### Documentation Rules (D4xx)
+Documentation and process docstring validation:
+
+- **D4xx - Docstrings**: Required docstring regions and headers
+  - `D410` - Docstring Region
+
+### Semantic Rules (S1xx, S2xx, S3xx)
+Logic, control flow, and semantic validation:
+
+- **S1xx - Control Flow**: Process execution and control flow patterns
+  - `S110` - ProcessQuit Placement
+  - `S120` - ItemSkip Block Usage
+  
+- **S2xx - Immutability**: Variable mutability and assignment constraints
+  - `S210` - Read-only Parameters and Variables
+  - `S220` - Single-assignment Constants
+  
+- **S3xx - Security/Calls**: Security-sensitive operations and function calls
+  - `S310` - Literal Process Calls
+  - `S320` - No ExecuteCommand
+  - `S330` - ODBCOpen Password Parameter
+
+Use `linti explain` to list all rules or `linti explain <RULE_ID>` for detailed information about a specific rule.
+
+### Auto-Fix Feature
+
+The linter can automatically fix keyword casing issues (F110: Keyword Casing) and block indentation issues (F310: Block Indentation) using the `--auto-fix` flag:
+
+## TM1 Block Context Awareness
+
+The linter understands TM1's four execution blocks when linting YAML ProcessObject files:
+
+- **Prolog**: Initialization and setup code
+- **Metadata**: Dimension/hierarchy manipulation code
+- **Data**: Record-by-record data processing
+- **Epilog**: Finalization and cleanup code
+
+Rules can use block context to enforce block-specific requirements. For example:
+- The ProcessQuit rule only allows `ProcessQuit()` in IF/ELSE blocks within Prolog or Epilog
+- Rules could require certain variable naming patterns based on the block
+
+When linting plain `.ti` files, the block context is `None` and rules apply generic validation.
+
+## License
+
+This project is licensed under the **Apache License 2.0**. See the [LICENSE](LICENSE) file for details.
+
+The full license text is also available at the [Apache Software Foundation](https://www.apache.org/licenses/LICENSE-2.0).