root = true

[*]

charset = utf-8

end_of_line = lf

indent_size = 2

indent_style = tab

insert_final_newline = true

trim_trailing_whitespace = true

[*.yaml]

indent_style = space

extends: ../.markdownlint.yaml

first-line-heading: false

* @NatoBoram

github:

- NatoBoram

patreon: NatoBoram

custom:

- https://paypal.me/NatoBoram/5

- Avoid `else` by using early `return` or new functions.

- Avoid classes unless they implement a shared behaviour or hide a private state.

- Avoid function-wide scopes, particularly `try`/`catch` and `if`. Instead, make a separate function for its inner scope and have its parent handle the conditions and error handlings.

- Avoid nesting by using early `return` or new functions.

- If a block of code is so complex that it has a paragraph to explain it, move it to a separate function.

- If a method does not use `this`, move it outside the class.

- Instead of using `let`, use `const` and make a function that directly gives the correct value.

- Make all interfaces `readonly`.

- Never use `any`.

- Never use `as`.

- Never use `enum`; replace them by objects with a `const` assertion and export its values as a type alias.

- Never use Hungarian notation.

- Never use tuples; replace them by interfaces.

- Prefer passing around the original object such as `Date` and `URL` instead of serializing it.

- Remove comments that are just repeating the next line. The same goes for `@params` and `@returns` in JSDoc.

- When a comment precedes a declaration, turn it to a TSDoc when that makes sense.

version: 2

updates:

- package-ecosystem: npm

directory: /

schedule:

interval: monthly

timezone: America/Toronto

commit-message:

prefix: "⬆️ "

groups:

patch:

update-types:

- patch

minor-development:

update-types:

- minor

dependency-type: development

minor-production:

update-types:

- minor

dependency-type: production

eslint:

patterns:

- "*eslint*"

prettier:

patterns:

- "*prettier*"

typescript:

patterns:

- "*typescript*"

- tsx

- typedoc

- package-ecosystem: github-actions

directory: /

schedule:

interval: monthly

timezone: America/Toronto

commit-message:

prefix: "⬆️ "

name: Docker CI

on:

pull_request:

branches:

- main

merge_group:

branches:

- main

push:

branches:

- main

tags:

- v*

jobs:

docker:

runs-on: ubuntu-latest

if: github.actor != 'nektos/act'

permissions:

packages: write

contents: read

steps:

- uses: actions/checkout@v4

- uses: docker/login-action@v3

if: github.actor != 'dependabot[bot]'

with:

username: ${{ vars.DOCKER_USERNAME }}

password: ${{ secrets.DOCKER_PASSWORD }}

- uses: docker/login-action@v3

if: github.actor != 'dependabot[bot]'

with:

registry: ghcr.io

username: ${{ github.actor }}

password: ${{ secrets.GITHUB_TOKEN }}

- id: meta

uses: docker/metadata-action@v5

with:

images: |

tags: |

- uses: docker/build-push-action@v6

with:

context: .

push: ${{ github.ref_type == 'tag' }}

tags: ${{ steps.meta.outputs.tags }}

labels: ${{ steps.meta.outputs.labels }}