Skip to content

Commit

Permalink
style: apply automatic fixes of linters
Browse files Browse the repository at this point in the history
  • Loading branch information
@MShahzaib @github-actions
MShahzaib authored and github-actions[bot] committed Jun 29, 2022
1 parent e62f101 commit cda2506
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 51 deletions.
2 changes: 1 addition & 1 deletion ....larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/formatting2/SafeDSFormatter.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -904,7 +904,7 @@ class SafeDSFormatter : AbstractFormatter2() {
}
}

/**********************************************************************************************************
/**********************************************************************************************************
* Schema
**********************************************************************************************************/

Expand Down
88 changes: 38 additions & 50 deletions docs/Development/how-to-add-a-new-language-concept.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# How to add a new language concept

1. Create new classes in the EMF model (_abstract syntax_):
1. [Update the Ecore file][SafeDS.ecore]. Ensure that `SdsAbstractObject` is either a direct of transitive supertype.
1. [Update the Genmodel file][SafeDS.genmodel].

1. [Update the Ecore file][safeds.ecore]. Ensure that `SdsAbstractObject` is either a direct of transitive supertype.
1. [Update the Genmodel file][safeds.genmodel].

1. Update the grammar (_concrete syntax_).
1. Create [grammar tests][grammar-tests]:
1. Positive tests (with comment `// no_syntax_error`)
1. Negative tests (with comment `// syntax_error`)
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [Xtext grammar file][SafeDS.xtext].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Create [grammar tests][grammar-tests]:
1. Positive tests (with comment `// no_syntax_error`)
1. Negative tests (with comment `// syntax_error`)
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [Xtext grammar file][safeds.xtext].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Update the [constants][constants] if the concrete syntax of your concept has terminals that need to be accessed programmatically (e.g. operators or modifiers).

Expand All @@ -19,79 +21,65 @@
1. Update the [access shortcuts][shortcuts], which simplify the traversal of the EMF model. This is not always required and the file should only contain functions that are simple enough to not require tests.

1. Update the converters if your concept includes terminals where the value they represent differs from their textual representation.
1. Create [converter tests][converter-tests]
1. Run the tests (`./gradlew test`). There should be failures.
1. Add a [converter][converters].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Create [converter tests][converter-tests]
1. Run the tests (`./gradlew test`). There should be failures.
1. Add a [converter][converters].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Update the scope provider if your concept has cross-references.
1. Create [scoping tests][scoping-tests].
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [local scope provider][local-scope-provider].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Create [scoping tests][scoping-tests].
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [local scope provider][local-scope-provider].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Update the [resource description strategy][resource-description-strategy] if your concept is a declaration that should be visible from another file.

1. Update the [static analyses][static-analysis].

1. Update the validator.
1. Create [validation tests][validation-tests]
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [validators][validators] or add a new one.
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Create [validation tests][validation-tests]
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [validators][validators] or add a new one.
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Update the code generator.
1. Create [generator tests][generator-tests]
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [generator][generator].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Create [generator tests][generator-tests]
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [generator][generator].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Update the formatter.
1. Create [formatting tests][formatting-tests].
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [formatter][formatting].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Create [formatting tests][formatting-tests].
1. Run the tests (`./gradlew test`). There should be failures.
1. Update the [formatter][formatting].
1. Run the tests again (`./gradlew test`). Tests should now pass.

1. Update the [tutorial][tutorial].

<!-- Links -->

[SafeDS.ecore]: ../../DSL/com.larsreimann.safeds/model/SafeDS.ecore

[SafeDS.genmodel]: ../../DSL/com.larsreimann.safeds/model/SafeDS.genmodel

[safeds.ecore]: ../../DSL/com.larsreimann.safeds/model/SafeDS.ecore
[safeds.genmodel]: ../../DSL/com.larsreimann.safeds/model/SafeDS.genmodel
[grammar-tests]: ../../DSL/com.larsreimann.safeds/src/test/resources/grammar

[SafeDS.xtext]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/SafeDS.xtext

[safeds.xtext]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/SafeDS.xtext
[converter-tests]: ../../DSL/com.larsreimann.safeds/src/test/kotlin/com/larsreimann/safeds/conversion

[converters]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/conversion

[scoping-tests]: ../../DSL/com.larsreimann.safeds/src/test/kotlin/com/larsreimann/safeds/scoping/ScopingTest.kt

[local-scope-provider]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/scoping/SafeDSScopeProvider.kt

[resource-description-strategy]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/scoping/SafeDSResourceDescriptionStrategy.kt

[static-analysis]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/staticAnalysis

[validation-tests]: ../../DSL/com.larsreimann.safeds/src/test/resources/validation

[validators]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/validation

[constants]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/constant

[creators]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/emf/Creators.kt

[shortcuts]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/emf/SimpleShortcuts.kt

[generator-tests]: ../../DSL/com.larsreimann.safeds/src/test/resources/generator

[generator]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/generator/SafeDSGenerator.kt

[formatting-tests]: ../../DSL/com.larsreimann.safeds/src/test/resources/formatting

[formatting]: ../../DSL/com.larsreimann.safeds/src/main/kotlin/com/larsreimann/safeds/formatting2/SafeDSFormatter.kt

[tutorial]: docs/../../DSL/README.md

0 comments on commit cda2506

Please sign in to comment.