0.3.0

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.3.0] - 2020-02-03
+
 ### Added
 - Logging improvements
 

docs/api/vinyl-fs-vpath.iconfig.base.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IConfig](./vinyl-fs-vpath.iconfig.md) &gt; [base](./vinyl-fs-vpath.iconfig.base.md)
+
+## IConfig.base property
+
+Specifies the folder relative to the cwd This is used to determine the file names when saving in .dest() Default: cwd
+
+<b>Signature:</b>
+
+```typescript
+base?: string;
+```

docs/api/vinyl-fs-vpath.iconfig.cwd.md

@@ -4,7 +4,7 @@
 
 ## IConfig.cwd property
 
-Current working directory. NodeJS cwd is used if not supplied.
+Current working directory. Default: process.cwd()
 
 <b>Signature:</b>
 

docs/api/vinyl-fs-vpath.iconfig.logger.md

@@ -4,7 +4,7 @@
 
 ## IConfig.logger property
 
-Optional logger.
+Optional logger. Use this to debug issues and trace behaviours. Adheres to interface defined in ts-log package.
 
 <b>Signature:</b>
 

docs/api/vinyl-fs-vpath.iconfig.md

@@ -15,8 +15,12 @@ export interface IConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [cwd](./vinyl-fs-vpath.iconfig.cwd.md) | <code>string</code> | Current working directory. NodeJS cwd is used if not supplied. |
+|  [base](./vinyl-fs-vpath.iconfig.base.md) | <code>string</code> | Specifies the folder relative to the cwd This is used to determine the file names when saving in .dest() Default: cwd |
+|  [cwd](./vinyl-fs-vpath.iconfig.cwd.md) | <code>string</code> | Current working directory. Default: process.cwd() |
 |  [globs](./vinyl-fs-vpath.iconfig.globs.md) | <code>string &#124; string[]</code> | Input file matchers. |
-|  [logger](./vinyl-fs-vpath.iconfig.logger.md) | <code>Logger</code> | Optional logger. |
-|  [virtPathMaps](./vinyl-fs-vpath.iconfig.virtpathmaps.md) | <code>IVirtualPathMapping[]</code> | Virtual path mappings. Collision resolution uses the last mapping to select the file. Resolution is \*not\* recursive. |
+|  [logger](./vinyl-fs-vpath.iconfig.logger.md) | <code>Logger</code> | Optional logger. Use this to debug issues and trace behaviours. Adheres to interface defined in ts-log package. |
+|  [removeBOM](./vinyl-fs-vpath.iconfig.removebom.md) | <code>boolean</code> | Causes the BOM to be removed on UTF-8 encoded files. Set to false if you need the BOM for some reason. Default: true |
+|  [since](./vinyl-fs-vpath.iconfig.since.md) | <code>Date &#124; number</code> | Only find files that have been modified since the time specified |
+|  [sourcemaps](./vinyl-fs-vpath.iconfig.sourcemaps.md) | <code>boolean</code> | Setting this to true will enable sourcemaps. Default: false |
+|  [virtPathMaps](./vinyl-fs-vpath.iconfig.virtpathmaps.md) | <code>IVirtPathMapping[]</code> | Virtual path mappings. Collision resolution uses the last mapping to select the file. Internally mapping occurs on absolute path strings, conversion and normalisation is performed automatically. Resolution is \*not\* recursive. |
 

docs/api/vinyl-fs-vpath.iconfig.removebom.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IConfig](./vinyl-fs-vpath.iconfig.md) &gt; [removeBOM](./vinyl-fs-vpath.iconfig.removebom.md)
+
+## IConfig.removeBOM property
+
+Causes the BOM to be removed on UTF-8 encoded files. Set to false if you need the BOM for some reason. Default: true
+
+<b>Signature:</b>
+
+```typescript
+removeBOM?: boolean;
+```

docs/api/vinyl-fs-vpath.iconfig.since.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IConfig](./vinyl-fs-vpath.iconfig.md) &gt; [since](./vinyl-fs-vpath.iconfig.since.md)
+
+## IConfig.since property
+
+Only find files that have been modified since the time specified
+
+<b>Signature:</b>
+
+```typescript
+since?: Date | number;
+```

docs/api/vinyl-fs-vpath.iconfig.sourcemaps.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IConfig](./vinyl-fs-vpath.iconfig.md) &gt; [sourcemaps](./vinyl-fs-vpath.iconfig.sourcemaps.md)
+
+## IConfig.sourcemaps property
+
+Setting this to true will enable sourcemaps. Default: false
+
+<b>Signature:</b>
+
+```typescript
+sourcemaps?: boolean;
+```

docs/api/vinyl-fs-vpath.iconfig.virtpathmaps.md

@@ -4,10 +4,10 @@
 
 ## IConfig.virtPathMaps property
 
-Virtual path mappings. Collision resolution uses the last mapping to select the file. Resolution is \*not\* recursive.
+Virtual path mappings. Collision resolution uses the last mapping to select the file. Internally mapping occurs on absolute path strings, conversion and normalisation is performed automatically. Resolution is \*not\* recursive.
 
 <b>Signature:</b>
 
 ```typescript
-virtPathMaps: IVirtualPathMapping[];
+virtPathMaps: IVirtPathMapping[];
 ```

docs/api/vinyl-fs-vpath.ivirtualpathmapping.match.md → docs/api/vinyl-fs-vpath.ivirtpathmapping.match.md

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IVirtualPathMapping](./vinyl-fs-vpath.ivirtualpathmapping.md) &gt; [match](./vinyl-fs-vpath.ivirtualpathmapping.match.md)
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) &gt; [match](./vinyl-fs-vpath.ivirtpathmapping.match.md)
 
-## IVirtualPathMapping.match property
+## IVirtPathMapping.match property
 
 Path prefix to match (relative to cwd).
 

docs/api/vinyl-fs-vpath.ivirtpathmapping.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md)
+
+## IVirtPathMapping interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface IVirtPathMapping 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [match](./vinyl-fs-vpath.ivirtpathmapping.match.md) | <code>string</code> | Path prefix to match (relative to cwd). |
+|  [replace](./vinyl-fs-vpath.ivirtpathmapping.replace.md) | <code>string</code> | Value to replace matched portion of path with. |
+

docs/api/vinyl-fs-vpath.ivirtualpathmapping.replace.md → docs/api/vinyl-fs-vpath.ivirtpathmapping.replace.md

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IVirtualPathMapping](./vinyl-fs-vpath.ivirtualpathmapping.md) &gt; [replace](./vinyl-fs-vpath.ivirtualpathmapping.replace.md)
+[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) &gt; [replace](./vinyl-fs-vpath.ivirtpathmapping.replace.md)
 
-## IVirtualPathMapping.replace property
+## IVirtPathMapping.replace property
 
 Value to replace matched portion of path with.
 

docs/api/vinyl-fs-vpath.md

@@ -15,5 +15,5 @@
 |  Interface | Description |
 |  --- | --- |
 |  [IConfig](./vinyl-fs-vpath.iconfig.md) |  |
-|  [IVirtualPathMapping](./vinyl-fs-vpath.ivirtualpathmapping.md) |  |
+|  [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) |  |
 

package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "http://json.schemastore.org/package.json",
     "name": "@userfrosting/vinyl-fs-vpath",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "description": "Vinyl source for file system with support for virtual paths.",
     "funding": "https://opencollective.com/userfrosting",
     "main": "./dist/index.js",