chore: sets up lerna monorepo

jmcdo29 · Mar 25, 2020 · 463e496 · 463e496
1 parent ae80e53
commit 463e496
Show file tree

Hide file tree

Showing 39 changed files with 37,469 additions and 2,187 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -24,9 +24,10 @@ module.exports = {
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/interface-name-prefix': 'off',
   },
-  ignorePatterns: ['*.d.ts', 'dist/*'],
+  ignorePatterns: ['*.d.ts', 'dist/*', 'packages/**/node_modules/*'],
   globals: {
     WeakSet: 'readonly',
     Promise: 'readonly',
+    Reflect: 'readonly'
   },
 };
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 # compiled output
-packages/*/lib/
+lib/
 node_modules/
 *.buildinfo
 

diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# @Omga
+
+Ogma is a simple, no-nonsense logger developed to make logging simple, and easy to read in development, while also having a powerful JSON form when it comes to production level logs, to make it easier to parse and consume by external services. This monorepo has all of the code for the base logger, the binary to rehydrate the JSON logs, and the [NestJS Module](https://nestjs.com) along with supported plugins for the module's interceptor. 
+
+## Packages
+
+| Package | Description |
+| - | - |
+| @ogma/logger | The base logger package that has the core implementation. Can be used from anything, does not need to be NestJS. Also contains the ogma binary fro log rehydration |
+| @ogma/nestjs-module | The core module package that sets up the `OgmaService` and `OgmaInterceptor`, with built-in support for [Express](https://expressjs.com) |
+| @ogma/platform-fastify | An HTTP plugin to properly log [Fastify](https://www.fastify.io/) requests |
+| @ogma/platform-graphql | An HTTP/GQL plugin to properly log [GraphQL](https://www.apollographql.com/docs/) requests using the Express server |
+| @ogma/platform-graphql-fastify | An HTTP/GQL plugin to properly log [GraphQL](https://www.apollographql.com/docs/) requests using the Fastify server |
+| @ogma/platform-socket.io | A Gateway plugin to properly log [Socket.io](https://socket.io) requests |
+| @ogma/platform-ws | A Gateway plguin to properly log [WS](https://github.com/websockets/ws) requests |
+| @ogma/platform-tcp | A microservice plugin to properly log [TCP](https://docs.nestjs.com/microservices/basics) requests |
+| @ogma/platform-kafka | A microservice plugin to properly log [Kafka](https://docs.nestjs.com/microservices/kafka) requests |
+| @ogma/platform-mqtt | A microservice plugin to properly log [MQTT](https://docs.nestjs.com/microservices/mqtt) requests|
+| @ogma/platform-nats | A microservice plugin to properly log [NATS](https://docs.nestjs.com/microservices/nats) requests |
+| @ogma/platform-rabbitmq | A microservice plugin to properly log [RabbitMQ](https://docs.nestjs.com/microservices/rabbitmq) requests |
+| @ogma/platform-grpc | A microservice plugin to properly log [gRC](https://docs.nestjs.com/microservices/gRPC) requests |
+| @ogma/platform-redis | A microservice plugin to properly log [Redis](https://docs.nestjs.com/microservices/redis) requests |
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -22,7 +22,27 @@ module.exports = {
     'scope-enum': [
       2,
       'always',
-      ['service', 'module', 'interceptor', 'deps', 'docs', 'release'],
+      [
+        'logger',
+        'service',
+        'module',
+        'interceptor',
+        'deps',
+        'docs',
+        'release',
+        'socket.io',
+        'fastify',
+        'ws',
+        'tcp',
+        'kafka',
+        'gql',
+        'gql-fastify',
+        'grpc',
+        'mqtt',
+        'nats',
+        'rmq',
+        'redis',
+      ],
     ],
   },
 };
diff --git a/lerna.json b/lerna.json
@@ -1,6 +1,6 @@
 {
   "packages": ["packages/*"],
-  "version": "independent",
+  "version": "0.1.0",
   "command": {
     "publish": {
       "conventionalCommits": true