Release 1.5.0 (#2061)

Author: Danielku15

.eclintrc.cjs

@@ -0,0 +1 @@
+FORCE_COLOR=1

.env

@@ -43,16 +43,27 @@ body:
     description: Providing a minimal reproducible example can help a lot.
   validations:
     required: false
-- type: dropdown
-  id: version
+- type: textarea
+  id: environment
   attributes:
-    label: Found in Version
-    description: Which version of alphaTab are you using?
-    options:
-    - 1.4 (alpha)
-    - 1.3    
-    - 1.2
-    - Other
+    label: Version and Environment
+    description: |
+      Please provide detailed information about your environment, like alphaTab version used, browser, device, .net runtime, Android version,..
+      Since 1.5.0: You can call `alphaTab.Environment.printEnvironmentInfo()` and copy the printed info. Or enable [debug logs](https://www.alphatab.net/docs/reference/settings/core/loglevel) and they are always printed.
+      Just grab them from the console/debugger/output/logcat output.      
+    placeholder: |
+      [AlphaTab][VersionInfo] alphaTab 1.5.0
+      [AlphaTab][VersionInfo] commit: 43c51b693438c54c0023ba729d7a7aa351e0f1fd
+      [AlphaTab][VersionInfo] build date: 2025-04-13T12:44:25.644Z
+      [AlphaTab][VersionInfo] High DPI: 1
+      [AlphaTab][VersionInfo] Browser: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36
+      [AlphaTab][VersionInfo] Platform: BrowserModule
+      [AlphaTab][VersionInfo] WebPack: false
+      [AlphaTab][VersionInfo] Vite: false
+      [AlphaTab][VersionInfo] Window Size: 1529x1152
+      [AlphaTab][VersionInfo] Screen Size: 3840x1200
+      
+    render: bash
   validations:
     required: true
 - type: dropdown
@@ -72,21 +83,7 @@ body:
     - Other
   validations:
     required: true
-- type: textarea
-  id: environment
-  attributes:
-    label: Environment
-    description: |
-      examples:
-        - **OS**: Windows 10 Pro
-        - **Browser**: Chrome 92.0.4515.159
-    value: |
-      - **OS**:
-      - **Browser**:
-      - **.net Version**:
-    render: markdown
-  validations:
-    required: true
+
 - type: textarea
   id: further
   attributes:

.github/ISSUE_TEMPLATE/bug_report_form.yml

@@ -8,6 +8,24 @@ on:
   workflow_dispatch:
 
 jobs:
+  lint:
+    name: Linting and TypeCheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - run: npm install
+      - run: npm run generate-typescript
+      - run: npm run lint-ci
+        if: ${{ always() }}
+      - run: npm run typecheck
+        if: ${{ always() }}
+
   build_web:
     name: Build and Test Web
     runs-on: ubuntu-latest
@@ -18,9 +36,18 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
-      - run: npm install
+          cache: 'npm'
+      - run: npm ci
       - run: npm run build
       - run: npm run test
+        id: test
+      - uses: actions/upload-artifact@v4
+        if: ${{ failure() && steps.test.conclusion == 'failure' }}
+        with: 
+          name: test-results-web
+          path: |
+            test-data/**/*.new.png
+            test-data/**/*.diff.png
 
   build_csharp:
     name: Build and Test C#
@@ -32,12 +59,21 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
+          cache: 'npm'
       - uses: actions/setup-dotnet@v4
         with:
           dotnet-version: '8'
-      - run: npm install
+      - run: npm ci
       - run: npm run build-csharp
       - run: npm run test-csharp
+        id: test
+      - uses: actions/upload-artifact@v4
+        if: ${{ failure() && steps.test.conclusion == 'failure' }}
+        with: 
+          name: test-results-csharp
+          path: |
+            test-data/**/*.new.png
+            test-data/**/*.diff.png
 
   build_kotlin:
     name: Build and Test Kotlin
@@ -58,19 +94,23 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
+          cache: 'npm'
       - uses: actions/setup-java@v4
         with:
           java-version: '19'
           distribution: 'temurin'
-      - uses: actions/cache@v4
+      - uses: gradle/actions/setup-gradle@v4
         with:
-          path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-cache-v5-${{ github.job }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
-          restore-keys: |
-            ${{ runner.os }}-gradle-cache-v5-${{ github.job }}-
-      - run: npm install
+          cache-read-only: false
+      - run: npm ci
       - run: npm run build-kotlin
       - run: npm run test-kotlin
-      - run: ./src.kotlin/alphaTab/gradlew --stop
+        id: test
+      - uses: actions/upload-artifact@v4
+        if: ${{ failure() && steps.test.conclusion == 'failure' }}
+        with: 
+          name: test-results-kotlin
+          path: |
+            test-data/**/*.new.png
+            test-data/**/*.diff.png      
+      - run: ./src.kotlin/alphaTab/gradlew --stop

.github/workflows/build.yml

@@ -35,7 +35,7 @@ jobs:
           cache: 'npm'
 
       - run: node ./scripts/update-version.js alpha ${{github.run_number}}
-      - run: npm install
+      - run: npm ci
       - run: npm run build
       - run: npm pack
 
@@ -66,7 +66,7 @@ jobs:
         with:
           dotnet-version: "8"
 
-      - run: npm install
+      - run: npm ci
       - run: node ./scripts/update-csharp-version.js alpha ${{github.run_number}}
       - run: npm run build-csharp
 
@@ -98,7 +98,7 @@ jobs:
           java-version: "19"
           distribution: "temurin"
 
-      - run: npm install
+      - run: npm ci
       - run: node ./scripts/update-kotlin-version.js SNAPSHOT
       - run: npm run build-kotlin
 

.github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
-      - run: npm install
+      - run: npm ci
       - run: node ./scripts/update-version.js ${{github.run_number}}
       - run: npm run build
       - run: npm pack
@@ -43,7 +43,7 @@ jobs:
           dotnet-version: '8'
         env:
           NUGET_AUTH_TOKEN: ${{secrets.NUGET_API_KEY}}
-      - run: npm install
+      - run: npm ci
       - run: node ./scripts/update-csharp-version.js ${{github.run_number}}
       - run: npm run build-csharp
       - run: dotnet nuget push src.csharp/AlphaTab/bin/Release/*.nupkg -k ${{secrets.NUGET_API_KEY}} -s https://api.nuget.org/v3/index.json --skip-duplicate
@@ -71,7 +71,7 @@ jobs:
           java-version: "19"
           distribution: "temurin"
 
-      - run: npm install
+      - run: npm ci
       - run: node ./scripts/update-kotlin-version.js
       - run: npm run build-kotlin
       - run: ./gradlew publishToMavenCentral

.github/workflows/release.yml

@@ -3,10 +3,14 @@
         "ts"
     ],
     "node-option": [
+        "env-file=.env",
         "experimental-specifier-resolution=node",
         "import=tsx/esm",
         "no-warnings"
     ],
     "spec": "test/**/*.test.ts",
-    "timeout": "10000"
+    "timeout": "10000",
+    "require": [
+        "test/global-hooks.ts"
+    ]
 }

.mocharc.json

@@ -1,8 +1,19 @@
 {
-    "mochaExplorer.files": "test/**/*.test.ts",
-    "mochaExplorer.nodeArgv": [
-        "--experimental-specifier-resolution=node",
-        "--import=tsx"
-    ],
-    "mochaExplorer.logpanel": true
+    "debug.javascript.terminalOptions": {
+        "resolveSourceMapLocations": [
+            "${workspaceFolder}/**",
+            "!**/node_modules/**",
+            "**/node_modules/.vite-temp/**"
+        ]
+    },
+    "typescript.preferences.importModuleSpecifier": "non-relative",
+    "[typescript]": {
+        "editor.defaultFormatter": "biomejs.biome"
+    },
+    "[json]": {
+        "editor.defaultFormatter": "biomejs.biome"
+    },
+    "[javascript]": {
+        "editor.defaultFormatter": "biomejs.biome"
+    }
 }

.prettierrc

@@ -42,4 +42,7 @@ Integrated Libraries:
     License: BSD-3-Clause
     Copyright: Copyright (c) 2002-2020 Xiph.org Foundation
     URL: https://github.com/xiph/vorbis
-    Purpose: NVorbis adopted some code from libvorbis.
+    Purpose: NVorbis adopted some code from libvorbis.
+
+@preserve
+@license