Skip to content

Commit d096b2f

Browse files
1.0.0
1 parent 773a909 commit d096b2f

10 files changed

+33
-31
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
## [1.0.0] - 2020-03-14
11+
1012
### Changed
1113
- Renamed interface `IVirtPathMapping` to `IPathMapper`.
1214
- Renamed configuration property `virtPathMaps` to `pathMappings`.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ export interface IConfig
1919
| [cwd](./vinyl-fs-vpath.iconfig.cwd.md) | <code>string</code> | Current working directory. Default: process.cwd() |
2020
| [globs](./vinyl-fs-vpath.iconfig.globs.md) | <code>string &#124; string[]</code> | Input file matchers. |
2121
| [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. |
22+
| [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. |
2223
| [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 |
2324
| [since](./vinyl-fs-vpath.iconfig.since.md) | <code>Date &#124; number</code> | Only find files that have been modified since the time specified |
2425
| [sourcemaps](./vinyl-fs-vpath.iconfig.sourcemaps.md) | <code>boolean</code> | Setting this to true will enable sourcemaps. Default: false |
25-
| [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. |
2626

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[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)
3+
[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)
44

5-
## IConfig.virtPathMaps property
5+
## IConfig.pathMappings property
66

77
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.
88

99
<b>Signature:</b>
1010

1111
```typescript
12-
virtPathMaps: IVirtPathMapping[];
12+
pathMappings: IPathMapper[];
1313
```

docs/api/vinyl-fs-vpath.ivirtpathmapping.match.md renamed to docs/api/vinyl-fs-vpath.ipathmapper.match.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[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)
3+
[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)
44

5-
## IVirtPathMapping.match property
5+
## IPathMapper.match property
66

77
Path prefix to match (relative to cwd).
88

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@userfrosting/vinyl-fs-vpath](./vinyl-fs-vpath.md) &gt; [IPathMapper](./vinyl-fs-vpath.ipathmapper.md)
4+
5+
## IPathMapper interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface IPathMapper
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [match](./vinyl-fs-vpath.ipathmapper.match.md) | <code>string</code> | Path prefix to match (relative to cwd). |
19+
| [replace](./vinyl-fs-vpath.ipathmapper.replace.md) | <code>string</code> | Value to replace matched portion of path with. |
20+

docs/api/vinyl-fs-vpath.ivirtpathmapping.replace.md renamed to docs/api/vinyl-fs-vpath.ipathmapper.replace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[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)
3+
[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)
44

5-
## IVirtPathMapping.replace property
5+
## IPathMapper.replace property
66

77
Value to replace matched portion of path with.
88

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

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/api/vinyl-fs-vpath.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@
1515
| Interface | Description |
1616
| --- | --- |
1717
| [IConfig](./vinyl-fs-vpath.iconfig.md) | |
18-
| [IVirtPathMapping](./vinyl-fs-vpath.ivirtpathmapping.md) | |
18+
| [IPathMapper](./vinyl-fs-vpath.ipathmapper.md) | |
1919

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "http://json.schemastore.org/package.json",
33
"name": "@userfrosting/vinyl-fs-vpath",
4-
"version": "1.0.0-alpha.0",
4+
"version": "1.0.0",
55
"description": "Vinyl source for file system with support for virtual paths.",
66
"funding": "https://opencollective.com/userfrosting",
77
"main": "./dist/index.js",

0 commit comments

Comments
 (0)