Wire oxfmt formatting checks

Author: raub

.github/workflows/lint.yml

@@ -32,5 +32,8 @@ jobs:
       - name: Install Modules
         run: npm ci
 
+      - name: Run Format Check
+        run: npm run format:ci
+
       - name: Run Lint
         run: npm run lint:all

oxfmt.config.ts

@@ -0,0 +1 @@
+export { default } from '@node-3d/addon-tools/oxfmt';

oxlint.config.ts

@@ -1,3 +1 @@
-import sharedConfig from '@node-3d/addon-tools/oxlint';
-
-export default sharedConfig;
+export { default } from '@node-3d/addon-tools/oxlint';

package.json

@@ -35,7 +35,9 @@
 		"build:ci": "rslib build",
 		"build:watch": "rslib build --watch",
 		"lint:ts": "tsgo -p tsconfig.json --noEmit",
-		"prepare": "npm run build:ci"
+		"prepare": "npm run build:ci",
+		"format:ts": "oxfmt -c ./oxfmt.config.ts --no-error-on-unmatched-pattern \"**/*.{js,jsx,ts,tsx}\"",
+		"format:ci": "oxfmt -c ./oxfmt.config.ts --check --no-error-on-unmatched-pattern \"**/*.{js,jsx,ts,tsx}\""
 	},
 	"repository": {
 		"type": "git",

ts/bmp.ts

@@ -19,52 +19,52 @@ export const createBmpFromPixels = (
 	const bmpSize = HEADER_SIZE + memSize;
 	const fakeBmp = Buffer.allocUnsafeSlow(bmpSize);
 	let pos = 0;
-	
+
 	fakeBmp.write('BM', pos, 2, 'ascii');
 	pos += 2;
-	
+
 	fakeBmp.writeUInt32LE(bmpSize, pos);
 	pos += 4;
-	
+
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(HEADER_SIZE, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(DIB_SIZE, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeInt32LE(width, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeInt32LE(height, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt16LE(1, pos);
 	pos += 2;
-	
+
 	fakeBmp.writeUInt16LE(bpp, pos);
 	pos += 2;
-	
+
 	fakeBmp.writeUInt32LE(0, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(memSize, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(SOME_BYTES, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(SOME_BYTES, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(0, pos);
 	pos += 4;
-	
+
 	fakeBmp.writeUInt32LE(0, pos);
 	pos += 4;
-	
+
 	pixels.copy(fakeBmp, pos);
-	
+
 	return fakeBmp;
 };

ts/image.test.ts

@@ -24,9 +24,8 @@ const props = [
 
 const methods = ['on', 'save', 'drawImage'] as const;
 
-const testDataPath = (name: string): string => (
-	path.resolve(import.meta.dirname, '..', 'examples', 'assets', name)
-);
+const testDataPath = (name: string): string =>
+	path.resolve(import.meta.dirname, '..', 'examples', 'assets', name);
 
 const loadImageAsync = async (name: string): Promise<Image> => {
 	const image = new Image();
@@ -90,7 +89,9 @@ describe('Image', () => {
 		const image = new Image();
 
 		const that = await new Promise((res, rej) => {
-			image.addEventListener('load', function onLoad(this: Image) { res(this); });
+			image.addEventListener('load', function onLoad(this: Image) {
+				res(this);
+			});
 			image.addEventListener('error', rej);
 			image.src = testDataPath('freeimage.jpg');
 		});
@@ -102,7 +103,9 @@ describe('Image', () => {
 		const image = await loadImageAsync('freeimage.jpg');
 
 		const that = await new Promise((res, rej) => {
-			image.addEventListener('load', function onLoad(this: Image) { res(this); });
+			image.addEventListener('load', function onLoad(this: Image) {
+				res(this);
+			});
 			image.addEventListener('error', rej);
 		});
 
@@ -113,7 +116,9 @@ describe('Image', () => {
 		const image = new Image();
 
 		const that = await new Promise((res, rej) => {
-			image.on('load', function onLoad(this: Image) { res(this); });
+			image.on('load', function onLoad(this: Image) {
+				res(this);
+			});
 			image.on('error', rej);
 			image.src = testDataPath('freeimage.jpg');
 		});
@@ -125,7 +130,9 @@ describe('Image', () => {
 		const image = await loadImageAsync('freeimage.jpg');
 
 		const that = await new Promise((res, rej) => {
-			image.on('load', function onLoad(this: Image) { res(this); });
+			image.on('load', function onLoad(this: Image) {
+				res(this);
+			});
 			image.on('error', rej);
 		});
 
@@ -136,7 +143,9 @@ describe('Image', () => {
 		const image = new Image();
 
 		const that = await new Promise((res, rej) => {
-			image.once('load', function onLoad(this: Image) { res(this); });
+			image.once('load', function onLoad(this: Image) {
+				res(this);
+			});
 			image.once('error', rej);
 			image.src = testDataPath('freeimage.jpg');
 		});
@@ -148,7 +157,9 @@ describe('Image', () => {
 		const image = await loadImageAsync('freeimage.jpg');
 
 		const that = await new Promise((res, rej) => {
-			image.once('load', function onLoad(this: Image) { res(this); });
+			image.once('load', function onLoad(this: Image) {
+				res(this);
+			});
 			image.once('error', rej);
 		});
 

ts/image.ts

@@ -56,13 +56,13 @@ export class Image extends NativeImage {
 	}
 
 	/** Has the underlying native image object been destroyed? */
-	public declare readonly isDestroyed: boolean;
+	declare public readonly isDestroyed: boolean;
 
 	/** Image width in pixels, or `0` before an image is loaded. */
-	public declare readonly width: number;
+	declare public readonly width: number;
 
 	/** Image height in pixels, or `0` before an image is loaded. */
-	public declare readonly height: number;
+	declare public readonly height: number;
 
 	/** Is the image fully loaded? */
 	public get complete(): boolean {
@@ -143,14 +143,14 @@ export class Image extends NativeImage {
 	}
 
 	/** Save the image to a file. Returns `false` if there is no image to save. */
-	public declare save: (dest: string) => boolean;
+	declare public save: (dest: string) => boolean;
 
 	/**
 	 * Draw another image onto this one.
 	 *
 	 * The overloads follow the browser canvas `drawImage()` argument forms.
 	 */
-	public declare drawImage: {
+	declare public drawImage: {
 		(image: Image, dx: number, dy: number): void;
 		(image: Image, dx: number, dy: number, dWidth: number, dHeight: number): void;
 		(
@@ -336,9 +336,9 @@ export class Image extends NativeImage {
 	// Decode data URI payloads before handing bytes to the native decoder.
 	private loadDataUri(src: string): void {
 		const [head = '', body = ''] = src.split(',', 2);
-		const data = head.includes('base64') ?
-			Buffer.from(body, 'base64') :
-			Buffer.from(decodeURIComponent(body));
+		const data = head.includes('base64')
+			? Buffer.from(body, 'base64')
+			: Buffer.from(decodeURIComponent(body));
 
 		this._load(data);
 	}

ts/native.ts

@@ -1,3 +1,4 @@
+// oxlint-disable typescript/method-signature-style
 import { createRequire } from 'node:module';
 import { getBin } from '@node-3d/addon-tools';
 import '@node-3d/segfault';