Several improvements (#48)

- Adding our usual editor config
- Adding linting for test files
- Adding prettier (and appliying it)
- Adding prettier to eslint
- Removing the license information from the PR template file (it's annoying to have this in github when opening a PR)
- Adjusting the workflow files to other projects
- Adding Jetbrains Copyright configuration
- Pinning dev dependencies
- Adding yarn berry
- Adding a yarn.lock so renovate can work

Signed-off-by: Tilman Vatteroth <[email protected]>

.eslintrc.json

@@ -0,0 +1,36 @@
+/*
+ * SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": [
+      "./tsconfig.json"
+    ]
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "jest",
+    "prettier"
+  ],
+  "env": {
+    "jest": true,
+    "jest/globals": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": "error",
+    "jest/no-disabled-tests": "warn",
+    "jest/no-focused-tests": "error",
+    "jest/no-identical-title": "error",
+    "jest/prefer-to-have-length": "warn",
+    "jest/valid-expect": "error"
+  }
+}

.github/pull_request_template.md

@@ -1,9 +1,3 @@
-<!--
-SPDX-FileCopyrightText: 2020 The HedgeDoc developers (see AUTHORS file)
-
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
 ### Description
 This PR fixes/adds/improves/...
 

.github/workflows/lint.yml

@@ -1,14 +1,14 @@
-# SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+# SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
 #
 # SPDX-License-Identifier: AGPL-3.0-only
 
-name: lint
+name: Lint and check code style
 
 on:
   push:
-    branches: [main]
+    branches: [ main ]
   pull_request:
-    branches: [main]
+    branches: [ main ]
 
 jobs:
   lint:
@@ -20,50 +20,24 @@ jobs:
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
+        run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
 
-      - name: Cache node_modules
-        uses: actions/cache@v3
+      - name: Cache yarn cache
+        uses: actions/cache@v3.0.4
         id: yarn-cache
         with:
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-16-yarn-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-18-yarn-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            ${{ runner.os }}-yarn-
+            ${{ runner.os }}-yarn-18
 
       - name: Set up NodeJS
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile --prefer-offline
-      - name: Lint code
-        run: yarn lint
-  format:
-    runs-on: ubuntu-latest
-    name: Checks codestyle of all .ts and .tsx files
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
+          node-version: 18
 
-      - name: Cache node_modules
-        uses: actions/cache@v3
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-16-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
-      - name: Set up NodeJS
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
       - name: Install dependencies
-        run: yarn install --frozen-lockfile --prefer-offline
+        run: yarn install --immutable
+
       - name: Lint code
-        run: yarn format
+        run: yarn lint

.github/workflows/reuse.yml

@@ -1,10 +1,14 @@
-# SPDX-FileCopyrightText: 2020 The HedgeDoc developers (see AUTHORS file)
+# SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
 #
 # SPDX-License-Identifier: AGPL-3.0-only
 
 name: REUSE Compliance Check
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
 
 jobs:
   reuse:

.github/workflows/main.yml → .github/workflows/test.yml

@@ -18,24 +18,30 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
-      - name: Cache node_modules
+
+      - name: Cache yarn cache
         uses: actions/cache@v3
         id: yarn-cache
         with:
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-16-yarn-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-18-yarn-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            ${{ runner.os }}-yarn-
+            ${{ runner.os }}-yarn-18
+
       - name: Set up NodeJS
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
+
       - name: Install dependencies
-        run: yarn install --frozen-lockfile --prefer-offline
+        run: yarn install --immutable
+
       - name: Build project
         run: yarn build
-      - name: Test project
+
+      - name: Test Project
         run: yarn test

.gitignore

@@ -1,10 +1,24 @@
-# SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+# SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
 #
 # SPDX-License-Identifier: CC0-1.0
 
-npm-debug.log
-.idea
-node_modules
 dist/
 coverage/
-lib/
+lib/
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+
+# package manager
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# IDE
+.idea
+!.idea/copyright

.npmignore.license

@@ -1,3 +1,3 @@
-SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
 
-SPDX-License-Identifier: CC0-1.0
+SPDX-License-Identifier: CC0-1.0

.prettierignore

@@ -0,0 +1 @@
+node_modules/

.prettierignore.license

@@ -0,0 +1,4 @@
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+
+SPDX-License-Identifier: CC0-1.0
+

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "parser": "typescript",
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "semi": false,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "bracketSameLine": true,
+  "arrowParens": "always"
+}

.prettierrc.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+
+SPDX-License-Identifier: CC0-1.0

.reuse/dep5

@@ -3,3 +3,14 @@ Upstream-Name: html-to-react
 Upstream-Contact: The HedgeDoc developers <[email protected]>
 Source: https://github.com/hedgedoc/html-to-react
 
+Files: .github/pull_request_template.md
+Copyright: 2022 The HedgeDoc developers (see AUTHORS file)
+License: CC-BY-SA-4.0
+
+Files: .yarn/**
+Copyright: Yarn contributors
+License: LicenseRef-yarn
+
+Files: .idea/**
+Copyright: 2022 The HedgeDoc developers (see AUTHORS file)
+License: CC0-1.0

.yarnrc.yml

@@ -0,0 +1,3 @@
+yarnPath: .yarn/releases/yarn-3.2.1.cjs
+nodeLinker: node-modules
+

.yarnrc.yml.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+
+SPDX-License-Identifier: CC0-1.0

CHANGELOG.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
 
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->

LICENSES/LicenseRef-yarn.txt

@@ -0,0 +1,26 @@
+BSD 2-Clause License
+
+For Yarn software
+
+Copyright (c) 2016-present, Yarn Contributors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
 
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->

jest.config.json

@@ -0,0 +1,14 @@
+{
+  "transform": {
+    ".(ts|tsx)": "ts-jest"
+  },
+  "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx)$",
+  "testPathIgnorePatterns": [
+    "/dist/"
+  ],
+  "moduleFileExtensions": [
+    "ts",
+    "tsx",
+    "js"
+  ]
+}

jest.config.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+
+SPDX-License-Identifier: CC0-1.0