Merge pull request #299 from cobbler/feature/enable-prettier

Feature: Enable prettier

.eslintrc.json

@@ -1,18 +1,11 @@
 {
   "root": true,
-  "ignorePatterns": [
-    "projects/**/*"
-  ],
+  "ignorePatterns": ["projects/**/*"],
   "overrides": [
     {
-      "files": [
-        "*.ts"
-      ],
+      "files": ["*.ts"],
       "parserOptions": {
-        "project": [
-          "tsconfig.json",
-          "e2e/tsconfig.json"
-        ],
+        "project": ["tsconfig.json", "e2e/tsconfig.json"],
         "createDefaultProgram": true
       },
       "extends": [
@@ -45,12 +38,8 @@
       }
     },
     {
-      "files": [
-        "*.html"
-      ],
-      "extends": [
-        "plugin:@angular-eslint/template/recommended"
-      ],
+      "files": ["*.html"],
+      "extends": ["plugin:@angular-eslint/template/recommended", "prettier"],
       "rules": {}
     }
   ]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ['bug']
-assignees: ''
-
+title: ""
+labels: ["bug"]
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ['enhancement']
-assignees: ''
-
+title: ""
+labels: ["enhancement"]
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/labeler.yml

@@ -1,22 +1,22 @@
 API-Client:
-- projects/cobbler-api/*
-- projects/cobbler-api/**/*
+  - projects/cobbler-api/*
+  - projects/cobbler-api/**/*
 
 Frontend:
-- projects/cobbler-frontend/*
-- projects/cobbler-frontend/**/*
+  - projects/cobbler-frontend/*
+  - projects/cobbler-frontend/**/*
 
 TS-XMLRPC:
-- projects/typescript-xmlrpc/*
-- projects/typescript-xmlrpc/**/*
+  - projects/typescript-xmlrpc/*
+  - projects/typescript-xmlrpc/**/*
 
 documentation:
-- docs-additional/*
-- docs-additional/**/*
+  - docs-additional/*
+  - docs-additional/**/*
 
 tests:
-- '*.spec.ts'
+  - "*.spec.ts"
 
 dependencies:
-- package.json
-- package-lock.json
+  - package.json
+  - package-lock.json

.github/workflows/codeql-analysis.yml

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '34 17 * * 4'
+    - cron: "34 17 * * 4"
 
 jobs:
   analyze:
@@ -32,39 +32,39 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://git.io/codeql-language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      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
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        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
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3

.github/workflows/container-build-push.yml

@@ -4,7 +4,7 @@ name: Create and publish a Docker image
 
 on:
   push:
-    branches: ['main']
+    branches: ["main"]
 
 env:
   REGISTRY: ghcr.io

.github/workflows/coverage-upload.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       # https://github.com/actions/github-script
       # Based on: https://github.com/orgs/community/discussions/34652
-      - name: 'Download artifact'
+      - name: "Download artifact"
         uses: actions/github-script@v7
         with:
           script: |
@@ -52,24 +52,24 @@ jobs:
             fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/coverage-report-xmlrpc.zip`, Buffer.from(downloadXmlRpc.data));
             fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/coverage-report-api.zip`, Buffer.from(downloadApi.data));
             fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/coverage-report-frontend.zip`, Buffer.from(downloadFrontend.data));
-      - name: 'Create folder structure'
+      - name: "Create folder structure"
         run: |
           mkdir -p coverage/typescript-xmlrpc
           mkdir -p coverage/cobbler-api
           mkdir -p coverage/cobbler-frontend
-      - name: 'Unzip typescript-xmlrpc artifact'
+      - name: "Unzip typescript-xmlrpc artifact"
         run: |
           unzip coverage-report-xmlrpc.zip
           mv lcov.info coverage/typescript-xmlrpc
-      - name: 'Unzip cobbler-api artifact'
+      - name: "Unzip cobbler-api artifact"
         run: |
           unzip coverage-report-api.zip
           mv lcov.info coverage/cobbler-api
-      - name: 'Unzip cobbler-frontend artifact'
+      - name: "Unzip cobbler-frontend artifact"
         run: |
           unzip coverage-report-frontend.zip
           mv lcov.info coverage/cobbler-frontend
-      - name: 'Show filetree'
+      - name: "Show filetree"
         run: |
           sudo apt-get install -y tree
           tree

.github/workflows/docs.yml

@@ -2,9 +2,9 @@ name: Docs
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   build:
@@ -30,7 +30,7 @@ jobs:
           name: documentation
           path: documentation
   deploy:
-    name : Deploy 🚀
+    name: Deploy 🚀
     needs: [build]
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest

.github/workflows/labeler.yml

@@ -9,7 +9,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/labeler@v4
+      - uses: actions/labeler@v5
         with:
           sync-labels: true
           repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/lint.yml

@@ -2,18 +2,39 @@ name: Linter
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 # Always use latest Node.js version!
 
 jobs:
+  lint-prettier:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install deps
+        run: npm install
+      - name: Lint with prettier
+        run: npx prettier . --check
   lint-lib-xmlrpc:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ 18.x ]
+        node-version: [18.x]
     steps:
       - uses: actions/checkout@v4
       - name: Node ${{ matrix.node-version }}
@@ -34,7 +55,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ 18.x ]
+        node-version: [18.x]
     steps:
       - uses: actions/checkout@v4
       - name: Node ${{ matrix.node-version }}
@@ -55,7 +76,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ 18.x ]
+        node-version: [18.x]
     steps:
       - uses: actions/checkout@v4
       - name: Node ${{ matrix.node-version }}

.github/workflows/testing.yml

@@ -2,9 +2,9 @@ name: Tests
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 # Always use latest Node.js version!
 
@@ -97,7 +97,7 @@ jobs:
           path: coverage/cobbler-frontend/lcov.info
           if-no-files-found: error
   e2e-cobbler-frontend:
-    if: ${{ false }}  # disable for now; we don't have e2e tests currently
+    if: ${{ false }} # disable for now; we don't have e2e tests currently
     runs-on: ubuntu-latest
     container:
       image: timbru31/node-chrome

.gitpod.yml

@@ -5,5 +5,3 @@
 tasks:
   - init: npm install && npm run build
     command: npm run start
-
-

.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+coverage
+dist
+node_modules

.prettierrc

@@ -0,0 +1 @@
+{}