Merge remote-tracking branch 'origin/develop' into feature/osClassModuleType

Author: theshadowco

.github/ISSUE_TEMPLATE/Bug.md

@@ -8,16 +8,16 @@ assignees: ''
 ---
 
 **Версия**
-> Версия BSLLS либо плагина, который использует BSLLS
+<!-- Версия BSLLS либо плагина, который использует BSLLS -->
 
 **Описание ошибки диагностики**
-> Описание ошибки, замечания
+<!-- Описание ошибки, замечания -->
 
 **Пример кода**
-> Пример кода (в блоке code или прикрепленный файл), на котором ошибка воспроизводится
+<!-- Пример кода (в блоке code или прикрепленный файл), на котором ошибка воспроизводится -->
 
 **Скриншоты**
-> Скриншоты с подтверждением
+<!-- Скриншоты с подтверждением -->
 
 **Дополнительная информация**
-> Любая дополнительная информация, которая поможет в расследовании проблемы
+<!-- Любая дополнительная информация, которая поможет в расследовании проблемы -->

.github/ISSUE_TEMPLATE/NewDiagnostic.md

@@ -50,7 +50,7 @@ assignees: ''
 * [ ] `LOCALIZE` - "Проблемы локализации"
 
 ### Время на исправление (минут)
-<!-- Сколько времени необходим на исправление замечания разработчику, например: 1 минута -->
+<!-- Сколько времени необходимо на исправление замечания разработчику, например: 1 минута -->
 
 ## Дополнительная информация
 <!-- Можно добавить любую информацию, которая может быть полезной при реализации -->

.github/workflows/codesee-arch-diagram.yml

@@ -0,0 +1,22 @@
+# This workflow was added by CodeSee. Learn more at https://codesee.io/
+# This is v2.0 of this workflow file
+on:
+  push:
+    branches:
+      - develop
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+name: CodeSee
+
+permissions: read-all
+
+jobs:
+  codesee:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    name: Analyze the repo with CodeSee
+    steps:
+      - uses: Codesee-io/codesee-action@v2
+        with:
+          codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}

.github/workflows/gh-pages.yml

@@ -31,7 +31,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.6'
+        python-version: '3.7.15'
         architecture: 'x64'
 
     - name: Install dependencies
@@ -145,7 +145,7 @@ jobs:
         cp -R temp/site/. public/dev/en
         
     - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3.8.0
+      uses: peaceiris/actions-gh-pages@v3.9.2
       with:
         deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
         publish_branch: gh-pages

.github/workflows/qa.yml

@@ -47,10 +47,10 @@ jobs:
         git checkout -B ${{ fromJson(steps.get_pr_data.outputs.data).base.ref }} upstream/${{ fromJson(steps.get_pr_data.outputs.data).base.ref }}
         git checkout ${{ github.event.workflow_run.head_branch }}
         git clean -ffdx && git reset --hard HEAD
-    - name: Set up JDK 11
+    - name: Set up JDK 17
       uses: actions/setup-java@v3
       with:
-        java-version: 11
+        java-version: 17
         distribution: 'temurin'
     - name: SonarCloud Scan on PR
       if: github.event.workflow_run.event == 'pull_request'

.github/workflows/qodana.yml

@@ -20,15 +20,15 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: 'Qodana Scan'
-        uses: JetBrains/qodana-action@v5.1.0
+        uses: JetBrains/qodana-action@v2022.3.4
         with:
           linter: jetbrains/qodana-jvm-community
       - uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: ${{ runner.temp }}/qodana/results/qodana.sarif.json
       - name: Deploy to GitHub Pages
         if: github.event_name == 'push'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v3.9.2
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ${{ runner.temp }}/qodana/results/report

.github/workflows/rebase.yml

@@ -14,6 +14,6 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
       - name: Automatic Rebase
-        uses: cirrus-actions/rebase@1.7
+        uses: cirrus-actions/rebase@1.8
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/sentry.yml

@@ -0,0 +1,20 @@
+name: Sentry
+on:
+  push:
+    branches-ignore:
+      - "translations_*"
+jobs:
+
+  sentry:
+    name: Sentry
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Create Sentry release
+        uses: getsentry/action-release@v1
+        env:
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
+        with:
+          environment: production

build.gradle.kts

@@ -8,19 +8,21 @@ plugins {
     jacoco
     signing
     id("org.cadixdev.licenser") version "0.6.1"
-    id("org.sonarqube") version "3.4.0.2513"
-    id("io.freefair.lombok") version "6.4.3.1"
-    id("io.freefair.javadoc-links") version "6.4.3.1"
-    id("io.freefair.javadoc-utf-8") version "6.4.3.1"
-    id("io.freefair.aspectj.post-compile-weaving") version "6.4.3.1"
-    id("io.freefair.maven-central.validate-poms") version "6.4.3.1"
-    id("me.qoomon.git-versioning") version "6.1.4"
-    id("com.github.ben-manes.versions") version "0.42.0"
-    id("org.springframework.boot") version "2.6.7"
-    id("io.spring.dependency-management") version "1.0.11.RELEASE"
-    id("io.github.1c-syntax.bslls-dev-tools") version "0.7.0"
-    id("ru.vyarus.pom") version "2.2.1"
+    id("org.sonarqube") version "3.5.0.2730"
+    id("io.freefair.lombok") version "6.6.1"
+    id("io.freefair.javadoc-links") version "6.6.1"
+    id("io.freefair.javadoc-utf-8") version "6.6.1"
+    id("io.freefair.aspectj.post-compile-weaving") version "6.6.1"
+    id("io.freefair.maven-central.validate-poms") version "6.6.1"
+    id("me.qoomon.git-versioning") version "6.4.0"
+    id("com.github.ben-manes.versions") version "0.45.0"
+    id("org.springframework.boot") version "2.7.5"
+    id("io.spring.dependency-management") version "1.1.0"
+    id("io.github.1c-syntax.bslls-dev-tools") version "0.7.2"
+    id("ru.vyarus.pom") version "2.2.2"
+    id("com.gorylenko.gradle-git-properties") version "2.4.1"
     id("io.codearte.nexus-staging") version "0.30.0"
+    id("me.champeau.jmh") version "0.6.8"
 }
 
 repositories {
@@ -51,29 +53,37 @@ val isSnapshot = gitVersioning.gitVersionDetails.refType != GitRefType.TAG
 
 val languageToolVersion = "5.6"
 
+dependencyManagement {
+    imports {
+        mavenBom("io.sentry:sentry-bom:6.13.1")
+    }
+}
+
 dependencies {
 
     // RUNTIME
 
     // spring
     api("org.springframework.boot:spring-boot-starter")
-    api("info.picocli:picocli-spring-boot-starter:4.6.3")
+    api("org.springframework.boot:spring-boot-starter-websocket")
+    api("info.picocli:picocli-spring-boot-starter:4.7.1")
 
     // lsp4j core
-    api("org.eclipse.lsp4j", "org.eclipse.lsp4j", "0.14.0")
+    api("org.eclipse.lsp4j", "org.eclipse.lsp4j", "0.19.0")
+    api("org.eclipse.lsp4j", "org.eclipse.lsp4j.websocket", "0.19.0")
 
     // 1c-syntax
-    api("com.github.1c-syntax", "bsl-parser", "0.21.0") {
+    api("com.github.1c-syntax", "bsl-parser", "167aaad827322e09ccde4658a71152dad234de4b") {
         exclude("com.tunnelvisionlabs", "antlr4-annotations")
         exclude("com.ibm.icu", "*")
         exclude("org.antlr", "ST4")
         exclude("org.abego.treelayout", "org.abego.treelayout.core")
         exclude("org.antlr", "antlr-runtime")
         exclude("org.glassfish", "javax.json")
     }
-    api("com.github.1c-syntax", "utils", "0.4.0")
-    api("io.github.1c-syntax", "bsl-common-library", "31ba49780f9fcd0cbf2c5ed631d43e879375bff0")
+    api("com.github.1c-syntax", "utils", "f1694d9c")
     api("com.github.1c-syntax", "mdclasses", "0.10.3")
+    api("io.github.1c-syntax", "bsl-common-library", "31ba49780f9fcd0cbf2c5ed631d43e879375bff0")
     api("io.github.1c-syntax", "supportconf", "0.1.1")
 
     // JLanguageTool
@@ -82,7 +92,7 @@ dependencies {
     implementation("org.languagetool", "language-ru", languageToolVersion)
 
     // AOP
-    implementation("org.aspectj", "aspectjrt", "1.9.7")
+    implementation("org.aspectj", "aspectjrt", "1.9.9.1")
 
     // commons utils
     implementation("commons-io", "commons-io", "2.11.0")
@@ -91,7 +101,7 @@ dependencies {
     implementation("org.apache.commons", "commons-collections4", "4.4")
 
     // progress bar
-    implementation("me.tongfei", "progressbar", "0.9.2")
+    implementation("me.tongfei", "progressbar", "0.9.5")
 
     // (de)serialization
     implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310")
@@ -103,10 +113,12 @@ dependencies {
     // SARIF serialization
     implementation("com.contrastsecurity", "java-sarif", "2.0")
 
-    // COMPILE
+    // Sentry
+    implementation("io.sentry:sentry-spring-boot-starter")
+    implementation("io.sentry:sentry-logback")
 
-    // stat analysis
-    compileOnly("com.google.code.findbugs", "jsr305", "3.0.2")
+    // COMPILE
+    compileOnly("com.github.spotbugs:spotbugs-annotations:4.7.3")
 
     // TEST
 
@@ -116,8 +128,8 @@ dependencies {
     }
 
     // test utils
-    testImplementation("com.ginsberg", "junit5-system-exit", "1.1.2")
-    testImplementation("org.awaitility", "awaitility", "4.1.1")
+    testImplementation("org.jmockit", "jmockit", "1.49")
+    testImplementation("org.awaitility", "awaitility", "4.2.0")
 }
 
 java {
@@ -163,6 +175,9 @@ tasks.test {
     reports {
         html.required.set(true)
     }
+
+    val jmockitPath = classpath.find { it.name.contains("jmockit") }!!.absolutePath
+    jvmArgs("-javaagent:${jmockitPath}")
 }
 
 tasks.check {
@@ -205,6 +220,7 @@ tasks.generateDiagnosticDocs {
 }
 
 tasks.javadoc {
+    isFailOnError = false
     options {
         this as StandardJavadocDocletOptions
         links(

docs/contributing/StyleGuide.md

@@ -4,10 +4,29 @@
 
 Постарайтесь придерживаться их, и процесс ревью Вашего кода будет гладким и шелковистым (с).
 
-## Общие рекомендации
+## Обработка null
 
 Если метод на законных основаниях может возвращать `null`, рекомендуется вместо явного возврата `null` возвращать `Optional<T>`. Исключения (например, высокочастотные или перфомансные функции) обговариваются отдельно.
 
+В описании пакета `package-info.java` необходимо указать, что в пакете по умолчанию используется NonNull API.
+Для этого над именем пакета добавляется аннотация `@DefaultAnnotation(NonNull.class)`
+
+Пример:
+```java
+// ...Лицензия...
+@DefaultAnnotation(NonNull.class)
+package com.github._1c_syntax.bsl.languageserver;
+
+import edu.umd.cs.findbugs.annotations.DefaultAnnotation;
+import edu.umd.cs.findbugs.annotations.NonNull;
+```
+
+Для явного указания того, что метод может принимать или возвращать `null`, используется аннотация `@edu.umd.cs.findbugs.annotations.Nullable`.
+
+В общем случае это позволяет не использовать аннотации `@edu.umd.cs.findbugs.annotations.NonNull` вообще.
+
+Аннотации по контролю за `null` из пакета `javax.annotations` или `jetbrains.annotations` использоваться не должны.
+
 ## Форматирование
 
 1. Весь код в модулях должен быть автоматически отформатирован.
@@ -56,6 +75,6 @@
 1. Подключение новых библиотек в implementation scope стоит производить аккуратно, с контролем увеличения размера итогового jar-файла. По возможности "лишние" и незадействованные суб-зависимости стоит исключать через `exclude`.
 1. Явное подключение библиотеки `com.google.guava`, `Google Collections` или прочих частей библиотек семейства Guava запрещено. В случае **крайней** необходимости допустимо копирование реализации из `Guava` внутрь BSL Language Server с выполнением условий лицензии Guava. Для всего остального есть Apache Commons.
 1. Прямой импорт классов `*.google.*`, а так же прочих частей библиотек Guava запрещено. Без исключений.
-
+1. Пакет `jsr305` и его аннотации не должны использоваться в коде. См. раздел "Обработка null".
 
 > В процессе наполнения...