Skip to content

Commit

Permalink
1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Silic0nS0ldier committed Mar 14, 2020
1 parent 773a909 commit d096b2f
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 31 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

## [1.0.0] - 2020-03-14

### Changed
- Renamed interface `IVirtPathMapping` to `IPathMapper`.
- Renamed configuration property `virtPathMaps` to `pathMappings`.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/vinyl-fs-vpath.iconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ export interface IConfig
| [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. Use this to debug issues and trace behaviours. Adheres to interface defined in ts-log package. |
| [pathMappings](./vinyl-fs-vpath.iconfig.pathmappings.md) | <code>IPathMapper[]</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. |
| [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. |

Original file line number Diff line number Diff line change
@@ -1,13 +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; [virtPathMaps](./vinyl-fs-vpath.iconfig.virtpathmaps.md)
[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IConfig](./vinyl-fs-vpath.iconfig.md) &gt; [pathMappings](./vinyl-fs-vpath.iconfig.pathmappings.md)

## IConfig.virtPathMaps property
## IConfig.pathMappings property

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: IVirtPathMapping[];
pathMappings: IPathMapper[];
```
Original file line number Diff line number Diff line change
@@ -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; [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) &gt; [match](./vinyl-fs-vpath.ivirtpathmapping.match.md)
[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IPathMapper](./vinyl-fs-vpath.ipathmapper.md) &gt; [match](./vinyl-fs-vpath.ipathmapper.match.md)

## IVirtPathMapping.match property
## IPathMapper.match property

Path prefix to match (relative to cwd).

Expand Down
20 changes: 20 additions & 0 deletions docs/api/vinyl-fs-vpath.ipathmapper.md
Original file line number Diff line number Diff line change
@@ -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; [IPathMapper](./vinyl-fs-vpath.ipathmapper.md)

## IPathMapper interface


<b>Signature:</b>

```typescript
export interface IPathMapper
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [match](./vinyl-fs-vpath.ipathmapper.match.md) | <code>string</code> | Path prefix to match (relative to cwd). |
| [replace](./vinyl-fs-vpath.ipathmapper.replace.md) | <code>string</code> | Value to replace matched portion of path with. |

Original file line number Diff line number Diff line change
@@ -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; [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) &gt; [replace](./vinyl-fs-vpath.ivirtpathmapping.replace.md)
[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IPathMapper](./vinyl-fs-vpath.ipathmapper.md) &gt; [replace](./vinyl-fs-vpath.ipathmapper.replace.md)

## IVirtPathMapping.replace property
## IPathMapper.replace property

Value to replace matched portion of path with.

Expand Down
20 changes: 0 additions & 20 deletions docs/api/vinyl-fs-vpath.ivirtpathmapping.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api/vinyl-fs-vpath.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
| Interface | Description |
| --- | --- |
| [IConfig](./vinyl-fs-vpath.iconfig.md) | |
| [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) | |
| [IPathMapper](./vinyl-fs-vpath.ipathmapper.md) | |

2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json.schemastore.org/package.json",
"name": "@userfrosting/vinyl-fs-vpath",
"version": "1.0.0-alpha.0",
"version": "1.0.0",
"description": "Vinyl source for file system with support for virtual paths.",
"funding": "https://opencollective.com/userfrosting",
"main": "./dist/index.js",
Expand Down

0 comments on commit d096b2f

Please sign in to comment.