Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Naming Conventions for AFF Interfaces to Documentation #679

Merged
merged 10 commits into from
Dec 19, 2024
+12 −2
Merged

Add Naming Conventions for AFF Interfaces to Documentation #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3a01bbb
Add AFF interface naming convetions
schneidermic0 Dec 17, 2024
a437796
abaplint config: Check AFF interface name
schneidermic0 Dec 17, 2024
f53d848
abaplint config: cover reuse AFF interfaces
schneidermic0 Dec 17, 2024
52da336
Remove trailing whitespace
schneidermic0 Dec 17, 2024
369a6fd
Change some text
schneidermic0 Dec 17, 2024
8b419bd
Fix regex to match interface names
schneidermic0 Dec 17, 2024
c0ee300
Remove \\ from the regular expressions
schneidermic0 Dec 17, 2024
b704e55
Improve text
schneidermic0 Dec 17, 2024
dba159e
Remove typo
schneidermic0 Dec 17, 2024
2a49089
Fix typo
schneidermic0 Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions abaplint.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,8 @@
"no_public_attributes": true,
"no_yoda_conditions": true,
"object_naming": {
"clas": "^(ZC(L|X)\\_AFF\\_|Z\\_AFF\\_EXAMPLE)",
"intf": "^(ZIF\\_AFF\\_|Z\\_AFF\\_EXAMPLE)",
"clas": "^(ZC(L|X)_AFF_|Z_AFF_EXAMPLE)",
"intf": "(^ZIF_AFF_[A-Z0-9]{4}_V[0-9]+$)|(^ZIF_AFF[A-Z0-9_]*_TYPES_V[0-9]+$)|(^Z_AFF_EXAMPLE)",
"prog": "^Z",
"fugr": "^Z",
"tabl": "^Z",
Expand Down
10 changes: 10 additions & 0 deletions docs/json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,16 @@ This leads to the following generated JSON schema:
]
}
```
## Naming Conventions

Following naming conventions apply to AFF's ABAP interfaces:

- The interface is called `zif_aff_<object type>_v<format version>` (e.g., `zif_aff_intf_v1`)
- Types start with `ty_`
- Constants start with `co_`

These conventions are checked by abaplint.

## Reusable Fields in JSON Files

This section describes fields that can be reused by all file formats.
Expand Down
Loading