Add tests

Author: vweevers

.github/workflows/test.yml

@@ -18,9 +18,9 @@ jobs:
         run: npm install
       - name: Test
         run: npm test
-      # - name: Coverage
-      #   run: npm run coverage
-      # - name: Codecov
-      #   uses: codecov/codecov-action@v2
-      #   with:
-      #     file: coverage/lcov.info
+      - name: Coverage
+        run: npm run coverage
+      - name: Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          file: coverage/lcov.info

README.md

@@ -3,6 +3,8 @@
 **Encode data with built-in or custom encodings.** The (not yet official) successor to `level-codec`, that introduces "transcoders" to translate between encodings and internal data formats supported by a db. This allows a db to store keys and values in a format of its choice (Buffer, Uint8Array or String) with zero-effort support of all known encodings.
 
 [![level badge][level-badge]](https://github.com/Level/awesome)
+[![Test](https://img.shields.io/github/workflow/status/Level/transcoder/Test?label=test)](https://github.com/Level/transcoder/actions/workflows/test.yml)
+[![Coverage](https://img.shields.io/codecov/c/github/Level/transcoder?label=&logo=codecov&logoColor=fff)](https://codecov.io/gh/Level/transcoder)
 [![Standard](https://img.shields.io/badge/standard-informational?logo=javascript&logoColor=fff)](https://standardjs.com)
 [![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)
 [![Donate](https://img.shields.io/badge/donate-orange?logo=open-collective&logoColor=fff)](https://opencollective.com/level)
@@ -150,7 +152,7 @@ The `type` string should be a unique name.
 
 ## Contributing
 
-[`Level/codec`](https://github.com/Level/codec) is an **OPEN Open Source Project**. This means that:
+[`Level/transcoder`](https://github.com/Level/transcoder) is an **OPEN Open Source Project**. This means that:
 
 > Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
 

index.d.ts

@@ -8,9 +8,10 @@ declare class Transcoder<T = any> {
   constructor (formats: Iterable<string>)
 
   /**
-   * Get the types of supported encodings, including transcoded encodings.
+   * Get the types of supported encodings.
+   * @param full Return fully qualified types with the formats of trancoded encodings (if any).
    */
-  types (): string[]
+  types (full?: boolean): string[]
 
   /**
    * Get the given encoding, creating a transcoder if necessary.

index.js

@@ -14,6 +14,12 @@ class Transcoder {
    * @param {Iterable<string>} formats
    */
   constructor (formats) {
+    if (formats == null ||
+      typeof formats[Symbol.iterator] !== 'function' ||
+      typeof formats === 'string') {
+      throw new TypeError("The first argument 'formats' must be an Iterable")
+    }
+
     /** @type {Map<string|Encoding<any, any, any>|EncodingOptions<any, any, any>, Encoding<any, any, any>>} */
     this[kEncodings] = new Map()
     this[kFormats] = new Set(formats)
@@ -32,17 +38,20 @@ class Transcoder {
       try {
         this.encoding(k)
       } catch (err) {
+        /* istanbul ignore if: assertion */
         if (err.code !== 'LEVEL_ENCODING_NOT_SUPPORTED') throw err
       }
     }
   }
 
-  types () {
+  /**
+   * @param {boolean} [full]
+   */
+  types (full) {
     const types = new Set()
 
     for (const encoding of this[kEncodings].values()) {
-      const type = encoding.type.split('+')[0]
-      if (type) types.add(type)
+      types.add(full ? encoding.type : encoding.type.split('+')[0])
     }
 
     return Array.from(types)
@@ -67,7 +76,7 @@ class Transcoder {
           )
         }
       } else if (typeof encoding !== 'object' || encoding === null) {
-        throw new TypeError('Encoding must be a string or object')
+        throw new TypeError("First argument 'encoding' must be a string or object")
       } else if (encoding instanceof Encoding) {
         resolved = encoding
       } else if (encoding.format === 'view') {
@@ -89,15 +98,16 @@ class Transcoder {
         } else if (this[kFormats].has('buffer')) {
           resolved = resolved.transcode('buffer')
         } else {
+          // TODO: improve error message (see tests, it's inconsistent)
           throw new ModuleError(
-            `Encoding '${type}' or '${format}' is not supported`,
+            `Encoding '${type}' is not supported`,
             { code: 'LEVEL_ENCODING_NOT_SUPPORTED' }
           )
         }
       }
 
       for (const k of [encoding, type, resolved.type]) {
-        if (k) this[kEncodings].set(k, resolved)
+        this[kEncodings].set(k, resolved)
       }
     }
 

lib/encoding.js

@@ -21,11 +21,11 @@ class Encoding {
     createBufferTranscoder
   }) {
     if (typeof encode !== 'function' && encode !== undefined) {
-      throw new TypeError("The 'encode' option must be a function")
+      throw new TypeError("The 'encode' option must be a function or undefined")
     }
 
     if (typeof decode !== 'function' && decode !== undefined) {
-      throw new TypeError("The 'decode' option must be a function")
+      throw new TypeError("The 'decode' option must be a function or undefined")
     }
 
     if (typeof type !== 'string' && type !== undefined) {
@@ -90,7 +90,7 @@ class Encoding {
     }
 
     throw new ModuleError(
-      `Encoding '${format}' is not supported`,
+      `Encoding '${this.type}' cannot be transcoded to '${format}'`,
       { code: 'LEVEL_ENCODING_NOT_SUPPORTED' }
     )
   }

lib/formats.js

@@ -116,7 +116,7 @@ class NativeFormat extends Encoding {
    * @param {string} nativeType
    */
   constructor (nativeType) {
-    super({ type: `native+${nativeType}`, idempotent: true, format: nativeType })
+    super({ type: `${nativeType}+native`, idempotent: true, format: nativeType })
   }
 }
 

package.json

@@ -6,7 +6,7 @@
   "main": "index.js",
   "types": "./index.d.ts",
   "scripts": {
-    "test": "ts-standard && tsc && standard && hallmark && nyc tape test/skip-*.js",
+    "test": "ts-standard && tsc && standard && hallmark && nyc tape test/*.js",
     "test-browsers-local": "airtap --coverage --verbose test/*.js",
     "coverage": "nyc report -r lcovonly",
     "hallmark": "hallmark --fix",