feat: add typescript, other improvements

Release-As: 0.1.0

Author: xseman

.github/release-please-config.json

@@ -9,13 +9,14 @@
 		}
 	},
 	"changelog-sections": [
-		{ "type": "build", "section": "Maintenance" },
-		{ "type": "chore", "section": "Maintenance" },
-		{ "type": "ci", "section": "Maintenance" },
-		{ "type": "deps", "section": "Dependency updates" },
-		{ "type": "docs", "section": "Documentation" },
-		{ "type": "style", "section": "Styles" },
-		{ "type": "refactor", "section": "Refactors" },
-		{ "type": "test", "section": "Tests", "hidden": true }
+		{ "section": "Features", "type": "feat" },
+		{ "section": "Dependency updates", "type": "deps" },
+		{ "section": "Documentation", "type": "docs" },
+		{ "section": "Maintenance", "type": "build" },
+		{ "section": "Maintenance", "type": "chore" },
+		{ "section": "Maintenance", "type": "ci" },
+		{ "section": "Refactors", "type": "refactor" },
+		{ "section": "Styles", "type": "style" },
+		{ "section": "Tests", "type": "test", "hidden": true }
 	]
 }

.github/workflows/release-please.yml

@@ -31,6 +31,8 @@ jobs:
 
             - if: ${{ steps.release.outputs.release_created }}
               run: |
+                  npm ci &&
+                  npm run build &&
                   npm publish --provenance --access public
               env:
                   NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1 +1,2 @@
-node_modules
+dist
+node_modules

README.md

@@ -1,8 +1,10 @@
-# Sentry log4js appender
+# log4js appender - Sentry
 
 Sends logging events to Sentry. This appender integrates
 [@sentry/node][sentry_javascript].
 
+[sentry_javascript]: https://github.com/getsentry/sentry-javascript
+
 ## Installation
 
 **npm registry**
@@ -11,63 +13,92 @@ Sends logging events to Sentry. This appender integrates
 npm install log4js-appender-sentry
 ```
 
-## Options
+## Configuration
 
-The [`SentryAppender`][internal_types] interface extends the `NodeClientOptions`
-interface and provides additional options specific to the Node Sentry appender
-SDK.
+### TypeScript
+
+If you're using TypeScript, importing this library as a side effect will
+automatically merge the log4js interface `Appenders`. This merging enables
+autocomplete for the appenders configuration, providing convenient access to its
+properties.
+
+```ts
+import "log4js-appender-sentry";
+```
+
+### Example
+
+```ts
+import log4js from "log4js";
+
+import "log4js-appender-cloudwatch";
+
+log4js.configure({
+	appenders: {
+		sentry: {
+			type: "log4js-appender-sentry",
+			dsn: "<config>",
+			user: {
+				// ...
+			},
+		},
+	},
+	categories: {
+		default: {
+			level: "debug",
+			appenders: [
+				"sentry",
+			],
+		},
+	},
+});
+
+const log = log4js.getLogger();
+// ...
+```
+
+## Options
 
 Sentry is mainly used to report application errors so the default log level is
 `WARN` and above, other log levels will be ignored.
 
-**`type`**
+### type
 
-The type of the appender, must be set to `log4js-appender-sentry`.
+_Required_\
+Type: log4js-appender-sentry
 
-**`dsn`**
+The type of the appender. Must be set to `log4js-appender-sentry`.
 
-A DSN tells a Sentry SDK where to send events so the events are associated with
-the correct project. See [documentation][sentry_dsn].
+### dsn
 
-**`user`**
+_Required_\
+Type: `string`
 
-User data for scope configuration. See [documentation][sentry_user].
+A DSN (Data Source Name) specifies where the Sentry SDK should send events,
+ensuring they are associated with the correct project. Refer to the Sentry
+[documentation][sentry_dsn] for more details on DSN.
 
-## Configuration
+[sentry_dsn]: https://docs.sentry.io/product/sentry-basics/dsn-explainer/
 
-**TypeScript**
+### user
 
-If you're using TypeScript, importing this library as a side effect will
-automatically merge the log4js interface `Appenders`. This merging enables
-autocomplete for the appenders configuration, providing convenient access to its
-properties.
+_Optional_\
+Type: `User`
 
 ```ts
-import "log4js-appender-sentry"
-```
-
-**example**
-
-```json {3-6, 12}
-{
-    "appenders": {
-        "sentry": {
-            "type": "log4js-appender-sentry",
-            "dsn": "..."
-        }
-    },
-    "categories": {
-        "default": {
-            "level": "debug",
-            "appenders": [
-                "sentry"
-            ]
-        }
-    }
+// import { User } from "@sentry/node/types";
+
+interface User {
+	[key: string]: any;
+	id?: string;
+	ip_address?: string;
+	email?: string;
+	username?: string;
+	segment?: string;
 }
 ```
 
-[internal_types]: ./index.d.ts
-[sentry_javascript]: https://github.com/getsentry/sentry-javascript
+User data used for scope configuration. For additional information, see the
+Sentry user [documentation][sentry_user].
+
 [sentry_user]: https://docs.sentry.io/platforms/javascript/enriching-events/identify-user/
-[sentry_dsn]: https://docs.sentry.io/product/sentry-basics/dsn-explainer/

dprint.json

@@ -1,12 +1,18 @@
 {
 	"lineWidth": 100,
 	"useTabs": true,
+	"includes": [
+		"**/*.{ts,mts,js,json,md,yml,yaml}"
+	],
 	"excludes": [
 		"**/node_modules",
-		"**/*-lock.json"
+		"**/*-lock.json",
+		"tsconfig.json",
+		"CHANGELOG.md"
 	],
 	"plugins": [
-		"https://plugins.dprint.dev/typescript-0.88.7.wasm",
-		"https://plugins.dprint.dev/json-0.19.1.wasm"
+		"https://plugins.dprint.dev/typescript-0.89.3.wasm",
+		"https://plugins.dprint.dev/json-0.19.2.wasm",
+		"https://plugins.dprint.dev/markdown-0.16.4.wasm"
 	]
 }

index.js

@@ -0,0 +1,56 @@
+import assert from "node:assert";
+import { describe, test } from "node:test";
+
+import { dummyLayout } from "log4js/lib/layouts";
+import Level from "log4js/lib/levels";
+
+import type { LoggingEvent } from "log4js";
+
+import { sentry } from "./dist";
+
+function makeLogEvent(): LoggingEvent {
+	return {
+		categoryName: "default",
+		startTime: new Date(),
+		data: ["test"],
+		pid: 0,
+		fileName: "",
+		lineNumber: 0,
+		columnNumber: 0,
+		callStack: "",
+		functionName: "",
+		context: null,
+		serialise: () => "",
+		level: new Level(40000, "ERROR", "red"),
+	};
+}
+
+/**
+ * TODO: fetch events from sentry to validate integration
+ * TODO: validate if dsn is valid
+ * TODO: shutdown test
+ */
+describe("Sentry integration", () => {
+	const appender = sentry(
+		{
+			dsn: "<your_token>",
+		},
+		Level,
+		dummyLayout,
+	);
+
+	test("append log", async () => {
+		const logEvent = makeLogEvent();
+
+		assert.doesNotThrow(() => {
+			appender(logEvent);
+		});
+	});
+
+	test("shutdown", () => {
+		assert.doesNotThrow(() => {
+			// @ts-ignore
+			appender.shutdown();
+		});
+	});
+});