Merge pull request #25 from lifeomic/repo-upgrade

Author: swain

.editorconfig

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: ['prettier', '@lifeomic/standards'],
+  overrides: [
+    // Set correct env for config files
+    { files: ['*.js'], env: { node: true } },
+  ],
+};

.eslintrc.js

@@ -0,0 +1,5 @@
+enforceSemanticCommits: true
+reportWorkflowFailures:
+  Release:
+    # This is #skillspring
+    slackChannel: CF46X5T4G

.github/lifeomic-probot.yml

@@ -1,7 +1,7 @@
 # This workflow is inherited from our internal .github repo at https://github.com/lifeomic/.github/blob/master/workflow-templates/code-scanning-2021-06-08.yml
-# Setting up this workflow on the repository will perform a static scan for security issues using GitHub Code Scanning. 
+# Setting up this workflow on the repository will perform a static scan for security issues using GitHub Code Scanning.
 # Any findings for a repository can be found under the `Security` tab -> `Code Scanning Alerts`
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
@@ -33,24 +33,24 @@ jobs:
       fail-fast: false
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-      with:
-        # We must fetch at least the immediate parents so that if this is
-        # a pull request then we can checkout the head.
-        fetch-depth: 2
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # We must fetch at least the immediate parents so that if this is
+          # a pull request then we can checkout the head.
+          fetch-depth: 2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        config-file: lifeomic/.github/config-files/codeql-config.yml@master  # uses our config file from the lifeomic/.github repo
-        queries: +security-extended  # This will run all queries at https://github.com/github/codeql/:language/ql/src/codeql-suites/:language-security-extended.qls
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          config-file: lifeomic/.github/config-files/codeql-config.yml@master # uses our config file from the lifeomic/.github repo
+          queries: +security-extended # This will run all queries at https://github.com/github/codeql/:language/ql/src/codeql-suites/:language-security-extended.qls
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, it should be removed and replaced with custom build steps.
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, it should be removed and replaced with custom build steps.
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/code-scanning-v4.yml

@@ -0,0 +1,21 @@
+name: PR Build & Test
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      NPM_TOKEN: ${{ secrets.LIFEOMIC_NPM_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 12
+      - name: Build & Test
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
+          yarn install --frozen-lockfile
+          yarn lint
+          yarn test
+          yarn build

.github/workflows/pull-request.yaml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment: npm
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.LIFEOMIC_NPM_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 12
+      - name: Test
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
+          yarn install --frozen-lockfile
+          yarn lint
+          yarn test
+          yarn build
+      - name: Publish
+        run: |
+          yarn semantic-release

.github/workflows/release.yaml

@@ -1,2 +1,3 @@
-/.nyc_output/
-node_modules/
+coverage
+node_modules
+dist

.gitignore

@@ -1,58 +1,8 @@
-delta
-=====
-
-[![Build Status](https://travis-ci.org/lifeomic/delta.svg?branch=master)](https://travis-ci.org/lifeomic/delta)
-[![Coverage Status](https://coveralls.io/repos/github/lifeomic/delta/badge.svg?branch=master)](https://coveralls.io/github/lifeomic/delta?branch=master)
-
 Delta provides tooling for creating and testing AWS Lambda functions that
 process AWS data streams.
 
 ## Usage
 
 ```bash
-npm install --save @lifeomic/delta
+yarn add @lifeomic/delta
 ```
-
-## API
-
-### Handlers
-
-The `delta.handlers` module provides tools for constructing `async` AWS Lambda
-handlers using [RxJS][rxjs].
-
-#### records()
-
-Create an [RxJS][rxjs] operator for extracting AWS Lambda data stream records
-from an event.
-
-#### some(...operatorFactories)
-
-Create an AWS Lambda handler from a set of `operatorFactories`. Each fatory is
-invoked with the `context` object from the Lambda invocation and is expected to
-return an [RxJS][rxjs] operator. The Lambda `event` is then piped through all of
-of the operators and the last emitted value is returned. If no operator emits
-a value an error is thrown.
-
-#### withContext(generator, handler)
-
-Creates a new AWS Lambda handler that wraps a given `handler`. The wrapper will
-invoke the `generator` with the `context` object Lambda invocation. The
-transformed `context` and the original Lambda `event` are then passed to the
-`handler` and the result is retuned.
-
-### Generators
-
-The `delta.generators` module provides tools for generating synthetic data
-stream event payloads. This is often useful for testing.
-
-#### kinesisRecord(payload)
-
-Encodes the `payload` object and returns a single Kinesis record.
-
-#### streamEvent(records)
-
-Encodes `records` as a event object like what AWS Lambda receives from a
-registered data stream. `records` may  be a single record on an array of
-records.
-
-[rxjs]: https://rxjs-dev.firebaseapp.com/ "RxJS"

.travis.yml

@@ -0,0 +1,20 @@
+const { execSync } = require('child_process');
+const { unlinkSync } = require('fs');
+const glob = require('glob');
+
+const run = (cmd) => execSync(cmd, { cwd: __dirname, stdio: 'inherit' });
+
+run('rm -rf dist/');
+
+run('yarn tsc');
+
+for (const file of ['package.json', 'README.md']) {
+  run(`cp ${file} dist/`);
+}
+
+// Remove test files from output
+for (const file of glob.sync('dist/**/*.test.*')) {
+  unlinkSync(file);
+}
+
+console.log('✔️  Successfully built library to dist folder');

README.md

@@ -0,0 +1,13 @@
+module.exports = {
+  preset: '@lifeomic/jest-config',
+  testMatch: ['<rootDir>/**/*.test.ts'],
+  collectCoverage: true,
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      statements: 100,
+      functions: 100,
+      lines: 100,
+    },
+  },
+};

build.js

@@ -1,60 +1,38 @@
 {
   "name": "@lifeomic/delta",
-  "version": "1.0.0",
+  "version": "0.0.0",
   "description": "Tools for working with data streams in AWS Lambda",
-  "main": "src/index.js",
-  "scripts": {
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "lint": "eslint .",
-    "pretest": "yarn lint",
-    "test": "nyc ava -v"
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "LifeOmic <development@lifeomic.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lifeomic/delta.git"
   },
   "keywords": [
     "aws",
     "lambda",
     "streams"
   ],
-  "author": "LifeOmic <development@lifeomic.com>",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/lifeomic/delta.git"
+  "main": "index.js",
+  "scripts": {
+    "format": "eslint . --fix && prettier . --write",
+    "lint": "eslint . && prettier --check .",
+    "test": "jest",
+    "build": "node build.js"
   },
-  "license": "MIT",
   "devDependencies": {
-    "@lifeomic/eslint-plugin-node": "^1.1.2",
-    "@lifeomic/lambda-tools": "^5.1.1",
-    "ava": "^1.1.0",
-    "coveralls": "^3.0.2",
-    "eslint": "^5.4.0",
-    "luxon": "^1.3.3",
-    "nyc": "^13.1.0",
-    "rxjs": "^6.2.2",
-    "sinon": "^6.1.5",
-    "uuid": "^3.3.2"
-  },
-  "ava": {
-    "failWithoutAssertions": false,
-    "files": [
-      "test/**/*.test.js"
-    ]
-  },
-  "eslintConfig": {
-    "extends": "plugin:@lifeomic/node/recommended"
-  },
-  "nyc": {
-    "branches": 100,
-    "check-coverage": true,
-    "functions": 100,
-    "lines": 100,
-    "statements": 100
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "rxjs": "^6.2.2"
-  },
-  "dependencies": {
-    "lodash": "^4.17.11"
+    "@lifeomic/eslint-config-standards": "^2.1.1",
+    "@lifeomic/jest-config": "^1.1.2",
+    "@lifeomic/typescript-config": "^1.0.3",
+    "@types/jest": "^27.4.1",
+    "eslint": "^8.9.0",
+    "eslint-config-prettier": "^8.4.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.5.1",
+    "ts-jest": "^27.1.3",
+    "typescript": "^4.5.5"
   }
 }

jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  trailingComma: 'all',
+  arrowParens: 'always',
+  singleQuote: true,
+};

package.json

@@ -0,0 +1,16 @@
+module.exports = {
+  branches: ['master'],
+  plugins: [
+    ['@semantic-release/commit-analyzer', { preset: 'conventionalcommits' }],
+    ['@semantic-release/npm', { pkgRoot: 'dist/' }],
+    [
+      '@semantic-release/github',
+      {
+        // Setting this to false disables the default behavior
+        // of opening a GitHub issue when a release fails.
+        // We have other methods of tracking these failures.
+        failComment: false,
+      },
+    ],
+  ],
+};