@voiceflow/alexa-types
Advanced tools
Comparing version 1.0.6 to 1.1.0
@@ -0,3 +1,5 @@ | ||
'use strict'; | ||
module.exports = { | ||
extends: ['@voiceflow/commitlint-config'], | ||
}; |
{ | ||
"name": "@voiceflow/alexa-types", | ||
"description": "Alexa service types", | ||
"version": "1.0.6", | ||
"version": "1.1.0", | ||
"author": "Voiceflow", | ||
@@ -72,3 +72,3 @@ "bugs": { | ||
}, | ||
"main": "index.ts", | ||
"main": "build/index.js", | ||
"prettier": "@voiceflow/prettier-config", | ||
@@ -80,4 +80,7 @@ "repository": { | ||
"scripts": { | ||
"lint": "eslint \"*.{js,ts}\"" | ||
"build": "yarn clean && ttsc --project ./tsconfig.build.json", | ||
"clean": "rimraf build", | ||
"lint": "eslint \"src/**/*.{js,ts}\"", | ||
"prepare": "yarn build" | ||
} | ||
} |
@@ -5,63 +5,6 @@ # alexa-types | ||
## Getting Started | ||
## Nodes | ||
### Environment | ||
presently reference node types by `import Speak from @voiceflow/alexa-types/lib/types` | ||
In order to run this package locally, make sure you have `yarn` and `brew` installed. | ||
You also need to acquire a `.env` file and a `local_sercrets.yaml` file from engineering to load development secrets. | ||
### Package Manager | ||
This Repository Relies on `yarn` and does not work with `npm` | ||
### Install Dependencies | ||
Use `yarn` to install this project's dependencies. | ||
```sh | ||
yarn install | ||
``` | ||
### Generate SSL Certificates | ||
Use `mkcert` to generate and install SSL certificates for local development. | ||
```sh | ||
yarn gen-certs | ||
``` | ||
## Usage | ||
### Build | ||
Run `tsc` to generate a compiled version of the server. | ||
```sh | ||
yarn build | ||
``` | ||
### Start | ||
Run the `express` server locally. | ||
```sh | ||
yarn local | ||
``` | ||
### Testing | ||
#### Linting | ||
Test the code for linting errors with `estlint`. | ||
```sh | ||
yarn lint | ||
``` | ||
#### Unit Tests | ||
Run unit tests with `mocha`. | ||
```sh | ||
yarn test | ||
``` | ||
TODO: update that later |
Sorry, the diff of this file is not supported yet
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
189843
94
3848
10