Release 1.0.0

.env.template

@@ -0,0 +1,8 @@
+# HTTP port of the dev server where the userscript will be served (when using `npm run watch`) - defaults to 8710 if empty
+DEV_SERVER_PORT=
+
+# Whether to trigger the bell sound in some terminals when the code has finished (re)compiling - default is false
+RING_BELL=false
+
+# optional suffix to add just before the .user.js of the output file (for use with CI or build scripts to build the file as BetterYTM.min.user.js)
+# OUTFILE_SUFFIX=".min"

.eslintrc.cjs

@@ -0,0 +1,58 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+  },
+  ignorePatterns: [
+    "*.min.*",
+    "webpack.config.js",
+    "*.user.js",
+    "*.map",
+    "dist/**",
+  ],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
+  globals: {
+    Atomics: "readonly",
+    SharedArrayBuffer: "readonly",
+    GM: "readonly",
+    unsafeWindow: "writable",
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+  },
+  plugins: [
+    "@typescript-eslint",
+  ],
+  rules: {
+    "no-unreachable": "off",
+    "quotes": [ "error", "double" ],
+    "semi": [ "error", "always" ],
+    "eol-last": [ "error", "always" ],
+    "no-async-promise-executor": "off",
+    "indent": ["error", 2, { "ignoredNodes": ["VariableDeclaration[declarations.length=0]"] }],
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-unused-vars": ["warn", { "ignoreRestSiblings": true, "argsIgnorePattern": "^_" }],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "comma-dangle": ["error", "only-multiline"],
+    "no-misleading-character-class": "off",
+  },
+  overrides: [
+    {
+      files: ["**.js"],
+      rules: {
+        "@typescript-eslint/no-var-requires": "off",
+        "quotes": [ "error", "double" ],
+        "semi": [ "error", "always" ],
+        "eol-last": [ "error", "always" ],
+        "no-async-promise-executor": "off",
+        "indent": ["error", 2, { "ignoredNodes": ["VariableDeclaration[declarations.length=0]"] }],
+        "comma-dangle": ["error", "only-multiline"],
+      },
+    },
+  ],
+};

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+github: Sv443
+patreon: Sv443
+ko_fi: Sv443
+custom: ['paypal.me/Sv443']

.github/ISSUE_TEMPLATE/1_bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a bug report to help improve BetterYTM
+title: ''
+labels: bug
+assignees: Sv443
+
+---
+
+
+### Description of the bug and steps to reproduce:
+<!-- A clear and concise description of what the bug is -->
+<!-- Also include steps to reproduce it -->
+
+
+### Environment:
+- Browser name & version: 
+- Userscript version & build number: x.x.x (xxxxxxx)
+<!--
+  To view the userscript version and build number, either open the configuration menu and copy the numbers and letters at the bottom,
+  or open the JavaScript console of your browser (usually with F12). It should be near the very top.
+-->
+
+
+### Other info / screenshots:
+<!-- If applicable and possible, add other information or screenshots to help explain your problem. -->

.github/ISSUE_TEMPLATE/2_feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest a new or improved feature for BetterYTM
+title: ''
+labels: enhancement
+assignees: Sv443
+
+---
+
+
+### Description of the feature:
+<!-- A clear and concise description of what feature you want to be added to BetterYTM -->
+
+
+### Other info / sketches:
+<!-- If applicable and possible, add other information or sketches to help explain your suggestion -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: "Discussions"
+    about: "Open a new thread on the discussion board if you have a question, want to show off your project, etc."
+    url: "https://github.com/Sv443/BetterYTM/discussions"
+  - name: "Chat on Discord"
+    about: "If you want, you can also join my Discord server"
+    url: "https://dc.sv443.net"

.github/workflows/codeql.yml

@@ -0,0 +1,44 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  # schedule:
+  #   - cron: '23 12 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze Code
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      matrix:
+        language: ["javascript"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: "Lint BetterYTM"
+
+on:
+  push:
+    branches: [develop]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    env:
+      CI: "true"
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Node.js v${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies # runs the npm ci command to install from package-lock.json
+        run: npm ci
+      - name: Build with tsc & lint
+        run: npm run lint

.gitignore

@@ -1,2 +1,9 @@
+.env
+test.js
+test.ts
+
 node_modules/
-test.js
+dist/*.map
+dist/out/
+dist/*.css
+.build.json

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "adpyke.vscode-userscript",
+    "dbaeumer.vscode-eslint",
+    "fabiospampinato.vscode-highlight"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,44 @@
+{
+  "javascript.preferences.importModuleSpecifier": "relative",
+  "search.exclude": {
+    "**/BetterYTM.user.js": true,
+  },
+  "files.associations": {
+    "*.env": "dotenv",
+    "*.env.template": "dotenv",
+  },
+
+  // requires extension: fabiospampinato.vscode-highlight
+  "highlight.regexes": {
+    "(TODO(\\((\\s|\\d|\\w|[,.-_+*&])+\\))?:?)": { // TODO: or TODO or TODO(xy): but not todo or todo:
+      "backgroundColor": "#ed0",
+      "color": "black",
+      "overviewRulerColor": "#ed0"
+    },
+    "(#MARKER)": { // #MARKER test
+      "backgroundColor": "#c31",
+      "color": "#fff",
+      "isWholeLine": true,
+      "overviewRulerColor": "#c31"
+    },
+    "(#SECTION ([^\\S\\r\\n]*[\\w,.\\-_&]+)*[:]*)": { // #SECTION test, 123 & foo
+      "backgroundColor": "#44f",
+      "color": "white",
+      "overviewRulerColor": "#44f"
+    },
+    "(#?(DEBUG|DBG)#?)": { // #DEBUG or DEBUG or #DBG or #DBG#
+      "backgroundColor": "#ff0",
+      "color": "blue",
+      "overviewRulerColor": "#ff0"
+    },
+    "(IMPORTANT:)": { // IMPORTANT:
+      "backgroundColor": "#a22",
+      "color": "#fff"
+    },
+    "(FIXME:)": { // FIXME:
+      "backgroundColor": "#a22",
+      "color": "#fff",
+      "overviewRulerColor": "#752020"
+    }
+  },
+}