chore: add the oxfmt formatter (#1392)

* add a formatter

* change to es5 trailing commas

* change to no trailing commas

* remove flow-specific config

* remove deprecated stylistic eslint checks

* run fmt after merge

* Update .oxfmtrc.jsonc

Author: CommanderStorm

.oxfmtrc.jsonc

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "tabWidth": 4,
+  "singleQuote": true,
+  "bracketSpacing": false,
+  "trailingComma": "none"
+}

bin/gl-style-migrate.ts

@@ -16,4 +16,3 @@ function help() {
     console.log('usage:');
     console.log('  gl-style-migrate style-v7.json > style-v8.json');
 }
-

bin/gl-style-validate.ts

@@ -5,7 +5,7 @@ import rw from 'rw';
 import {validateStyle as validate} from '../src/validate_style';
 
 const argv = minimist(process.argv.slice(2), {
-    boolean: 'json',
+    boolean: 'json'
 });
 
 if (argv.help || argv.h || (!argv._.length && process.stdin.isTTY)) {

build/bump-version-changelog.js

@@ -13,7 +13,8 @@ const changelogPath = 'CHANGELOG.md';
 let changelog = readFileSync(changelogPath, 'utf8');
 changelog = changelog.replace('## main', `## ${process.argv[2]}`);
 changelog = changelog.replaceAll('- _...Add new stuff here..._\n', '');
-changelog = `## main
+changelog =
+    `## main
 
 ### ✨ Features and improvements
 - _...Add new stuff here..._

build/generate-docs.ts

@@ -24,11 +24,7 @@ function jsDocComment(property) {
     if (!lines.length) {
         return undefined;
     }
-    return [
-        '/**',
-        ...lines.map(line => ` * ${line}`),
-        ' */',
-    ].join('\n');
+    return ['/**', ...lines.map((line) => ` * ${line}`), ' */'].join('\n');
 }
 
 function jsDocBlock(tag, value) {
@@ -40,9 +36,11 @@ ${formatJSON(value)}
 
 function unionType(values) {
     if (Array.isArray(values)) {
-        return values.map(v => JSON.stringify(v)).join(' | ');
+        return values.map((v) => JSON.stringify(v)).join(' | ');
     } else {
-        return Object.keys(values).map(v => JSON.stringify(v)).join(' | ');
+        return Object.keys(values)
+            .map((v) => JSON.stringify(v))
+            .join(' | ');
     }
 }
 
@@ -60,7 +58,11 @@ function propertyType(property) {
             case 'enum':
                 return unionType(property.values);
             case 'array': {
-                const elementType = propertyType(typeof property.value === 'string' ? {type: property.value, values: property.values} : property.value);
+                const elementType = propertyType(
+                    typeof property.value === 'string'
+                        ? {type: property.value, values: property.values}
+                        : property.value
+                );
                 if (property.length) {
                     return `[${Array(property.length).fill(elementType).join(', ')}]`;
                 } else {
@@ -104,32 +106,37 @@ function objectDeclaration(key, properties) {
 function objectType(properties, indent) {
     return `{
 ${Object.keys(properties)
-    .filter(k => k !== '*')
-    .flatMap(k => {
+    .filter((k) => k !== '*')
+    .flatMap((k) => {
         const declarations = [propertyDeclaration(k, properties[k])];
         if (properties[k].transition) {
             declarations.push(transitionPropertyDeclaration(k));
         }
         return declarations;
     })
-    .map(declaration => {
+    .map((declaration) => {
         return declaration
             .split('\n')
-            .map(line => `    ${indent}${line}`)
+            .map((line) => `    ${indent}${line}`)
             .join('\n');
     })
     .join(',\n')}
 ${indent}}`;
 }
 
 function sourceTypeName(key) {
-    return key.replace(/source_(.)(.*)/, (_, _1, _2) => `${_1.toUpperCase()}${_2}SourceSpecification`)
+    return key
+        .replace(/source_(.)(.*)/, (_, _1, _2) => `${_1.toUpperCase()}${_2}SourceSpecification`)
         .replace(/_dem/, 'DEM')
         .replace(/Geojson/, 'GeoJSON');
 }
 
 function layerTypeName(key) {
-    return key.split('-').map(k => k.replace(/(.)(.*)/, (_, _1, _2) => `${_1.toUpperCase()}${_2}`)).concat('LayerSpecification').join('');
+    return key
+        .split('-')
+        .map((k) => k.replace(/(.)(.*)/, (_, _1, _2) => `${_1.toUpperCase()}${_2}`))
+        .concat('LayerSpecification')
+        .join('');
 }
 
 function layerType(key) {
@@ -165,9 +172,9 @@ function layerType(key) {
 
 const layerTypes = Object.keys(spec.layer.type.values);
 
-writeFileSync('src/types.g.ts',
+writeFileSync(
+    'src/types.g.ts',
     `// Generated code; do not edit. Edit build/generate-style-spec.ts instead.
-/* eslint-disable */
 
 export type ColorSpecification = string;
 
@@ -394,21 +401,24 @@ ${objectDeclaration('ProjectionSpecification', spec.projection)}
 
 ${objectDeclaration('TerrainSpecification', spec.terrain)}
 
-${spec.source.map(key => {
-    let str = objectDeclaration(sourceTypeName(key), spec[key]);
-    if (sourceTypeName(key) === 'GeoJSONSourceSpecification') {
-        // This is done in order to overcome the type system's inability to express this type:
-        str = str.replace(/unknown/, 'GeoJSON.GeoJSON | string');
-    }
-    return str;
-}).join('\n\n')}
+${spec.source
+    .map((key) => {
+        let str = objectDeclaration(sourceTypeName(key), spec[key]);
+        if (sourceTypeName(key) === 'GeoJSONSourceSpecification') {
+            // This is done in order to overcome the type system's inability to express this type:
+            str = str.replace(/unknown/, 'GeoJSON.GeoJSON | string');
+        }
+        return str;
+    })
+    .join('\n\n')}
 
 export type SourceSpecification =
-${spec.source.map(key => `    | ${sourceTypeName(key)}`).join('\n')}
+${spec.source.map((key) => `    | ${sourceTypeName(key)}`).join('\n')}
 
-${layerTypes.map(key => layerType(key)).join('\n\n')}
+${layerTypes.map((key) => layerType(key)).join('\n\n')}
 
 export type LayerSpecification =
-${layerTypes.map(key => `    | ${layerTypeName(key)}`).join('\n')};
+${layerTypes.map((key) => `    | ${layerTypeName(key)}`).join('\n')};
 
-`);
+`
+);

build/generate-style-spec.ts

@@ -20,18 +20,17 @@ const regex = /^## (\d+\.\d+\.\d+.*?)\n(.+?)(?=\n^## \d+\.\d+\.\d+.*?\n)/gms;
 
 let releaseNotes = [];
 let match;
- 
-while (match = regex.exec(changelog)) {
+
+while ((match = regex.exec(changelog))) {
     releaseNotes.push({
-        'version': match[1],
-        'changelog': match[2].trim(),
+        version: match[1],
+        changelog: match[2].trim()
     });
 }
 
 const latest = releaseNotes[0];
 const previous = releaseNotes[1];
 
-
 //  Print the release notes template.
 
 const templatedReleaseNotes = `https://github.com/maplibre/maplibre-gl-style-spec
@@ -41,5 +40,4 @@ ${latest.changelog}
 
 ${semver.prerelease(latest.version) ? 'Pre-release version' : ''}`;
 
- 
-process.stdout.write(templatedReleaseNotes.trimEnd());
+process.stdout.write(templatedReleaseNotes.trimEnd());

build/release-notes.js

@@ -1,7 +1,7 @@
 import {Plugin} from 'rollup';
 
 function replacer(key: string, value: any) {
-    return (key === 'doc' || key === 'example' || key === 'sdk-support') ? undefined : value;
+    return key === 'doc' || key === 'example' || key === 'sdk-support' ? undefined : value;
 }
 
 export default function minifyStyleSpec(): Plugin {

build/rollup_plugin_minify_style_spec.ts

@@ -2,7 +2,7 @@ import jsonStringify from 'json-stringify-pretty-compact';
 
 /**
  * Formats a JSON value into a reasonably compact and readable JSON string.
- * 
+ *
  * @param obj - object to be formatted
  * @returns formatted JSON
  */