chiisai-event-emitter 0.0.0-development

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ryan Sonshine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# Chiisai Event Emitter
+
+A minimal event emitter library for Node.JS.
+
+---
+
+# chiisai-event-emitter
+
+[![npm package][npm-img]][npm-url]
+[![Build Status][build-img]][build-url]
+[![Downloads][downloads-img]][downloads-url]
+[![Issues][issues-img]][issues-url]
+[![Code Coverage][codecov-img]][codecov-url]
+[![Commitizen Friendly][commitizen-img]][commitizen-url]
+[![Semantic Release][semantic-release-img]][semantic-release-url]
+
+> My awesome module
+
+## Install
+
+```bash
+npm install chiisai-event-emitter
+```
+
+## Usage
+
+```ts
+import { myPackage } from 'chiisai-event-emitter';
+
+myPackage('hello');
+//=> 'hello from my package'
+```
+
+## API
+
+### myPackage(input, options?)
+
+#### input
+
+Type: `string`
+
+Lorem ipsum.
+
+#### options
+
+Type: `object`
+
+##### postfix
+
+Type: `string`
+Default: `rainbows`
+
+Lorem ipsum.
+
+[build-img]:https://github.com/ryansonshine/chiisai-event-emitter/actions/workflows/release.yml/badge.svg
+[build-url]:https://github.com/ryansonshine/chiisai-event-emitter/actions/workflows/release.yml
+[downloads-img]:https://img.shields.io/npm/dt/chiisai-event-emitter
+[downloads-url]:https://www.npmtrends.com/chiisai-event-emitter
+[npm-img]:https://img.shields.io/npm/v/chiisai-event-emitter
+[npm-url]:https://www.npmjs.com/package/chiisai-event-emitter
+[issues-img]:https://img.shields.io/github/issues/ryansonshine/chiisai-event-emitter
+[issues-url]:https://github.com/ryansonshine/chiisai-event-emitter/issues
+[codecov-img]:https://codecov.io/gh/ryansonshine/chiisai-event-emitter/branch/main/graph/badge.svg
+[codecov-url]:https://codecov.io/gh/ryansonshine/chiisai-event-emitter
+[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-url]:https://github.com/semantic-release/semantic-release
+[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+[commitizen-url]:http://commitizen.github.io/cz-cli/

package/package.json

@@ -0,0 +1,118 @@
+{
+  "name": "chiisai-event-emitter",
+  "version": "0.0.0-development",
+  "description": "A minimal event emitter.",
+  "main": "./lib/index.js",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf ./lib/",
+    "cm": "cz",
+    "lint": "eslint ./src/ --fix",
+    "prepare": "husky install",
+    "semantic-release": "semantic-release",
+    "test:watch": "jest --watch",
+    "test": "jest --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bencelaszlo/chiisai-event-emitter.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Bence László",
+    "email": "bence@bencelaszlo.hu",
+    "url": "https://bencelaszlo.hu"
+  },
+  "engines": {
+    "node": ">=12.0"
+  },
+  "keywords": [
+    "event",
+    "event-driven",
+    "event-emitter",
+    "minimal",
+    "typescript"
+  ],
+  "bugs": {
+    "url": "https://github.com/bencelaszlo/chiisai-event-emitter/issues"
+  },
+  "homepage": "https://github.com/bencelaszlo/chiisai-event-emitter#readme",
+  "devDependencies": {
+    "@ryansonshine/commitizen": "^4.2.8",
+    "@ryansonshine/cz-conventional-changelog": "^3.3.4",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^12.20.11",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "husky": "^6.0.0",
+    "jest": "^27.2.0",
+    "lint-staged": "^13.2.1",
+    "prettier": "^2.2.1",
+    "semantic-release": "^21.0.1",
+    "ts-jest": "^27.0.5",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.2.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/@ryansonshine/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache --cache-location .eslintcache --fix"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "type": "build",
+              "scope": "deps",
+              "release": "patch"
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "build",
+                "section": "Dependencies and Other Build Updates",
+                "hidden": false
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  }
+}