Skip to content

Commit f70c7cb

Browse files
VitjanZVitjanZ
authored
Merge pull request #78 from Codeplain-ai/feat/section_renaming
Renaming to test reqs and implementation reqs
2 parents ecc7b26 + 57bc0e1 commit f70c7cb

65 files changed

Lines changed: 105 additions & 105 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎examples/example_hello_world_golang/hello_world_golang.plain‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import:
44
- golang-console-app-template
55
---
66

7-
***technical specs***
7+
***implementation reqs***
88

99
- :MainExecutableFile: of :App: should be called "hello_world.go".
1010

‎examples/example_hello_world_python/hello_world_python.plain‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import:
44
- python-console-app-template
55
---
66

7-
***technical specs***
7+
***implementation reqs***
88

99
- :MainExecutableFile: of :App: should be called "hello_world.py".
1010

‎install/walkthrough.sh‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ echo ""
2828
echo -e "${GRAY} ┌────────────────────────────────────────────────────────┐${NC}"
2929
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
3030
echo -e "${GRAY} │${NC} ${YELLOW}***definitions***${NC} - key concepts in your app ${GRAY}│${NC}"
31-
echo -e "${GRAY} │${NC} ${YELLOW}***technical specs***${NC} - implementation details ${GRAY}│${NC}"
32-
echo -e "${GRAY} │${NC} ${YELLOW}***test specs***${NC} - testing requirements ${GRAY}│${NC}"
31+
echo -e "${GRAY} │${NC} ${YELLOW}***implementation reqs***${NC} - implementation details ${GRAY}│${NC}"
32+
echo -e "${GRAY} │${NC} ${YELLOW}***test reqs***${NC} - testing requirements ${GRAY}│${NC}"
3333
echo -e "${GRAY} │${NC} ${YELLOW}***functional specs***${NC} - what the app should do ${GRAY}│${NC}"
3434
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
3535
echo -e "${GRAY} └────────────────────────────────────────────────────────┘${NC}"
@@ -56,12 +56,12 @@ echo -e "${GRAY} │${NC} ${GRAY}***definitions***${NC}
5656
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
5757
echo -e "${GRAY} │${NC} ${GRAY}- :App: is a console application.${NC} ${GRAY}│${NC}"
5858
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
59-
echo -e "${GRAY} │${NC} ${GRAY}***technical specs***${NC} ${GRAY}│${NC}"
59+
echo -e "${GRAY} │${NC} ${GRAY}***implementation reqs***${NC} ${GRAY}│${NC}"
6060
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
6161
echo -e "${GRAY} │${NC} ${GRAY}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
6262
echo -e "${GRAY} │${NC} ${GRAY}- :UnitTests: should use Unittest framework.${NC} ${GRAY}│${NC}"
6363
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
64-
echo -e "${GRAY} │${NC} ${GRAY}***test specs***${NC} ${GRAY}│${NC}"
64+
echo -e "${GRAY} │${NC} ${GRAY}***test reqs***${NC} ${GRAY}│${NC}"
6565
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
6666
echo -e "${GRAY} │${NC} ${GRAY}- :ConformanceTests: should use Unittest.${NC} ${GRAY}│${NC}"
6767
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
@@ -94,12 +94,12 @@ echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***definitions***${NC}
9494
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
9595
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :App: is a console application.${NC} ${GRAY}│${NC}"
9696
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
97-
echo -e "${GRAY} │${NC} ${GRAY}***technical specs***${NC} ${GRAY}│${NC}"
97+
echo -e "${GRAY} │${NC} ${GRAY}***implementation reqs***${NC} ${GRAY}│${NC}"
9898
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
9999
echo -e "${GRAY} │${NC} ${GRAY}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
100100
echo -e "${GRAY} │${NC} ${GRAY}- :UnitTests: should use Unittest framework.${NC} ${GRAY}│${NC}"
101101
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
102-
echo -e "${GRAY} │${NC} ${GRAY}***test specs***${NC} ${GRAY}│${NC}"
102+
echo -e "${GRAY} │${NC} ${GRAY}***test reqs***${NC} ${GRAY}│${NC}"
103103
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
104104
echo -e "${GRAY} │${NC} ${GRAY}- :ConformanceTests: should use Unittest.${NC} ${GRAY}│${NC}"
105105
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
@@ -114,14 +114,14 @@ echo -e " Concepts help keep your specs consistent and clear."
114114
echo ""
115115
read -r -p " press [Enter] to continue..." < /dev/tty
116116

117-
# Onboarding Step 4: Technical & Test Specs
117+
# Onboarding Step 4: Implementation & Test Reqs
118118
clear
119119
echo ""
120120
echo -e "${GRAY}────────────────────────────────────────────${NC}"
121121
echo -e " ${YELLOW}${BOLD}Plain Language 101${NC} - Step 4 of 5"
122122
echo -e "${GRAY}────────────────────────────────────────────${NC}"
123123
echo ""
124-
echo -e " ${WHITE}${BOLD}TECHNICAL & TEST SPECS${NC} - how to implement and test"
124+
echo -e " ${WHITE}${BOLD}IMPLEMENTATION & TEST REQS${NC} - how to implement and test"
125125
echo ""
126126
echo -e " Specify ${GREEN}implementation details${NC} and ${GREEN}testing requirements${NC}."
127127
echo -e " This guides how the code should be generated and verified."
@@ -132,12 +132,12 @@ echo -e "${GRAY} │${NC} ${GRAY}***definitions***${NC}
132132
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
133133
echo -e "${GRAY} │${NC} ${GRAY}- :App: is a console application.${NC} ${GRAY}│${NC}"
134134
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
135-
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***technical specs***${NC} ${GRAY}│${NC}"
135+
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***implementation reqs***${NC} ${GRAY}│${NC}"
136136
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
137137
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
138138
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :UnitTests: should use Unittest framework.${NC} ${GRAY}│${NC}"
139139
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
140-
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***test specs***${NC} ${GRAY}│${NC}"
140+
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***test reqs***${NC} ${GRAY}│${NC}"
141141
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
142142
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :ConformanceTests: should use Unittest.${NC} ${GRAY}│${NC}"
143143
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
@@ -147,8 +147,8 @@ echo -e "${GRAY} │${NC} ${GRAY}- :App: should display \"hello, world\".${NC}
147147
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
148148
echo -e "${GRAY} └────────────────────────────────────────────────────────┘${NC}"
149149
echo ""
150-
echo -e " ${GREEN}▲${NC} ${YELLOW}Technical specs${NC} define the language and frameworks."
151-
echo -e " ${YELLOW}Test specs${NC} ensure the generated code is verified."
150+
echo -e " ${GREEN}▲${NC} ${YELLOW}Implementation reqs${NC} define the language and frameworks."
151+
echo -e " ${YELLOW}Test reqs${NC} ensure the generated code is verified."
152152
echo ""
153153
read -r -p " press [Enter] to continue..." < /dev/tty
154154

‎plain_file.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ def _process_single_acceptance_test_requirement(functional_requirement: mistleto
206206
# Handle the case when the heading is not valid. This case includes cases such as:
207207
# - Writing `acceptance test` instead of `acceptance tests` (or any other syntax diffs).
208208
# - Instead of specifying `acceptance tests` below the functional requirement, creator of the plain file
209-
# might have specified some other building block (e.g. `technical specs`)
209+
# might have specified some other building block (e.g. `implementation reqs`)
210210
raise PlainSyntaxError(acceptance_test_heading_problem)
211211

212212
if is_acceptance_test_heading:

‎plain_spec.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
from plain2code_exceptions import InvalidLiquidVariableName
99

1010
DEFINITIONS = "definitions"
11-
NON_FUNCTIONAL_REQUIREMENTS = "technical specs"
12-
TEST_REQUIREMENTS = "test specs"
11+
NON_FUNCTIONAL_REQUIREMENTS = "implementation reqs"
12+
TEST_REQUIREMENTS = "test reqs"
1313
FUNCTIONAL_REQUIREMENTS = "functional specs"
1414
ACCEPTANCE_TESTS = "acceptance_tests"
1515
ACCEPTANCE_TEST_HEADING = "acceptance tests"

‎standard_template_library/golang-console-app-template.plain‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
- :ConformanceTestsExecutableFile: is the main executable code file of :ConformanceTests:.
88

99

10-
***technical specs***
10+
***implementation reqs***
1111

1212
- :Implementation: should be in Go lang.
1313

1414
- :Implementation: should include unit tests using Go's built-in testing package.
1515

1616

17-
***test specs***
17+
***test reqs***
1818

1919
- :ConformanceTests: should be implemented in Go lang.
2020

‎standard_template_library/python-console-app-template.plain‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
- :MainExecutableFile: is the main executable code file of :App:.
88

99

10-
***technical specs***
10+
***implementation reqs***
1111

1212
- :Implementation: should be in Python.
1313

1414
- :Implementation: should include :Unittests: using Unittest framework! If :Unittests: are put in the subfolder, make sure to include __init__.py to make them discoverable.
1515

16-
***test specs***
16+
***test reqs***
1717

1818
- :ConformanceTests: of :App: should be implemented in Python using Unittest framework. :ConformanceTests: will be run using "python -m unittest discover" command. Therefore, if :ConformanceTests: are put in the subfolder, make sure to include __init__.py to make them discoverable.
1919

‎standard_template_library/typescript-react-app-template.plain‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- :App: is a web application.
44

55

6-
***technical specs***
6+
***implementation reqs***
77

88
- :App: should be implemented in TypeScript, using React as a web framework.
99

@@ -12,6 +12,6 @@
1212
- :App: should run on port 3000.
1313

1414

15-
***test specs***
15+
***test reqs***
1616

1717
- :ConformanceTests: of :App: should be written in TypeScript, using Cypress as the framework for :ConformanceTests:.

‎tests/data/imports/circular_imports_2.plain‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ import:
33
- circular_imports_1
44
---
55

6-
***technical specs***
6+
***implementation reqs***
77

88
- :Implementation: should include :Unittests: using Unittest framework!

‎tests/data/imports/circular_imports_main.plain‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import:
33
- circular_imports_1
44
---
55

6-
***technical specs***
6+
***implementation reqs***
77

88
- :MainExecutableFile: of :App: should be called "hello_world.py".
99

0 commit comments

Comments
 (0)