feat: adding tealer support (#3)

* feat: adding tealer support * chore: updating gitignore * chore: updating gitignore
algorandfoundation · Feb 21, 2024 · 9230397 · 9230397
1 parent b5cadcb
commit 9230397
Show file tree

Hide file tree

Showing 20 changed files with 150 additions and 0 deletions.
diff --git a/template_content/.gitignore.jinja b/template_content/.gitignore.jinja
@@ -176,3 +176,5 @@ node_modules
 
 # AlgoKit
 debug_traces/
+
+.algokit/static-analysis/tealer/
diff --git a/template_content/{% if ide_vscode %}.vscode{% endif %}/tasks.json b/template_content/{% if ide_vscode %}.vscode{% endif %}/tasks.json
@@ -59,6 +59,21 @@
         "cwd": "${workspaceFolder}"
       },
       "problemMatcher": []
+    },
+    {
+      "label": "Analyze TEAL contracts with AlgoKit Tealer integration",
+      "command": "algokit",
+      "args": [
+        "task",
+        "analyze",
+        "${workspaceFolder}/.algokit",
+        "--recursive",
+        "--force"
+      ],
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
     }
   ]
 }
diff --git a/template_content/{% if use_github_actions %}.github{% endif %}/workflows/checks.yaml.jinja b/template_content/{% if use_github_actions %}.github{% endif %}/workflows/checks.yaml.jinja
@@ -83,6 +83,9 @@ jobs:
       - name: Build smart contracts
         run: poetry run python -m smart_contracts build
 
+      - name: Scan TEAL files for issues
+        run: algokit task analyze .algokit --recursive --force # add --diff flag if you want output stability checks instead
+
       - name: Check output stability of the smart contracts
         shell: bash
         run: |

diff --git a/template_content/{% if use_pre_commit %}.pre-commit-config.yaml{% endif %}.jinja b/template_content/{% if use_pre_commit %}.pre-commit-config.yaml{% endif %}.jinja
@@ -36,3 +36,13 @@ repos:
         minimum_pre_commit_version: '2.9.2'
         files: '^(src|tests)/'
       {% endif %}
+      - id: tealer
+        name: tealer
+        description: "Run AlgoKit `Tealer` for TEAL static analysis"
+        entry: algokit
+        language: system
+        args: [task, analyze, ".algokit", "--recursive", "--force"]
+        require_serial: false
+        additional_dependencies: []
+        minimum_pre_commit_version: "0"
+        files: '^.*\.teal$'
diff --git a/...t_smart_contract_generator_default_production_preset_python/.github/workflows/checks.yaml b/...t_smart_contract_generator_default_production_preset_python/.github/workflows/checks.yaml
@@ -67,6 +67,9 @@ jobs:
       - name: Build smart contracts
         run: poetry run python -m smart_contracts build
 
+      - name: Scan TEAL files for issues
+        run: algokit task analyze .algokit --recursive --force # add --diff flag if you want output stability checks instead
+
       - name: Check output stability of the smart contracts
         shell: bash
         run: |

diff --git a/tests_generated/test_smart_contract_generator_default_production_preset_python/.gitignore b/tests_generated/test_smart_contract_generator_default_production_preset_python/.gitignore
@@ -176,3 +176,5 @@ node_modules
 
 # AlgoKit
 debug_traces/
+
+.algokit/static-analysis/tealer/
diff --git a/...ed/test_smart_contract_generator_default_production_preset_python/.pre-commit-config.yaml b/...ed/test_smart_contract_generator_default_production_preset_python/.pre-commit-config.yaml
@@ -36,3 +36,13 @@ repos:
         minimum_pre_commit_version: '2.9.2'
         files: '^(src|tests)/'
 
+      - id: tealer
+        name: tealer
+        description: "Run AlgoKit `Tealer` for TEAL static analysis"
+        entry: algokit
+        language: system
+        args: [task, analyze, ".algokit", "--recursive", "--force"]
+        require_serial: false
+        additional_dependencies: []
+        minimum_pre_commit_version: "0"
+        files: '^.*\.teal$'
diff --git a/...nerated/test_smart_contract_generator_default_production_preset_python/.vscode/tasks.json b/...nerated/test_smart_contract_generator_default_production_preset_python/.vscode/tasks.json
@@ -59,6 +59,21 @@
         "cwd": "${workspaceFolder}"
       },
       "problemMatcher": []
+    },
+    {
+      "label": "Analyze TEAL contracts with AlgoKit Tealer integration",
+      "command": "algokit",
+      "args": [
+        "task",
+        "analyze",
+        "${workspaceFolder}/.algokit",
+        "--recursive",
+        "--force"
+      ],
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
     }
   ]
 }
diff --git a/...art_contract_generator_default_production_preset_typescript/.github/workflows/checks.yaml b/...art_contract_generator_default_production_preset_typescript/.github/workflows/checks.yaml
@@ -61,6 +61,9 @@ jobs:
       - name: Build smart contracts
         run: poetry run python -m smart_contracts build
 
+      - name: Scan TEAL files for issues
+        run: algokit task analyze .algokit --recursive --force # add --diff flag if you want output stability checks instead
+
       - name: Check output stability of the smart contracts
         shell: bash
         run: |

diff --git a/...s_generated/test_smart_contract_generator_default_production_preset_typescript/.gitignore b/...s_generated/test_smart_contract_generator_default_production_preset_typescript/.gitignore
@@ -176,3 +176,5 @@ node_modules
 
 # AlgoKit
 debug_traces/
+
+.algokit/static-analysis/tealer/
diff --git a/...est_smart_contract_generator_default_production_preset_typescript/.pre-commit-config.yaml b/...est_smart_contract_generator_default_production_preset_typescript/.pre-commit-config.yaml
@@ -36,3 +36,13 @@ repos:
         minimum_pre_commit_version: '2.9.2'
         files: '^(src|tests)/'
 
+      - id: tealer
+        name: tealer
+        description: "Run AlgoKit `Tealer` for TEAL static analysis"
+        entry: algokit
+        language: system
+        args: [task, analyze, ".algokit", "--recursive", "--force"]
+        require_serial: false
+        additional_dependencies: []
+        minimum_pre_commit_version: "0"
+        files: '^.*\.teal$'
diff --git a/...ted/test_smart_contract_generator_default_production_preset_typescript/.vscode/tasks.json b/...ted/test_smart_contract_generator_default_production_preset_typescript/.vscode/tasks.json
@@ -59,6 +59,21 @@
         "cwd": "${workspaceFolder}"
       },
       "problemMatcher": []
+    },
+    {
+      "label": "Analyze TEAL contracts with AlgoKit Tealer integration",
+      "command": "algokit",
+      "args": [
+        "task",
+        "analyze",
+        "${workspaceFolder}/.algokit",
+        "--recursive",
+        "--force"
+      ],
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
     }
   ]
 }
diff --git a/...test_smart_contract_generator_default_starter_preset_python/.github/workflows/checks.yaml b/...test_smart_contract_generator_default_starter_preset_python/.github/workflows/checks.yaml
@@ -67,6 +67,9 @@ jobs:
       - name: Build smart contracts
         run: poetry run python -m smart_contracts build
 
+      - name: Scan TEAL files for issues
+        run: algokit task analyze .algokit --recursive --force # add --diff flag if you want output stability checks instead
+
       - name: Check output stability of the smart contracts
         shell: bash
         run: |

diff --git a/tests_generated/test_smart_contract_generator_default_starter_preset_python/.gitignore b/tests_generated/test_smart_contract_generator_default_starter_preset_python/.gitignore
@@ -176,3 +176,5 @@ node_modules
 
 # AlgoKit
 debug_traces/
+
+.algokit/static-analysis/tealer/
diff --git a/...rated/test_smart_contract_generator_default_starter_preset_python/.pre-commit-config.yaml b/...rated/test_smart_contract_generator_default_starter_preset_python/.pre-commit-config.yaml
@@ -36,3 +36,13 @@ repos:
         minimum_pre_commit_version: '2.9.2'
         files: '^(src|tests)/'
 
+      - id: tealer
+        name: tealer
+        description: "Run AlgoKit `Tealer` for TEAL static analysis"
+        entry: algokit
+        language: system
+        args: [task, analyze, ".algokit", "--recursive", "--force"]
+        require_serial: false
+        additional_dependencies: []
+        minimum_pre_commit_version: "0"
+        files: '^.*\.teal$'
diff --git a/..._generated/test_smart_contract_generator_default_starter_preset_python/.vscode/tasks.json b/..._generated/test_smart_contract_generator_default_starter_preset_python/.vscode/tasks.json
@@ -59,6 +59,21 @@
         "cwd": "${workspaceFolder}"
       },
       "problemMatcher": []
+    },
+    {
+      "label": "Analyze TEAL contracts with AlgoKit Tealer integration",
+      "command": "algokit",
+      "args": [
+        "task",
+        "analyze",
+        "${workspaceFolder}/.algokit",
+        "--recursive",
+        "--force"
+      ],
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
     }
   ]
 }
diff --git a/..._smart_contract_generator_default_starter_preset_typescript/.github/workflows/checks.yaml b/..._smart_contract_generator_default_starter_preset_typescript/.github/workflows/checks.yaml
@@ -61,6 +61,9 @@ jobs:
       - name: Build smart contracts
         run: poetry run python -m smart_contracts build
 
+      - name: Scan TEAL files for issues
+        run: algokit task analyze .algokit --recursive --force # add --diff flag if you want output stability checks instead
+
       - name: Check output stability of the smart contracts
         shell: bash
         run: |

diff --git a/tests_generated/test_smart_contract_generator_default_starter_preset_typescript/.gitignore b/tests_generated/test_smart_contract_generator_default_starter_preset_typescript/.gitignore
@@ -176,3 +176,5 @@ node_modules
 
 # AlgoKit
 debug_traces/
+
+.algokit/static-analysis/tealer/
diff --git a/...d/test_smart_contract_generator_default_starter_preset_typescript/.pre-commit-config.yaml b/...d/test_smart_contract_generator_default_starter_preset_typescript/.pre-commit-config.yaml
@@ -36,3 +36,13 @@ repos:
         minimum_pre_commit_version: '2.9.2'
         files: '^(src|tests)/'
 
+      - id: tealer
+        name: tealer
+        description: "Run AlgoKit `Tealer` for TEAL static analysis"
+        entry: algokit
+        language: system
+        args: [task, analyze, ".algokit", "--recursive", "--force"]
+        require_serial: false
+        additional_dependencies: []
+        minimum_pre_commit_version: "0"
+        files: '^.*\.teal$'
diff --git a/...erated/test_smart_contract_generator_default_starter_preset_typescript/.vscode/tasks.json b/...erated/test_smart_contract_generator_default_starter_preset_typescript/.vscode/tasks.json
@@ -59,6 +59,21 @@
         "cwd": "${workspaceFolder}"
       },
       "problemMatcher": []
+    },
+    {
+      "label": "Analyze TEAL contracts with AlgoKit Tealer integration",
+      "command": "algokit",
+      "args": [
+        "task",
+        "analyze",
+        "${workspaceFolder}/.algokit",
+        "--recursive",
+        "--force"
+      ],
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
     }
   ]
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -176,3 +176,5 @@ node_modules

		# AlgoKit
		debug_traces/

		.algokit/static-analysis/tealer/