feat: mark schemas as experimental (#1089)

Closes #1078 ### Summary of Changes Schemas are now marked as experimental.
Safe-DS · Apr 23, 2024 · 09faaf0 · 09faaf0
1 parent 368b6af
commit 09faaf0
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 2 deletions.
diff --git a/packages/safe-ds-lang/src/language/validation/experimentalLanguageFeatures.ts b/packages/safe-ds-lang/src/language/validation/experimentalLanguageFeatures.ts
@@ -1,5 +1,11 @@
 import { AstUtils, ValidationAcceptor } from 'langium';
-import { isSdsUnionType, type SdsConstraintList, type SdsLiteralType, type SdsUnionType } from '../generated/ast.js';
+import {
+    isSdsUnionType,
+    type SdsConstraintList,
+    type SdsLiteralType,
+    SdsSchema,
+    type SdsUnionType,
+} from '../generated/ast.js';
 import { SafeDsServices } from '../safe-ds-module.js';
 
 export const CODE_EXPERIMENTAL_LANGUAGE_FEATURE = 'experimental/language-feature';
@@ -38,6 +44,23 @@ export const literalTypesShouldBeUsedWithCaution = (services: SafeDsServices) =>
     };
 };
 
+export const schemasShouldBeUsedWithCaution = (services: SafeDsServices) => {
+    const settingsProvider = services.workspace.SettingsProvider;
+
+    return (node: SdsSchema, accept: ValidationAcceptor) => {
+        if (!settingsProvider.shouldValidateExperimentalLanguageFeatures()) {
+            /* c8 ignore next 2 */
+            return;
+        }
+
+        accept('warning', 'Schemas are experimental and may change without prior notice.', {
+            node,
+            property: 'name',
+            code: CODE_EXPERIMENTAL_LANGUAGE_FEATURE,
+        });
+    };
+};
+
 export const unionTypesShouldBeUsedWithCaution = (services: SafeDsServices) => {
     const settingsProvider = services.workspace.SettingsProvider;
 

diff --git a/packages/safe-ds-lang/src/language/validation/safe-ds-validator.ts b/packages/safe-ds-lang/src/language/validation/safe-ds-validator.ts
@@ -28,6 +28,7 @@ import { annotationCallMustHaveCorrectTarget, targetsShouldNotHaveDuplicateEntri
 import {
     constraintListsShouldBeUsedWithCaution,
     literalTypesShouldBeUsedWithCaution,
+    schemasShouldBeUsedWithCaution,
     unionTypesShouldBeUsedWithCaution,
 } from './experimentalLanguageFeatures.js';
 import {
@@ -354,7 +355,7 @@ export const registerValidationChecks = function (services: SafeDsServices) {
             referenceTargetShouldNotExperimental(services),
         ],
         SdsResult: [resultMustHaveTypeHint],
-        SdsSchema: [schemaMustContainUniqueNames],
+        SdsSchema: [schemaMustContainUniqueNames, schemasShouldBeUsedWithCaution(services)],
         SdsSegment: [
             segmentMustContainUniqueNames,
             segmentParameterShouldBeUsed(services),

diff --git a/...safe-ds-lang/tests/resources/validation/experimental language feature/schemas/main.sdsdev b/...safe-ds-lang/tests/resources/validation/experimental language feature/schemas/main.sdsdev
@@ -0,0 +1,4 @@
+package tests.validation.experimentalLanguageFeature.schemas
+
+// $TEST$ warning "Schemas are experimental and may change without prior notice."
+schema »MySchema« {}