go live

Author: sjuergen

.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+name: linter checks
+on:
+  push:
+
+jobs:
+  linter:
+    name: "Linter Checks"
+    runs-on: ubuntu-latest
+    
+    
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+    
+      - name: Check markdown files
+        uses: avto-dev/markdown-lint@v1
+        with:
+          args: '**/*.md'
+          ignore: ./LICENSE.md

.markdownlint.yml

@@ -0,0 +1,11 @@
+# markdownlint YAML configuration
+---
+
+# Default state for all rules
+default: true
+
+# ignored rules
+line-length: false
+no-inline-html: false
+first-line-h1: false
+no-emphasis-as-header: false

CODEOWNERS

@@ -0,0 +1,4 @@
+# These owners will be the default owners for everything in the repo. 
+# Unless a later match takes precedence, the listed user will be 
+# requested for review when someone opens a pull request.
+* @sjuergen @BeckerStS @kruegerfelix

LICENSE.md

@@ -13,17 +13,17 @@ Siemens provides products and solutions with industrial security functions that
 In order to protect plants, systems, machines and networks against cyber threats, it is necessary to implement – and continuously maintain – a holistic, state-of-the-art industrial security concept. Siemens' products and solutions constitute one element of such a concept.
 Customers are responsible for preventing unauthorized access to their plants, systems, machines and networks. Such systems, machines and components should only be connected to an enterprise network or the internet if and to the extent such a connection is necessary and only when appropriate security measures (e.g. firewalls and/or network segmentation) are in place.
 
-For additional information on industrial security measures that may be implemented, please visit 
+For additional information on industrial security measures that may be implemented, please visit
 <https://www.siemens.com/industrialsecurity>.
 
 **1.3 Compliance with Export Control Regulations**
 
-You shall comply with all applicable sanctions, embargoes and (re-)export control regulations, and, in any event, with those of the European Union and the United States of America (collectively "Export Regulations"). In particular, the information, software and documentation provided by Siemens (collectively "Licensed Material") shall not be used, accessed or transferred, unless permitted by the Export Regulations or respective governmental licenses or approvals, (i) in or to any location prohibited by or subject to comprehensive sanctions (currently Russia, Cuba, Iran, North Korea, Syria, and the Crimea region of Ukraine, Donetsk and Luhansk regions of Ukraine) or license requirements according to the Export Regulations; (ii) by or to any individual or entity designated on a sanctioned party list of the Export Regulations; (iii) for any purpose prohibited by the Export Regulations (e.g. use in connection with armaments, nuclear technology or weapons); or (iv) to upload any content unless it is noncontrolled (e .g. in the EU: AL = N; in the U.S.: ECCN = N or EAR99). If required to enable authorities or Siemens to conduct export control checks, You, upon request by Siemens, shall promptly provide Siemens with all information pertaining to You, the intended use and the location of use of the Licensed Material. Siemens shall not be obligated to fulfill this Agreement if such fulfillment is prevented by any impediments arising out of national or international foreign trade or customs requirements or any embargoes or other sanctions. 
+You shall comply with all applicable sanctions, embargoes and (re-)export control regulations, and, in any event, with those of the European Union and the United States of America (collectively "Export Regulations"). In particular, the information, software and documentation provided by Siemens (collectively "Licensed Material") shall not be used, accessed or transferred, unless permitted by the Export Regulations or respective governmental licenses or approvals, (i) in or to any location prohibited by or subject to comprehensive sanctions (currently Russia, Cuba, Iran, North Korea, Syria, and the Crimea region of Ukraine, Donetsk and Luhansk regions of Ukraine) or license requirements according to the Export Regulations; (ii) by or to any individual or entity designated on a sanctioned party list of the Export Regulations; (iii) for any purpose prohibited by the Export Regulations (e.g. use in connection with armaments, nuclear technology or weapons); or (iv) to upload any content unless it is noncontrolled (e .g. in the EU: AL = N; in the U.S.: ECCN = N or EAR99). If required to enable authorities or Siemens to conduct export control checks, You, upon request by Siemens, shall promptly provide Siemens with all information pertaining to You, the intended use and the location of use of the Licensed Material. Siemens shall not be obligated to fulfill this Agreement if such fulfillment is prevented by any impediments arising out of national or international foreign trade or customs requirements or any embargoes or other sanctions.
 
 **2. Open Source License for Software provided in source code and the generated source code**
 
-In case the Software contains or generates source code the following open source license (Open license terms) shall apply for such source code: 
-    
+In case the Software contains or generates source code the following open source license (Open license terms) shall apply for such source code:
+
     MIT License
 
     Copyright 2022 Siemens AG

README.md

@@ -1,19 +1,21 @@
 # Snippets collection
 
-A collection of useful user defined snippets for AX Code. 
+A collection of useful user defined snippets for AX Code.
+
 ## Install the snippets collection
 
 To install the snippets collection to your workspace enter the following command in a terminal:
 
-```
+```bash
 apax add @simatic-ax/snippetscollection --dev
 ```
 
-> to install this package you need to login into the GitHub registry. You'll find more information [here](https://github.com/simatic-ax/.sharedstuff/blob/main/doc/personalaccesstoken.md) 
+> to install this package you need to login into the GitHub registry. You'll find more information [here](https://github.com/simatic-ax/.sharedstuff/blob/main/doc/personalaccesstoken.md)
 
 ## AXUnitSupport
 
 ### Create a test fixture with AxUnit.Assert
+
 ```json
 "prefix": ["AxUnit test-fixture"]
 ```
@@ -23,49 +25,56 @@ Output example:
 ![io](doc/img/ax_test-fixture.gif)
 
 ### Insert Using AxUnit.Assert
+
 ```json
 "prefix": ["AxUnit, using ax"]
 ```
 
 Output:
+
 ```iecst
 USING AxUnit.Assert;
 ```
 
-### AxUnit assertions 
+### AxUnit assertions
+
 ```json
 "prefix": ["eq, ne, lt, gt"]
 ```
 
 Output:
+
 ```iecst
 Equal(expected := 0, actual := 0);
 NotEqual(expected := 0, actual := 0);
 LessThan(expected := 0, actual := 0);
 GreaterThan(expected := 0, actual := 0);
 ```
 
-
-
 ## Snippets Namespace Support
 
 ### NamespaceSupport
+
 ```json
 "prefix" : ["namespace, Siemens"]
 ```
 
 Output:
+
 ```iecst
 NAMESPACE Simatic.Ax
     
 END_NAMESPACE
 ```
+
 ### Snippets for class support
+
 ```json
 "prefix" : ["class template, End_Class"]
 ```
 
 Output:
+
 ```iecst
 NAMESPACE Simatic.Ax
     CLASS Untitled
@@ -90,6 +99,7 @@ END_NAMESPACE
 ```
 
 Output:
+
 ```iecst
 METHOD PUBLIC|PRIVATE|PROTECTED MyMethod
     ;
@@ -103,41 +113,47 @@ END_METHOD
 ```
 
 ### VAR sections within classes
+
 ```json
 "prefix" : ["varc"]
 ```
 
-
 Output:
+
 ```iecst
 VAR PUBLIC|PRIVATE|PROTECTED 
     ;
 END_VAR
 ```
 
-
 ### VAR sections within methods and functions
+
 ```json
 "prefix" : ["vari"]
 ```
+
 Output:
+
 ```iecst
 VAR_INPUT|VAR_OUTPUT|VAR_IN_OUT|VAR_TEMP|VAR CONSTANT
     count: INT;
 END_VAR
 ```
 
 ## Enumeration
+
 ```json
 "prefix" : ["enum"]
 ```
 
-Output: 
+Output:
+
 ```iec-st
 TYPE
     Colours : (RED, GREEN, BLUE) := RED;
 END_TYPE
 ```
+
 ## IO support
 
 ```json
@@ -151,18 +167,19 @@ Output example:
 ![io](doc/img/io_snippet.gif)
 
 ## Iterate ARRAY[*] Snippet
+
 ```json
 "prefix" : ["Iterate Array*"]
 ```
+
 Output example:
 
 ![io](doc/img//iterate_array_star.gif)
 
-
 ## 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.
 
 ## License and Legal information
 
 Please read the [Legal information](LICENSE.md)
-