⚠️ Breaking Change
This update is not backward compatible.
- Pull the latest code from https://github.com/Codeplain-ai/plain2code_client
- Update any existing ***plain specs to align with the new concept formatting rules
- If you need assistance migrating your specs, contact us at [email protected]
Concept Rules in ***plain
To improve the consistency and clarity of specifications used for code generation, we introduce concept-based definitions with strict formatting rules.
Each definition introduces a single concept, written as:
- :ConceptName: <explanation of the concept>
Concept naming rules
Each concept name must be enclosed in colons (:) at both the beginning and end.
Valid characters for concept name include: Plus sign (+), Minus sign (-), Dot sign (.), Digits (0-9), Uppercase letters (A-Z), Underscore (_), Lowercase letters (a-z).
Examples: :App:, :Tasks:, :ListOfUsers:, :CLI:.
Definition rules
- Each definition must start with the concept name being defined.
- Every concept name must be globally unique.
- Concepts referenced in Functional Requirements, Non-Functional Requirements, Test Requirements, or Acceptance Tests must appear in the Definitions section first.