v1.0.0 (#157)

Author: tomer-yechiel

.cspell.json

@@ -1,7 +1,7 @@
 {
   "version": "0.1",
   "language": "en",
-  "words": ["esbuild", "rmrf", "gjuchault", "socio", "octocat"],
+  "words": ["esbuild", "rmrf", "pino-sentry-transport", "socio", "octocat", "pino"],
   "flagWords": [],
   "ignorePaths": [
     "package.json",

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
   - name: GitHub Discussions
-    url: https://github.com/gjuchault/typescript-library-starter/discussions
+    url: https://github.com/tomer-yechiel/pino-sentry-transport/discussions
     about: Please discuss non bug-related topics there

.github/workflows/pino-sentry-transport.yml

@@ -1,15 +1,15 @@
 name: Pino sentry transport
 
 on:
-    push:
-        branches:
-        - main
+  push:
+    branches:
+      - main
 
 env:
   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
 jobs:
-  typescript-library-starter:
+  pino-sentry-transport:
     runs-on: ubuntu-latest
 
     concurrency:
@@ -33,17 +33,15 @@ jobs:
       - name: Lint check
         run: npm run lint:check
 
-#      - name: Spell check
-#        run: npm run spell:check
+      - name: Spell check
+        run: npm run spell:check
 
-#      - name: Test
-#        run: npm run test
-#
-#      - name: Setup test
-#        run: npm run test:setup
+      - name: Test
+        run: npm run test
 
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm run semantic-release
+
+# - name: Release
+#   env:
+#     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#     NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+#   run: npm run semantic-release

.releaserc.json

@@ -14,7 +14,7 @@
       "prerelease": true
     }
   ],
-  "repositoryUrl": "https://github.com/gjuchault/typescript-library-starter.git",
+  "repositoryUrl": "https://github.com/tomer-yechiel/pino-sentry-transport.git",
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-gabriel.juchault@gmail.com.
+tomer.yechiel@gmail.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -16,13 +16,13 @@ Please review our [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you
 
 ## :bulb: Asking Questions
 
-If you have any question that does not relate to a bug or a feature request, please use [GitHub Discussions](https://github.com/gjuchault/typescript-library-starter/discussions) instead of GitHub issues.
+If you have any question that does not relate to a bug or a feature request, please use [GitHub Discussions](https://github.com/tomer-yechiel/pino-sentry-transport/discussions) instead of GitHub issues.
 
 ## :inbox_tray: How can I Contribute?
 
 **GitHub issues**
 
-If you encounter a problem with this library or if you have a new feature you'd like to see in this project, please create [a new issue](https://github.com/gjuchault/typescript-library-starter/issues/new/choose).
+If you encounter a problem with this library or if you have a new feature you'd like to see in this project, please create [a new issue](https://github.com/tomer-yechiel/pino-sentry-transport/issues/new/choose).
 
 **GitHub Pull requests**
 

README.md

@@ -5,10 +5,11 @@
 ![GitHub Workflow Status](https://github.com/tomer-yechiel/pino-sentry-transport/actions/workflows/pino-sentry-transport.yml/badge.svg?branch=main)
 
 This module provides a 'transport' for pino that sends errors to Sentry.
+
 ## Install
 
 ```shell
-npm i pino-sentry-transport
+npm i @sentry/node pino-sentry-transport
 ```
 
 ## usage
@@ -22,7 +23,7 @@ const logger = pino({
     options: {
       sentry: {
         dsn: "https://<key>:<secret>@sentry.io/<project>",
-        // aditional options for sentry
+        // additional options for sentry
       },
       withLogRecord: true, // default false - send the log record to sentry as a context.(if its more then 8Kb Sentry will throw an error)
       tags: ['id'], // sentry tags to add to the event, uses lodash.get to get the value from the log record
@@ -32,4 +33,5 @@ const logger = pino({
   },
 });
 ```
+
 if log contain error, it will send to sentry using captureException if not it will use captureMessage.