@amazon/vinyl-build-utils 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -25
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,49 +1,51 @@
1
- ## Shared Build Utilities
1
+ # @amazon/vinyl-build-utils
2
2
 
3
- Reusable build utility for Amazon Vinyl and Amazon Vinyl-related TypeScript
3
+ [![Website](https://img.shields.io/badge/website-amazonmusic.github.io%2Fvinyl-blue)](https://amazonmusic.github.io/vinyl)
4
+ [![npm](https://img.shields.io/npm/v/@amazon/vinyl-build-utils.svg)](https://www.npmjs.com/package/@amazon/vinyl-build-utils)
5
+
6
+ Reusable build utilities used to build Amazon Vinyl and related TypeScript
4
7
  libraries.
5
8
 
6
- ## Packages
9
+ ## Modules
7
10
 
8
- ### util
11
+ ### `util`
9
12
 
10
13
  General utilities for build scripts and configuration.
11
14
 
12
- ### vinyl
15
+ ### `vinyl`
13
16
 
14
17
  Amazon Vinyl defaults for the provided tools.
15
18
 
16
- ### typescript
19
+ ### `typescript`
17
20
 
18
21
  Utilities for compiling and running TypeScript code.
19
22
 
20
23
  ## Build Tools
21
24
 
22
- ### ESBuild (https://esbuild.github.io/)
23
-
24
- ESBuild provides an exceptionally fast typescript build system that provides
25
- simple hooks where we can add our custom plugins. This allows us to run babel
26
- transpilation, replace path aliases, and emit type declarations after file
27
- changes were detected.
25
+ ### [ESBuild](https://esbuild.github.io/)
28
26
 
29
- ### Babel (https://babeljs.io/)
27
+ ESBuild provides an exceptionally fast TypeScript build with simple plugin
28
+ hooks. We use it to run Babel transpilation, replace path aliases, and emit type
29
+ declarations after file changes are detected.
30
30
 
31
- Babel is a transpiler for js or ts that produces highly-compatible applications
32
- or libraries.
31
+ ### [Babel](https://babeljs.io/)
33
32
 
34
- The compatibility targets are defined in the package.json "browserslist"
35
- property. Use https://browsersl.ist/ to generate the expression for
36
- compatibility targets.
33
+ Babel is a transpiler for JS or TS that produces highly compatible applications
34
+ or libraries. Compatibility targets are defined in the package.json
35
+ `browserslist` property — use [browsersl.ist](https://browsersl.ist/) to
36
+ generate the expression.
37
37
 
38
38
  ### BrowserStack
39
39
 
40
- We use the BrowserStack service to run integration and unit tests on real
41
- browsers and devices. It allows us to set a compatibility matrix which we can
42
- assert that all functionality for our playback engine works as expected for
43
- every supported platform.
44
-
45
- [BrowserStack Readme](./src/browserstack/README.md)
40
+ We use BrowserStack to run integration and unit tests on real browsers and
41
+ devices. See the [BrowserStack runner](./src/browserstack/README.md) for the
42
+ runner contract and a usage example.
46
43
 
47
44
  ### Express
48
45
 
49
- Express is an HTTP server which supports SSL, proxies, and REST apis.
46
+ Express is the HTTP server used for the local test server (SSL, proxies, REST
47
+ APIs).
48
+
49
+ ## License
50
+
51
+ Apache-2.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amazon/vinyl-build-utils",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "Build utilities and configuration for TypeScript libraries.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -49,5 +49,5 @@
49
49
  "express": "^5.1.0",
50
50
  "http-proxy-middleware": "^3.0.5"
51
51
  },
52
- "gitHead": "ea13070fb52c1903723f08f31c356465d2f3279e"
52
+ "gitHead": "e5a3429d802564132b16808a5b8a8e15a023a548"
53
53
  }