Replace Prettier with Biome

.github/workflows/ci.yml

@@ -24,8 +24,8 @@ jobs:
           node-version-file: ".nvmrc"
       - run: npm install -g yarn@^1.19.0 && yarn install
 
-      - name: Check formatting with prettier
-        run: yarn prettier-check
+      - name: Check formatting
+        run: yarn format-check
 
       - name: Build TerriaJS tests
         run: yarn gulp lint release --continue

.gitignore

@@ -1,4 +1,3 @@
-# Update .prettierignore whenever this file changes
 docs/
 node_modules/
 .idea/

biome.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true,
+    "defaultBranch": "main"
+  },
+  "files": { "ignoreUnknown": false, "ignore": [] },
+  "formatter": {
+    "enabled": true,
+    "useEditorconfig": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 80,
+    "attributePosition": "auto",
+    "bracketSpacing": true,
+    "ignore": [
+      "./wwwroot/data/regionids/*",
+      "**/yarn.lock",
+      "**/*.scss.d.ts",
+      "./wwwroot/third_party/*",
+      "doc/acknowledgements/attributions.md",
+      "./wwwroot/test/init/sdmx-abs.json"
+    ]
+  },
+  "organizeImports": { "enabled": false },
+  "linter": { "enabled": false, "rules": { "recommended": true } },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "none",
+      "semicolons": "always",
+      "arrowParentheses": "always",
+      "bracketSameLine": false,
+      "attributePosition": "auto",
+      "bracketSpacing": true
+    }
+  },
+  "json": {
+    "parser": {
+      "allowComments": true,
+      "allowTrailingCommas": true
+    }
+  }
+}

lib/Core/TypeConditionals.ts

@@ -31,20 +31,20 @@ export type Or<
 > = [A] extends [true]
   ? true
   : [B] extends [true]
-  ? true
-  : [C] extends [true]
-  ? true
-  : [D] extends [true]
-  ? true
-  : [E] extends [true]
-  ? true
-  : [F] extends [true]
-  ? true
-  : [G] extends [true]
-  ? true
-  : [H] extends [true]
-  ? true
-  : false;
+    ? true
+    : [C] extends [true]
+      ? true
+      : [D] extends [true]
+        ? true
+        : [E] extends [true]
+          ? true
+          : [F] extends [true]
+            ? true
+            : [G] extends [true]
+              ? true
+              : [H] extends [true]
+                ? true
+                : false;
 
 /**
  * Inverts a conditional, changing `true` to `false` and `false` to `true`.

lib/Core/loadBlob.ts

@@ -75,11 +75,11 @@ export function parseZipJsonBlob(blob: Blob): Promise<JsonValue> {
     for (let i = 0; i < entries.length; i++) {
       const entry = entries[i];
       if (isJson(entry.filename)) {
-        return entry
-          .getData(new ZipData64URIWriter())
-          .then(function (uri: string) {
-            return loadJson(uri);
-          });
+        return entry.getData(new ZipData64URIWriter()).then(function (
+          uri: string
+        ) {
+          return loadJson(uri);
+        });
       }
     }
     return undefined;

lib/Map/DragPoints/LeafletDragPoints.js

@@ -79,12 +79,12 @@ LeafletDragPoints.prototype._onMouseDownOnPoint = function (entity) {
     return;
   }
 
-  var dragEntity = this._draggableObjects.entities.values.filter(function (
-    dragObjEntity
-  ) {
-    // Not necessarily same entity, but will have same id.
-    return dragObjEntity.id === entity.id;
-  })[0];
+  var dragEntity = this._draggableObjects.entities.values.filter(
+    function (dragObjEntity) {
+      // Not necessarily same entity, but will have same id.
+      return dragObjEntity.id === entity.id;
+    }
+  )[0];
   if (defined(dragEntity)) {
     // The touch events below don't actually work because Leaflet doesn't
     // expose these events.  See here for a possible workaround:

lib/ModelMixins/ExportWebCoverageServiceMixin.ts

@@ -223,9 +223,8 @@ function ExportWebCoverageServiceMixin<
     }
 
     private async loadWcsCapabilities() {
-      const capabilities = await WebCoverageServiceCapabilitiesStratum.load(
-        this
-      );
+      const capabilities =
+        await WebCoverageServiceCapabilitiesStratum.load(this);
 
       runInAction(() =>
         this.strata.set(

lib/ModelMixins/TileErrorHandlerMixin.ts

@@ -195,8 +195,8 @@ function TileErrorHandlerMixin<T extends AbstractConstructor<ModelType>>(
         return this === (baseMap as any)
           ? true
           : baseMap instanceof CompositeCatalogItem
-          ? baseMap.memberModels.includes(this)
-          : false;
+            ? baseMap.memberModels.includes(this)
+            : false;
       };
       /** End helper methods **/
 

lib/Models/BoxDrawing.ts

@@ -839,8 +839,8 @@ export default class BoxDrawing {
     const normalAxis = planeLocal.normal.x
       ? Axis.X
       : planeLocal.normal.y
-      ? Axis.Y
-      : Axis.Z;
+        ? Axis.Y
+        : Axis.Z;
     const style: Readonly<SideStyle> = {
       fillColor: Color.WHITE.withAlpha(0.1),
       outlineColor: Color.WHITE,
@@ -891,8 +891,8 @@ export default class BoxDrawing {
     const axis = planeLocal.normal.x
       ? Axis.X
       : planeLocal.normal.y
-      ? Axis.Y
-      : Axis.Z;
+        ? Axis.Y
+        : Axis.Z;
 
     const scratchDirection = new Cartesian3();
     const scratchMoveVector = new Cartesian3();

lib/Models/Catalog/CatalogItems/ApiTableCatalogItem.ts

@@ -284,8 +284,8 @@ function getResponseDataPath(data: JsonValue, jsonPath: string) {
     path === ""
       ? data
       : Array.isArray(data)
-      ? _map(data, path)
-      : _get(data, path);
+        ? _map(data, path)
+        : _get(data, path);
   return pathSegments.reduce(
     (nextData, segment) => getPath(nextData, segment),
     data

lib/Models/Catalog/CatalogItems/CogCatalogItem.ts

@@ -44,10 +44,13 @@ class CogLoadableStratum extends LoadableStratum(CogCatalogItemTraits) {
       ? // Warn for 2D mode
         i18next.t("models.commonModelErrors.3dTypeIn2dMode", this)
       : this.model._imageryProvider?.tilingScheme &&
-        // Show warning for experimental reprojection freature if not using EPSG 3857 or 4326
-        isCustomTilingScheme(this.model._imageryProvider?.tilingScheme)
-      ? i18next.t("models.cogCatalogItem.experimentalReprojectionWarning", this)
-      : undefined;
+          // Show warning for experimental reprojection freature if not using EPSG 3857 or 4326
+          isCustomTilingScheme(this.model._imageryProvider?.tilingScheme)
+        ? i18next.t(
+            "models.cogCatalogItem.experimentalReprojectionWarning",
+            this
+          )
+        : undefined;
   }
 
   @computed

lib/Models/Catalog/CatalogItems/MapboxVectorTileCatalogItem.ts

@@ -146,8 +146,7 @@ class MapboxVectorTileCatalogItem extends MappableMixin(
     }
   }
 
-  @computed
-  /** Convert traits into paint rules:
+  @computed /** Convert traits into paint rules:
    * - `layer` and `fillColor`/`lineColor` into simple rules
    * - `parsedJsonStyle`
    */

lib/Models/Catalog/Ckan/CkanItemReference.ts

@@ -67,9 +67,8 @@ export class CkanDatasetStratum extends LoadableStratum(
         ckanItemReference.datasetId !== undefined &&
         ckanItemReference.resourceId !== undefined
       ) {
-        ckanItemReference._ckanDataset = await loadCkanDataset(
-          ckanItemReference
-        );
+        ckanItemReference._ckanDataset =
+          await loadCkanDataset(ckanItemReference);
         ckanItemReference._ckanResource = findResourceInDataset(
           ckanItemReference._ckanDataset,
           ckanItemReference.resourceId
@@ -81,9 +80,8 @@ export class CkanDatasetStratum extends LoadableStratum(
         ckanItemReference.datasetId !== undefined &&
         ckanItemReference.resourceId === undefined
       ) {
-        ckanItemReference._ckanDataset = await loadCkanDataset(
-          ckanItemReference
-        );
+        ckanItemReference._ckanDataset =
+          await loadCkanDataset(ckanItemReference);
         const matched = getSupportedFormats(
           ckanItemReference._ckanDataset,
           ckanItemReference.preparedSupportedFormats
@@ -95,9 +93,8 @@ export class CkanDatasetStratum extends LoadableStratum(
         ckanItemReference.datasetId === undefined &&
         ckanItemReference.resourceId !== undefined
       ) {
-        ckanItemReference._ckanResource = await loadCkanResource(
-          ckanItemReference
-        );
+        ckanItemReference._ckanResource =
+          await loadCkanResource(ckanItemReference);
         ckanItemReference._supportedFormat = isResourceInSupportedFormats(
           ckanItemReference._ckanResource,
           ckanItemReference.preparedSupportedFormats

lib/Models/Catalog/Ows/OwsInterfaces.ts

@@ -42,10 +42,10 @@ export function parseOwsKeywordList(json: any): OwsKeywordList | undefined {
   const Keyword = isJsonString(json.Keyword)
     ? json.Keyword
     : Array.isArray(json.Keyword)
-    ? filterOutUndefined(
-        json.Keyword.map((s) => (isJsonString(s) ? s : undefined))
-      )
-    : [];
+      ? filterOutUndefined(
+          json.Keyword.map((s) => (isJsonString(s) ? s : undefined))
+        )
+      : [];
   return {
     type,
     Keyword

lib/Models/Catalog/Ows/WebFeatureServiceCatalogItem.ts

@@ -264,9 +264,9 @@ export class GetCapabilitiesStratum extends LoadableStratum(
 
     return supportsGeojson
       ? "JSON"
-      : this.capabilities.outputTypes?.find((outputFormat) =>
+      : (this.capabilities.outputTypes?.find((outputFormat) =>
           searchValue.test(outputFormat)
-        ) ?? "gml3";
+        ) ?? "gml3");
   }
 
   /** Finds the best srsName to use.

lib/Models/Catalog/Ows/WebMapServiceCapabilities.ts

@@ -190,7 +190,10 @@ export default class WebMapServiceCapabilities {
     readonly [name: string]: CapabilitiesLayer;
   };
 
-  private constructor(readonly xml: XMLDocument, readonly json: any) {
+  private constructor(
+    readonly xml: XMLDocument,
+    readonly json: any
+  ) {
     this.allLayers = [];
     this.rootLayers = [];
     this.topLevelNamedLayers = [];

lib/Models/Catalog/Ows/WebMapServiceCapabilitiesStratum.ts

@@ -874,8 +874,8 @@ export default class WebMapServiceCapabilitiesStratum extends LoadableStratum(
     const formatsArray = isJsonArray(formats)
       ? formats
       : isJsonString(formats)
-      ? [formats]
-      : [];
+        ? [formats]
+        : [];
 
     if (this.catalogItem.supportsGetTimeseries) {
       return { format: "text/csv", type: "text" };

lib/Models/Catalog/Ows/WebProcessingServiceCapabilities.ts

@@ -123,10 +123,10 @@ function parseServiceIdentification(
   const ServiceTypeVersion = isJsonString(json.ServiceTypeVersion)
     ? [json.ServiceTypeVersion]
     : Array.isArray(json.ServiceTypeVersion)
-    ? filterOutUndefined(
-        json.ServiceTypeVersion.map((s) => (isJsonString(s) ? s : undefined))
-      )
-    : undefined;
+      ? filterOutUndefined(
+          json.ServiceTypeVersion.map((s) => (isJsonString(s) ? s : undefined))
+        )
+      : undefined;
 
   if (
     ServiceType === undefined ||
@@ -174,8 +174,8 @@ function parseProcessOfferings(json: any): Process[] | undefined {
   const processes: any[] = Array.isArray(json.Process)
     ? json.Process
     : isJsonObject(json.Process)
-    ? [json.Process]
-    : [];
+      ? [json.Process]
+      : [];
   const ProcessOfferings = filterOutUndefined(processes.map(parseProcess));
   return ProcessOfferings;
 }

lib/Models/Definition/FlattenedFromTraits.ts

@@ -27,8 +27,8 @@ type FlattenedFromTraits<TDefinition extends ModelTraits> = Complete<{
       ? CopyNull<TDefinition[P], R> | undefined
       : never
     : SingleTrait<TDefinition[P]> extends infer R
-    ? CopyNull<TDefinition[P], R> | undefined
-    : never;
+      ? CopyNull<TDefinition[P], R> | undefined
+      : never;
 }>;
 
 export default FlattenedFromTraits;