content-entry-transform 1.1.0 → 1.3.0

package/README.md

@@ -8,5 +8,54 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Known Vulnerabilities](https://snyk.io/test/github/arlac77/content-entry-transform/badge.svg)](https://snyk.io/test/github/arlac77/content-entry-transform)
 [![Coverage Status](https://coveralls.io/repos/arlac77/content-entry-transform/badge.svg)](https://coveralls.io/github/arlac77/content-entry-transform)
+
 # content-entry-transform
+
 transform content entries
+
+# API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+*   [createPropertiesTransformer](#createpropertiestransformer)
+    *   [Parameters](#parameters)
+*   [transform](#transform)
+    *   [Parameters](#parameters-1)
+
+## createPropertiesTransformer
+
+Creates a new transformer.
+On match the enrtry will be assigned noe properties as given by propertyDefinitions.
+
+### Parameters
+
+*   `match`  
+*   `propertyDefinitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `name`   (optional, default `"property"`)
+*   `matcher` **Matcher** 
+
+Returns **Transformer** 
+
+## transform
+
+Apply transformers.
+
+### Parameters
+
+*   `source` **AsyncIterator\<ContentEntry>** 
+*   `transformers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**  (optional, default `[]`)
+*   `onlyMatching`  
+
+# install
+
+With [npm](http://npmjs.org) do:
+
+```shell
+npm install content-entry-transform
+```
+
+# license
+
+BSD-2-Clause

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "content-entry-transform",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -25,7 +25,8 @@
     "lint:docs": "documentation lint ./src/**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^4.0.0"
+    "content-entry": "^4.0.0",
+    "iterable-string-interceptor": "^1.0.11"
   },
   "devDependencies": {
     "ava": "^4.0.1",

package/src/expression-transformer.mjs

@@ -1,3 +1,9 @@
+import { ReadableStreamContentEntry } from "content-entry";
+import { iterableStringInterceptor } from "iterable-string-interceptor";
+import { nameExtensionMatcher } from "./matcher.mjs";
+
+export const utf8StreamOptions = { encoding: "utf8" };
+
 export function createPropertiesInterceptor(properties) {
   return async function* transformer(expression, remainder, source, cb) {
     const value = properties[expression];
@@ -6,12 +12,19 @@ export function createPropertiesInterceptor(properties) {
 }
 
 export function createExpressionTransformer(
+  match = nameExtensionMatcher([
+    ".conf",
+    ".json",
+    ".html",
+    ".txt",
+    ".service",
+    ".socket"
+  ]),
   properties,
-  match = entry =>
-    entry.name.match(/\.(conf|json|html|txt|service|socket)$/) ? true : false
+  name = "expression"
 ) {
   return {
-    name: "expression",
+    name,
     match,
     transform: async entry => {
       //console.log("TRANSFORM",entry.name);

package/src/matcher.mjs

@@ -0,0 +1,6 @@
+export function nameExtensionMatcher(extensions) {
+  const r = new RegExp(
+    `(${extensions.map(x => x.replace(/\./, "\\.")).join("|")})$`
+  );
+  return entry => r.test(entry.name);
+}

package/src/properties-transformer.mjs

@@ -1,4 +1,3 @@
-
 /**
  * Creates a new transformer.
  * On match the enrtry will be assigned noe properties as given by propertyDefinitions.
@@ -6,7 +5,11 @@
  * @param {Matcher} matcher
  * @return {Transformer}
  */
-export function createPropertiesTransformer(propertyDefinitions, match, name="property") {
+export function createPropertiesTransformer(
+  match,
+  propertyDefinitions,
+  name = "property"
+) {
   return {
     name,
     match,

package/src/transform.mjs

@@ -1,4 +1,6 @@
 export * from "./properties-transformer.mjs";
+export * from "./expression-transformer.mjs";
+export * from "./matcher.mjs";
 
 /**
  * Apply transformers.
@@ -12,7 +14,7 @@ export async function* transform(source, transformers = [], onlyMatching) {
   for await (let entry of source) {
     let didMatch = false;
     for (const t of transformers) {
-      //console.log(t.name,entry.name,t.match(entry));
+      //console.log(t.name, entry.name, t.match(entry));
       if (t.match(entry)) {
         didMatch = true;
         entry = await t.transform(entry);