Merge branch 'main' into feat/lifecycle-api

.devcontainer/devcontainer.json

@@ -1,27 +1,25 @@
 {
-	"image": "mcr.microsoft.com/vscode/devcontainers/base:ubuntu-20.04",
-	"settings": {
-		"[typescript]": {
-			"editor.defaultFormatter": "esbenp.prettier-vscode",
-			"editor.formatOnSave": true
-		},
-		"[typescriptreact]": {
-			"editor.defaultFormatter": "esbenp.prettier-vscode",
-			"editor.formatOnSave": true
-		},
-		"[markdown]": {
-			"editor.wordWrap": "on"
-		}
-	},
-	"extensions": [
-		"esbenp.prettier-vscode"
-	],
-	"forwardPorts": [3000],
-	"postCreateCommand": ["yarn", "install"],
-	"waitFor": "postCreateCommand",
-	"features": {
-		"node": {
-			"version": "18"
-		}
-	}
+  "image": "mcr.microsoft.com/vscode/devcontainers/base:ubuntu-20.04",
+  "settings": {
+    "[typescript]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode",
+      "editor.formatOnSave": true
+    },
+    "[typescriptreact]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode",
+      "editor.formatOnSave": true
+    },
+    "[markdown]": {
+      "editor.wordWrap": "on"
+    }
+  },
+  "extensions": ["esbenp.prettier-vscode"],
+  "forwardPorts": [3000],
+  "postCreateCommand": ["pnpm", "install"],
+  "waitFor": "postCreateCommand",
+  "features": {
+    "node": {
+      "version": "20"
+    }
+  }
 }

.editorconfig

@@ -1,18 +1,10 @@
 root = true
 
 [*]
-insert_final_newline = true
 charset = utf-8
 end_of_line = lf
 indent_style = space
-
-[*.{ts,md,mdx,css,json,yml}]
 indent_size = 2
-tab_width = 2
-
-[*.{ts,mdx,css,json,yml}]
+max_line_length = 100
+insert_final_newline = true
 trim_trailing_whitespace = true
-
-[*.md]
-trim_trailing_whitespace = false
-

.github/workflows/format.yml

@@ -0,0 +1,26 @@
+name: "Format check"
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  format:
+    # run on all push events or on PR syncs not from the same repo
+    if: github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Check format
+        run: pnpm run format:check

.github/workflows/spellcheck.yml

@@ -14,6 +14,4 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Spell check
-        uses: crate-ci/[email protected]
-        with:
-          config: ./.typos.toml
+        uses: crate-ci/[email protected]

.gitignore

@@ -6,13 +6,5 @@
 .cache-loader
 .DS_Store
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
 .pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
 /.meta

.prettierignore

@@ -1,10 +1,6 @@
-/.docusaurus
-/.vscode
-/.yarn
-/build
-/node_modules
-/.pnp*
-/*.js
-/*.js.map
-/config/*.js
-/.meta
+pnpm-lock.yaml
+docs/versioned
+*.md
+*.mdx
+!README.md
+!CONTRIBUTING.md

.prettierrc.json

@@ -1,12 +1,6 @@
 {
-  "printWidth": 100,
-  "proseWrap": "always",
-  "overrides": [
-    {
-      "files": "*.md",
-      "options": {
-        "parser": "mdx"
-      }
-    }
-  ]
+  "arrowParens": "always",
+  "singleQuote": false,
+  "semi": true,
+  "trailingComma": "es5"
 }

.typos.toml

@@ -1,5 +1,8 @@
 [files]
-extend-exclude = ["docs/versioned"] # don't check ./docs/versioned
+extend-exclude = [
+    "docs/versioned", # old documentation shouldn't be checked
+    "*.json"          # mostly configuration, not worth checking
+]
 
 [default]
 locale = "en-us"
@@ -15,18 +18,25 @@ armour = "armor"
 authorise = "authorize"
 authorised = "authorized"
 authorising = "authorizing"
+behaviour = "behavior"
+capitalise = "capitalize"
 catalogue = "catalog"
 centre = "center"
 civilisation = "civilization"
 civilised = "civilized"
 colour = "color"
 colours = "colors"
 defence = "defense"
+generalise = "generalize"
+generalised = "generalized"
 gramme = "gram"
 grammes = "grams"
 grey = "gray"
 honour = "honor"
 honours = "honors"
+initialise = "initialize"
+initialised = "initialized"
+initialiser = "initializer"
 kerb = "curb"
 kerbs = "curbs"
 labour = "labor"
@@ -40,6 +50,9 @@ modelled = "modeled"
 neighbour = "neighbor"
 neighbours = "neighbors"
 neighbouring = "neighboring"
+optimise = "optimize"
+optimised = "optimized"
+optimisation = "optimization"
 organisation = "organization"
 organise = "organize"
 organised = "organized"
@@ -65,3 +78,11 @@ regionise = "regionize"
 regioniser = "regionizer"
 regionising = "regionizing"
 regionised = "regionized"
+
+# exceptions:
+
+# use British spelling to stay consistent with Bukkit
+canceled = "cancelled"
+canceling = "cancelling"
+cancelable = "cancellable"
+cancelation = "cancellation"