Release 3.0.0 (#57)

* rewrite project with typescript

* remove coverage folder

* remove stringifyVtt and add vtt support to stringify

* add formatTimestamp function and remove old formatting functions

* add test:coverage script

* update badges

* add tests for correclty parsing empty first lines

* rename toMS to parseTimestamp

* update readme

* update readme

* update readme

* update readme

* update readme

* update readme and changelog

* add throwError functino

* add support for optional indexes

* update changelog

* use snapshot for testing

* add test for invalid timestamps

* update package.json description

* add tests for invalid timestamp

* update changelog

.codeclimate.yml

@@ -1,4 +1,3 @@
 exclude_paths:
 - "dist/*.js"
-- "examples/**/*"
 - "test/**/*"

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Begin CI...
+        uses: actions/checkout@v2
+
+      - name: Use Node 12
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - name: Use cached node_modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: nodeModules-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            nodeModules-
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        env:
+          CI: true
+
+      - name: Lint
+        run: yarn lint
+        env:
+          CI: true
+
+      - name: Test
+        run: yarn test --ci --coverage --maxWorkers=2
+        env:
+          CI: true
+
+      - name: Build
+        run: yarn build
+        env:
+          CI: true

.gitignore

@@ -1,34 +1,5 @@
-# Logs
-logs
 *.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+.DS_Store
 node_modules
-
-# Demo tests
-demo.js
-
-# IDE
-.idea
+dist
+coverage

.npmignore

@@ -1,4 +1,5 @@
-examples
 .codeclimate.yml
 .editorconfig
 .travis.yml
+coverage
+.github

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0] - 2020-08-31
+- Rewrite the project with TypeScript
+- Fixes #43 and #39
+- Update the API to export only these functions:
+  - `parse(input: string): Caption[]`
+  - `stringify(captions: Caption[], options?: { format: 'srt' | 'vtt }): string`
+  - `resync(captions: Caption[], time: number): Caption[]`
+  - `parseTimestamp(timestamp: string): number`
+  - `parseTimestamps(timestamps: string): Timestamp`
+  - `formatTimestamp(timestamp: number, options?: { format: 'srt' | 'vtt' }): string`
+- `parse` supports optional indexes
+
 ## [2.0.5] - 2020-08-28
 - Remove zero-fill dependency
 - Rewrite and refactor tests with Jest