Release 1.2 (#529)

CoderLine · Jan 17, 2021 · 7bbdfcd · 7bbdfcd
1 parent 7da5242
commit 7bbdfcd
Show file tree

Hide file tree

Showing 503 changed files with 15,539 additions and 4,748 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,52 +1,49 @@
 ---
-name: 🕷 Bug report
+name: "\U0001F577 Bug report"
 about: Report a bug.
+title: ''
+labels: ":spider: type-bug"
+assignees: Danielku15
 
 ---
 
 <!--
-
-!!! The issue templates provided here are mandatory to be used !!!
-!!! Issues not filling out the provided structure and details  !!!
-!!! will be closed without addressing them. It takes you 2mins !!!
-!!! more for us it takes a lot of time to organize and address !!!
-!!! clarify open points if you do not provide them             !!!
-
-
-Additionally for bugs: 
-
-- IMPORTANT: Do not simply delete the whole template and submit without providing the details asked for! Issues not following the template will be closed without being worked on. Please try to be precise and provide all details that help to work on the issue. 
-- Please make sure that no other bug with the same topic exists already. Rather reopen a closed one than enter a new one.  
-- Ensure that you are using the lastest version. 
-
+❗❗ The issue templates provided here are mandatory to be used and filled out
+❗❗ Issues not filling out the provided structure and details will be closed 
 -->
 
-# Your environment
-
-* Version used: (master branch)
-* Platform used: JavaScript or C#
-* Rendering engine used: SVG (default), HTML5 or GDI
-* Browser Name and Version: 
-* Operating System and version (desktop or mobile):
-* Link to your project:
-
-
-# Expected Results
+### Expected Results
 <!-- Explain here what is your expected behavior of alphaTab. -->
 
-# Observed Results
+### Observed Results
 <!-- Explain here how alphaTab is behaving currently. -->
 
-# Steps to Reproduce (for bugs)
+### Steps to Reproduce
 <!--
 Explain here the exact steps how to reproduce the problem. Try to provide a
 running sample showing the issue. If you have problem with a dedicated input file, 
 please provide a download link or attach it to the issue. 
 -->
 
+Link to jsFiddle, CodePen, Project etc.: 
+
 1. 
 2. 
 3.  
 
-# Possible Solution 
-<!-- If you already know a solution to the problem please provide it here. -->
+### Further details 
+<!-- Provide any further valuable details here, feel free to leave this empty if you do not have more details or an idea how to solve it -->
+
+### Your environment
+
+**Version**
+- [ ] 1.0 
+- [ ] 1.1
+- [ ] 1.2-alpha.## <!-- Add your exact version here -->
+
+**Flavor**
+- [ ] JavaScript 
+- [ ] .net 
+
+**System**
+<!-- Any details about your test environment like Browser name and version, .net version, operating system etc. -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Feature Request
+    url: https://github.com/CoderLine/alphaTab/discussions?discussions_q=category%3AIdeas
+    about: Propose your desired feature with a new discussion.
+  - name: General Question
+    url: https://github.com/CoderLine/alphaTab/discussions?discussions_q=category%3AQ%26A
+    about: Ask any question about alphaTab.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,16 @@
+### Issues
+<!-- Each pull request needs to be related to an issue, mention it here below -->
+Fixes #
+
+### Proposed changes
+<!-- Describe the proposed changes -->
+
+### Checklist
+- [ ] I consent that this change becomes part of alphaTab under it's current or any future open source license
+- [ ] Changes are implemented
+- [ ] Existing builds tests pass
+- [ ] New tests were added
+
+## Further details
+- [ ] This is a breaking change
+- [ ] This change will require update of the documentation/website
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,6 @@ bin/
 .vs/
 *.user
 *.tgz
-test-results/
+test-results/
+debug.log
+src/generated/VersionInfo.ts
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -4,6 +4,7 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+
         {
             "name": "Launch C# Compiler",
             "type": "node",
@@ -25,6 +26,45 @@
             "env": {
                 "TS_NODE_PROJECT": "tsconfig.build-csharp.json"
             }
+        },
+
+        {
+            "name": "Launch TypeScript Generator",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "src.compiler/typescript/AlphaTabGenerator.ts",
+                "--project",
+                "tsconfig.build-csharp.json"
+            ],
+            "runtimeArgs": [
+                "--nolazy",
+                "-r",
+                "ts-node/register"
+            ],
+            "cwd": "${workspaceRoot}",
+            "protocol": "inspector",
+            "smartStep": false,
+            "internalConsoleOptions": "openOnSessionStart",
+            "env": {
+                "TS_NODE_PROJECT": "tsconfig.build-csharp.json"
+            }
+        },
+
+        {
+            "name": "Launch JavaScript Compiler",
+            "type": "node",
+            "request": "launch",
+            "runtimeExecutable": "npm",
+            "windows": {
+                "runtimeExecutable": "npm.cmd"
+            },
+            "runtimeArgs": [
+                "run-script",
+                "build",
+                "--inspect-brk=5858"
+            ],
+            "port": 5858
         }
     ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,7 @@
 {
     "files.exclude": {
         "dist/lib.csharp/**": true,
-        "src.csharp/**": true
+        "src.csharp/**": true,
+        "node_modules/**": true
     }
 }
diff --git a/README.md b/README.md
@@ -8,6 +8,13 @@ alphaTab is a cross platform music notation and guitar tablature rendering libra
 
 ![alphaTab](img/banner.png?raw=true "alphaTab")
 
+# Getting Started
+
+To get started follow our guides and tutorials at: 
+
+* https://www.alphatab.net/docs/introduction
+* https://www.alphatab.net/docs/tutorials
+
 ## Build Status
 
 > Until the official 1.0 release we recommend to use pre release versions based on the `develop` branch.
@@ -20,9 +27,7 @@ alphaTab is a cross platform music notation and guitar tablature rendering libra
 # Downloads
 
 The latest binaries based  are available for download at either npmjs.org or NuGet.org.
-Use the links below to grab the binaries from the latest builds. Please do not use the GitHub releases yet, they are not maintained. We recommend using package managers to pull the files to your projects. 
-
-> Until the official 1.0 release we recommend to use `develop` branch which are available as "pre-release" versions on the package registries.
+Use the links below to grab the binaries from the latest builds. We recommend using package managers to pull the files to your projects. 
 
 &nbsp; | &nbsp;
 --- | --- |

diff --git a/code-of-conduct.md b/code-of-conduct.md
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at alexjovermorales@gmail.com. All
+reported by contacting the project team via GitHub options. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

diff --git a/karma.conf.js b/karma.conf.js
@@ -15,6 +15,7 @@ const storage = multer.diskStorage({
 const upload = multer({ storage: storage });
 const cors = require('cors');
 const fs = require('fs');
+const path = require('path');
 
 module.exports = function (config) {
     config.set({
@@ -54,6 +55,38 @@ module.exports = function (config) {
             port: 8090,
             appVisitor: function (app, log) {
                 app.use(cors());
+                app.get(
+                    '/list-files',
+                    function (req, res) {
+                        log.info(`loading files from ${req.query.dir}`);
+
+                        const directoryPath = path.join(__dirname, req.query.dir);
+                        fs.readdir(directoryPath, (err, files) => {
+                            //handling error
+                            if (err) {
+                                res.status(400);
+                                res.send(JSON.stringify(`Error: ${err.message}`));
+                            } else {
+                                res.send(JSON.stringify(files.filter(f => 
+                                    fs.statSync(path.join(directoryPath, f)).isFile()
+                                )));
+                            }
+                        });
+                    }
+                );
+                app.post(
+                    '/save-file',
+                    upload.fields([
+                        {
+                            name: 'file',
+                            maxCount: 1
+                        }
+                    ]),
+                    function (req, res) {
+                        log.info(`save file ${req.file}`);
+                        res.send(JSON.stringify('OK'));
+                    }
+                );
                 app.post(
                     '/save-visual-error',
                     upload.fields([
@@ -75,6 +108,27 @@ module.exports = function (config) {
                         res.send(JSON.stringify('OK'));
                     }
                 );
+                app.post(
+                    '/list-files',
+                    upload.fields([
+                        {
+                            name: 'expected',
+                            maxCount: 1
+                        },
+                        {
+                            name: 'actual',
+                            maxCount: 1
+                        },
+                        {
+                            name: 'diff',
+                            maxCount: 1
+                        }
+                    ]),
+                    function (req, res) {
+                        log.info(`save visual error ${req.file}`);
+                        res.send(JSON.stringify('OK'));
+                    }
+                );
             }
         },