Merge pull request #13 from havelessbemore/dev

v2.0.0

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: havelessbemore

.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+name: Coverage Workflow
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch:
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+          node-version: 20
+      - name: Clean install
+        run: npm ci
+      - name: Run tests and collect coverage
+        run: npm run test:coverage
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: havelessbemore/semafy

.github/workflows/main.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean installation of node dependencies, build the source code and run tests across different node versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+name: Node.js CI
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch:
+jobs:
+  build:
+    name: Node ${{ matrix.node }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        node: [18, 20, 21, 22]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Clean install
+        run: npm ci
+      - name: Run linter
+        run: npm run lint
+      - name: Run tests
+        run: npm run test

.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is published
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+name: Publish Package
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+          node-version: 20
+          registry-url: "https://registry.npmjs.org"
+      - name: Clean install
+        run: npm ci
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,45 +1,132 @@
-lib-cov
-*.seed
+# General
+.DS_Store
+
+# Logs
+logs
 *.log
-*.csv
-*.dat
-*.out
-*.pid
-*.gz
-*.swp
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
+# Runtime data
 pids
-logs
-results
-tmp
+*.pid
+*.seed
+*.pid.lock
 
-# Build
-public/css/main.css
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
 
-# Coverage reports
-.nyc_output
+# Coverage directory used by tools like istanbul
 coverage
+*.lcov
 
-# API keys and secrets
-.env
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
 
-# Dependency directory
-node_modules
+# Bower dependency directory (https://bower.io/)
 bower_components
 
-# Editors
-.idea
-*.iml
+# node-waf configuration
+.lock-wscript
 
-# OS metadata
-.DS_Store
-Thumbs.db
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
 
-# Ignore built ts files
-/lib
+# TernJS port file
+.tern-port
 
-# Ignore yarn.lock
-yarn.lock
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
 
-# Ignore wiki staging directory
-/wiki
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx --no-install lint-staged
+npx lint-staged

.lintstagedrc

@@ -0,0 +1,3 @@
+{
+  "*.ts": ["eslint", "prettier --write", "jest -o --passWithNoTests"]
+}

.prettierignore

@@ -0,0 +1,3 @@
+.husky
+dist
+docs

AUTHORS

@@ -0,0 +1,3 @@
+# Authors ordered by first contribution.
+
+Michael Rojas <dev.michael.rojas@gmail.com>