mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-05 14:46:55 +01:00
Add StrongPoint custom knowledge layer
Eight organization rules in custom/knowledge, each overriding or supplementing the Microsoft layer for StrongPoint repositories: - style/spu-prefix-on-objects-and-extension-members - style/cyclomatic-complexity-is-not-a-gate-in-sp-repos (LC0010 = Info) - ui/keep-tooltips-on-sp-page-fields (AA0218 = Error, LC0064 off; overrides microsoft ui/bound-page-field-inherits-source-field-tooltip) - data-modeling/sp-field-names-fit-30-chars-with-prefix (AL0468 = Error) - events/change-ls-central-behaviour-through-its-events - web-services/device-io-goes-through-sp-device-manager - appsource/sp-id-ranges-are-not-checked-by-as0084 (AS0084 = None) - upgrade/sp-released-ids-never-change Sources: sp.ruleset.json across SP repositories, SPUFBUpgrade pattern in SP-LSC-Fiscal-Printing, observed LS Central and Device Manager usage. Verified: all eight are indexed by Build-KnowledgeIndex.ps1, and a review of a probe app applied the ToolTip rule as major and suppressed the Microsoft article by layer precedence. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
07e324ddbc
commit
5149da25ba
8 changed files with 208 additions and 0 deletions
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
bc-version: [all]
|
||||
domain: data-modeling
|
||||
keywords: [field-name, length, al0468, 30-characters, prefix, tableextension]
|
||||
technologies: [al]
|
||||
countries: [w1]
|
||||
application-area: [all]
|
||||
---
|
||||
|
||||
# SP table field names, prefix included, stay within 30 characters
|
||||
|
||||
## Description
|
||||
|
||||
Table field names are limited to 30 characters (compiler rule AL0468), and StrongPoint's `sp.ruleset.json` raises AL0468 to an **error**. Because extension fields must start with `SPU ` plus the app code (for example `SPU FB `), only about 23–26 characters remain for the descriptive part. Generated names routinely exceed the limit and break the build.
|
||||
|
||||
## Best Practice
|
||||
|
||||
Count the full field name, prefix and spaces included, before proposing it; abbreviate the descriptive part (`Rcpt.`, `No.`, `Amt.`) the way existing SP fields do, and put the long wording in `Caption`. Report a field name over 30 characters as `major`.
|
||||
|
||||
## Anti Pattern
|
||||
|
||||
A field such as `"SPU FB Fiscal Receipt Printed Date Time"` (39 characters), or dropping the `SPU` prefix to make a name fit.
|
||||
|
||||
## References
|
||||
|
||||
StrongPoint policy: `sp.ruleset.json` — AL0468 `Error` ("Length of the table field name must not exceed 30 characters").
|
||||
Loading…
Add table
Add a link
Reference in a new issue