Merge pull request #1 from CodeForBaltimore/initRepo

Init repo

Author: stoopidJSON

.all-contributorsrc

@@ -0,0 +1,34 @@
+{
+  "projectName": "lambda-restful-util",
+  "projectOwner": "CodeForBaltimore",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "eslint", 
+  "contributors": [
+    {
+      "login": "revjtanton",
+      "name": "Jason Anton",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6391564?v=4",
+      "profile": "http://www.jasonanton.com/",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "suryayelagam",
+      "name": "suryayelagam",
+      "avatar_url": "https://avatars.githubusercontent.com/u/17008332?v=4",
+      "profile": "https://github.com/suryayelagam",
+      "contributions": [
+        "review"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7
+}

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc

@@ -0,0 +1,41 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:mocha/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "indent": [
+      "error",
+      2
+    ],
+    "linebreak-style": [
+      "error",
+      "unix"
+    ],
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "semi": [
+      "error",
+      "never"
+    ]
+  },
+  "globals": {
+    "__dirname": true,
+    "__filename": true,
+    "after": true,
+    "before": true,
+    "describe": true,
+    "exports": true,
+    "it": true,
+    "process": true
+  }
+}

.github/workflows/node.js.yml

@@ -5,9 +5,9 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   build:
@@ -20,11 +20,22 @@ jobs:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout repo
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 2
+
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+
+    - name: Install dependencies
+      run: npm ci
+    - run: npm install
+    - name: Run the tests
+      run: npm test && npm run report
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/npm-publish.yml

@@ -17,6 +17,7 @@ jobs:
           node-version: 12
       - run: npm ci
       - run: npm test
+      - run: npm run build
 
   publish-npm:
     needs: build
@@ -28,9 +29,10 @@ jobs:
           node-version: 12
           registry-url: https://registry.npmjs.org/
       - run: npm ci
+      - run: npm build
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
 
   publish-gpr:
     needs: build
@@ -42,6 +44,7 @@ jobs:
           node-version: 12
           registry-url: https://npm.pkg.github.com/
       - run: npm ci
+      - run: npm build
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1,100 @@
+node_modules/
+.node_modules/
+built/*
+dist/
+.env
+.nyc_output
+tests/cases/rwc/*
+tests/cases/test262/*
+tests/cases/perf/*
+!tests/cases/webharness/compilerToString.js
+test-args.txt
+~*.docx
+\#*\#
+.\#*
+tests/baselines/local/*
+tests/baselines/local.old/*
+tests/services/baselines/local/*
+tests/baselines/prototyping/local/*
+tests/baselines/rwc/*
+tests/baselines/test262/*
+tests/baselines/reference/projectOutput/*
+tests/baselines/local/projectOutput/*
+tests/baselines/reference/testresults.tap
+tests/services/baselines/prototyping/local/*
+tests/services/browser/typescriptServices.js
+src/harness/*.js
+src/compiler/diagnosticInformationMap.generated.ts
+src/compiler/diagnosticMessages.generated.json
+src/parser/diagnosticInformationMap.generated.ts
+src/parser/diagnosticMessages.generated.json
+rwc-report.html
+*.swp
+build.json
+*.actual
+tests/webTestServer.js
+tests/webTestServer.js.map
+tests/webhost/*.d.ts
+tests/webhost/webtsc.js
+tests/cases/**/*.js
+!tests/cases/docker/*.js/
+tests/cases/**/*.js.map
+*.config
+scripts/eslint/built/
+scripts/debug.bat
+scripts/run.bat
+scripts/word2md.js
+scripts/buildProtocol.js
+scripts/ior.js
+scripts/authors.js
+scripts/configurePrerelease.js
+scripts/configureLanguageServiceBuild.js
+scripts/open-user-pr.js
+scripts/open-cherry-pick-pr.js
+scripts/processDiagnosticMessages.d.ts
+scripts/processDiagnosticMessages.js
+scripts/produceLKG.js
+scripts/importDefinitelyTypedTests/importDefinitelyTypedTests.js
+scripts/generateLocalizedDiagnosticMessages.js
+scripts/request-pr-review.js
+scripts/*.js.map
+scripts/typings/
+coverage/
+internal/
+**/.DS_Store
+.settings
+**/.vs
+**/.vscode/*
+!**/.vscode/tasks.json
+!**/.vscode/settings.template.json
+!**/.vscode/launch.template.json
+!**/.vscode/extensions.json
+!tests/cases/projects/projectOption/**/node_modules
+!tests/cases/projects/NodeModulesSearch/**/*
+!tests/baselines/reference/project/nodeModules*/**/*
+.idea
+yarn-error.log
+.parallelperf.*
+tests/cases/user/*/package-lock.json
+tests/cases/user/*/node_modules/
+tests/cases/user/*/**/*.js
+tests/cases/user/*/**/*.js.map
+tests/cases/user/*/**/*.d.ts
+!tests/cases/user/zone.js/
+!tests/cases/user/bignumber.js/
+!tests/cases/user/discord.js/
+tests/baselines/reference/dt
+.failed-tests
+TEST-results.xml
+tests/cases/user/TypeScript-React-Starter/TypeScript-React-Starter
+tests/cases/user/TypeScript-Node-Starter/TypeScript-Node-Starter
+tests/cases/user/TypeScript-React-Native-Starter/TypeScript-React-Native-Starter
+tests/cases/user/TypeScript-Vue-Starter/TypeScript-Vue-Starter
+tests/cases/user/TypeScript-WeChat-Starter/TypeScript-WeChat-Starter
+tests/cases/user/create-react-app/create-react-app
+tests/cases/user/fp-ts/fp-ts
+tests/cases/user/webpack/webpack
+tests/cases/user/puppeteer/puppeteer
+tests/cases/user/axios-src/axios-src
+tests/cases/user/prettier/prettier
+.eslintcache

CONTRIBUTING.md

@@ -7,32 +7,17 @@ Please note we have a [CODE OF CONDUCT](/docs/Code_of_Conduct.md), please follow
 
 ## Overview
 
-In this section you should provide a semi-detailed overview of your project. This overview should include a statement of the
-problem you're looking to solve, maybe some bullet points, and a statement defining the solution.
+This project aims to offer simple utilities for API development on AWS Lambda. Some of these utilities may work for other frameworks like Express, however this is just a happy coincidence. 
 
 ### Non Goals
 
-This should be a list of bullets of related features you are not planning to add to the project. This should be adjusted based
-on the maturity of the product. 
-
-### Minimum Viable Product
-
-As with the _Non Goals_ this should be a bulleted list of features you will include in your product. This list can be adjusted 
-based on the maturity of the product.
-
-### Roadmap
-
-Provide an esitmate of when work will be completed, or a link to any kanban boards you may have.
+This product does not aim to offer everything needed for RESTful development on AWS Lambda, just a jump-start. We are getting the low hanging fruit to speed up development, nothing more.
 
 ## Technology and Code
 
-Provide a bulleted list of your applicable tech stack. Below is the standard sentence to link to the Best_Practices doc. You can also link
-to the Tech_Spec.
-
-Please update the [Tech Spec](/docs/Tech_Spec.md) with a full breakdown of the project and workflows then link it here.
+This is an npm package so it's Typescript/Javascript.
 
-Please update the [Best Practices](/docs/Best_Practices.md) with code standards, git standards, and other guidance for writing clean and well 
-documented code then link it here.
+Please see [Best Practices](/docs/Best_Practices.md) for Typescript coding standards.
 
 ### Pull Request Process
 
@@ -52,6 +37,3 @@ The best ways to get in touch with us is via Slack. An active Slack link can be
 ***[codeforbaltimore.org](https://codeforbaltimore.org/)***
 
 You can also reach out to the tech lead [Jason Anton](https://github.com/revjtanton) via email at [jason@codeforbaltimore.org](mailto:jason@codeforbaltimore.org).
-
-## Sources and Links
-Provide any relevant links here.