https://github.com/simatic-ax/string-builder
The library @simatic-ax/string-builder implements a StringBuilder class featuring a fluent interface. This allows users to chain string operations.
https://github.com/simatic-ax/string-builder
iec-st library siemens simatic-ax
Last synced: 5 months ago
JSON representation
The library @simatic-ax/string-builder implements a StringBuilder class featuring a fluent interface. This allows users to chain string operations.
- Host: GitHub
- URL: https://github.com/simatic-ax/string-builder
- Owner: simatic-ax
- License: other
- Created: 2024-07-30T11:38:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T12:53:43.000Z (6 months ago)
- Last Synced: 2026-01-17T03:36:31.565Z (6 months ago)
- Topics: iec-st, library, siemens, simatic-ax
- Homepage:
- Size: 79.1 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# @simatic-ax/string-builder
## Description
The package @simatic-ax/string-builder provides a StringBuilder class that implements a fluent interface. This allows users to chain string operations.
The construction of composite strings follows a pattern which is closer to natural speech compared with the conventional string operations (e.g. `CONCAT`). The readability of string operations is improved by using the package.
## Getting started
Install with Apax:
> If not yet done login to the GitHub registry first.
> More information you'll find [here](https://github.com/simatic-ax/.github/blob/main/docs/personalaccesstoken.md)
```cli
apax add @simatic-ax/string-builder
```
Add the namespace in your ST code:
```iec-st
USING Simatic.Ax.Strings;
```
## Objects
UML Diagram
```mermaid
classDiagram
class StringBuilder
StringBuilder : -_string STRING
interface IConstrainedStringBuilder
IConstrainedStringBuilder : +Reset IConstrainedStringBuilder
IConstrainedStringBuilder : +Append IStringBuilder
IConstrainedStringBuilder : +ToString() STRING
interface IStringBuilder
IStringBuilder : +Insert() IStringBuilder
IStringBuilder : +Remove() IStringBuilder
IStringBuilder : +Substring() IStringBuilder
IStringBuilder : +StartOf() IStringBuilder
IStringBuilder : +EndOf() IStringBuilder
IStringBuilder : +Replace() IStringBuilder
IConstrainedStringBuilder <|-- IStringBuilder
StringBuilder ..|> IStringBuilder
```
### Interfaces
[IStringBuilder](./docs/IStringBuilder.md)
[IConstrainedStringBuilder](./docs/IConstrainedStringBuilder.md)
### Classes
[StringBuilder](./docs/StringBuilder.md)
### Methods
| Name | Description |
| ---- | :--------------------------------------- |
| `Reset` | Reset the current string to an empty string|
| `Append` | Append the text to the current string and return it|
| `Insert` | Insert the text at a specific location in the string and return it|
| `Remove` | Remove characters from the string and return it|
| `Substring`| Retrieve a specific part of the string and return it|
| `StartOf` | Retrieve the start of a string and return it|
| `EndOf` | Retrieve the end of a string and return it|
| `Replace` | Replace characters in a string and return it|
| `ToString` | Return the current string|
## Example
### Configuration
```st
CONFIGURATION MyConfiguration
TASK Main(Interval := T#100ms, Priority := 1);
PROGRAM P1 WITH Main: MyProgram;
VAR_GLOBAL
diagnosticMessage : STRING;
END_VAR
END_CONFIGURATION
```
### Program
```st
USING Simatic.Ax.Strings
PROGRAM MyProgram
VAR_EXTERNAL
diagnosticMessage : STRING;
END_VAR
VAR
_sb : StringBuilder;
END_VAR
diagnosticMessage := _sb.Append('build a string').Append(' by chaining methods.').Insert('How to ',0).ToString();
// result : "How to build a string by chaining methods."
END_PROGRAM
```
## Contribution
Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.
## Markdownlint-cli
This workspace will be checked by the [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) (there is also documented ho to install the tool) tool in the CI workflow automatically.
To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with:
```sh
markdownlint **/*.md --fix
```
## License and Legal information
Please read the [Legal information](LICENSE.md)