use tap instead of ava, 100% test coverage, move types to types folder, activate linting in ci-pipeline (#65)

Author: Uzlopak

.github/workflows/ci.yml

@@ -15,3 +15,4 @@ jobs:
     uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
     with:
       license-check: true
+      lint: true

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.taprc

@@ -0,0 +1,2 @@
+files:
+  - test/**/*[!jest].test.js

package.json

@@ -3,9 +3,13 @@
   "version": "2.0.0",
   "description": "A small utility for creating warnings and emitting them.",
   "main": "index.js",
-  "types": "index.d.ts",
+  "types": "types/index.d.ts",
   "scripts": {
-    "test": "standard && ava -v test.js && jest jest.test.js && tsd"
+    "lint": "standard",
+    "test": "npm run test:unit && npm run test:jest && npm run test:typescript",
+    "test:jest": "jest jest.test.js",
+    "test:unit": "tap",
+    "test:typescript": "tsd"
   },
   "repository": {
     "type": "git",
@@ -27,9 +31,9 @@
   },
   "homepage": "https://github.com/fastify/fastify-warning#readme",
   "devDependencies": {
-    "ava": "^3.10.1",
     "jest": "^28.1.0",
     "standard": "^17.0.0",
+    "tap": "^16.3.0",
     "tsd": "^0.22.0"
   }
 }

test.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const test = require('tap').test
+const build = require('..')
+
+test('emit with interpolated string', t => {
+  t.plan(4)
+  const { create, emit, emitted } = build()
+
+  process.on('warning', onWarning)
+  function onWarning (warning) {
+    t.equal(warning.name, 'FastifyDeprecation')
+    t.equal(warning.code, 'CODE')
+    t.equal(warning.message, 'Hello world')
+    t.ok(emitted.get('CODE'))
+  }
+
+  create('FastifyDeprecation', 'CODE', 'Hello %s')
+  emit('CODE', 'world')
+  emit('CODE', 'world')
+
+  setImmediate(() => {
+    process.removeListener('warning', onWarning)
+    t.end()
+  })
+})

test/emit-interpolated-string.test.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const test = require('tap').test
+const build = require('..')
+
+test('emit should emit a given code only once', t => {
+  t.plan(4)
+
+  const { create, emit, emitted } = build()
+
+  process.on('warning', onWarning)
+  function onWarning (warning) {
+    t.equal(warning.name, 'FastifyDeprecation')
+    t.equal(warning.code, 'CODE')
+    t.equal(warning.message, 'Hello world')
+    t.ok(emitted.get('CODE'))
+  }
+
+  create('FastifyDeprecation', 'CODE', 'Hello world')
+  emit('CODE')
+  emit('CODE')
+  setImmediate(() => {
+    process.removeListener('warning', onWarning)
+    t.end()
+  })
+})

test/emit-once-only.test.js

@@ -0,0 +1,91 @@
+'use strict'
+
+const test = require('tap').test
+const build = require('..')
+
+process.removeAllListeners('warning')
+
+test('Create warning with zero parameter', t => {
+  t.plan(3)
+
+  const { create } = build()
+  const buildWarnOpts = create('FastifyWarning', 'CODE', 'Not available')
+  const opts = buildWarnOpts()
+  t.equal(opts.name, 'FastifyWarning')
+  t.equal(opts.message, 'Not available')
+  t.equal(opts.code, 'CODE')
+})
+
+test('Create error with 1 parameter', t => {
+  t.plan(3)
+
+  const { create } = build()
+  const buildWarningOpts = create('FastifyWarning', 'CODE', 'hey %s')
+  const opts = buildWarningOpts('alice')
+  t.equal(opts.name, 'FastifyWarning')
+  t.equal(opts.message, 'hey alice')
+  t.equal(opts.code, 'CODE')
+})
+
+test('Create error with 2 parameters', t => {
+  t.plan(3)
+
+  const { create } = build()
+  const buildWarnOpts = create('FastifyWarning', 'CODE', 'hey %s, I like your %s')
+  const opts = buildWarnOpts('alice', 'attitude')
+  t.equal(opts.name, 'FastifyWarning')
+  t.equal(opts.message, 'hey alice, I like your attitude')
+  t.equal(opts.code, 'CODE')
+})
+
+test('Create error with 3 parameters', t => {
+  t.plan(3)
+
+  const { create } = build()
+  const buildWarnOpts = create('FastifyWarning', 'CODE', 'hey %s, I like your %s %s')
+  const opts = buildWarnOpts('alice', 'attitude', 'see you')
+  t.equal(opts.name, 'FastifyWarning')
+  t.equal(opts.message, 'hey alice, I like your attitude see you')
+  t.equal(opts.code, 'CODE')
+})
+
+test('Should throw when error code has no fastify name', t => {
+  t.plan(1)
+
+  const { create } = build()
+
+  t.throws(() => create(), new Error('Warning name must not be empty'))
+})
+
+test('Should throw when error has no code', t => {
+  t.plan(1)
+
+  const { create } = build()
+
+  t.throws(() => create('name'), new Error('Warning code must not be empty'))
+})
+
+test('Should throw when error has no message', t => {
+  t.plan(1)
+
+  const { create } = build()
+
+  t.throws(() => create('name', 'code'), new Error('Warning message must not be empty'))
+})
+
+test('Should throw if emit is called with unknown code ', t => {
+  t.plan(1)
+
+  const { emit } = build()
+
+  t.throws(() => emit('CODE'), new Error('The code \'CODE\' does not exist'))
+})
+
+test('Cannot reuse the same code more than once', t => {
+  t.plan(1)
+
+  const { create } = build()
+  create('FastifyWarning', 'CODE', 'Not available')
+
+  t.throws(() => create('FastifyWarning', 'CODE', 'Not available'), new Error("The code 'CODE' already exist"))
+})

test/index.test.js

@@ -1,7 +1,7 @@
 /* global test, expect */
 'use strict'
 
-const build = require('./')
+const build = require('..')
 
 test('works with jest', done => {
   const { create, emit, emitted } = build()