feat: Convert to Node Module Template

.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  root: true, // Tells eslint this is the root configuration and not to search any further up the filesystem
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  plugins: [
+    // Load the following plugin packages
+    '@typescript-eslint', // Plugin for working with Typescript
+    'import',
+    'mocha',
+  ],
+  extends: [
+    // Extend the following configurations
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'airbnb-typescript/base',
+    'plugin:mocha/recommended',
+    'plugin:prettier/recommended', // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+  ],
+  rules: {
+    // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
+    // e.g. "@typescript-eslint/explicit-function-return-type": "off",
+    'mocha/no-mocha-arrows': 'off',
+  },
+};

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+        cache: 'npm'
+    - name: Install Dependencies
+      run: npm ci
+
+    - name: Check formatting and linting
+      run: npm run lint
+
+    - name: Run Tests
+      run: npm run test
+
+    - name: Run Coverage
+      run: npm run coverage

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+        registry-url: https://registry.npmjs.org/
+        cache: 'npm'
+    - name: Install Dependencies
+      run: npm ci
+
+    - name: Check formatting and linting
+      run: npm run lint
+
+    - name: Run Tests
+      run: npm run test
+
+    - name: Run Coverage
+      run: npm run coverage
+
+    - name: Publish
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,14 @@
+# Compiled Typescript
+dist/
+
+# Dependency directories
+node_modules/
+
+# Output of 'npm pack'
+*.tgz
+
+# Istanbul coverage output
+.nyc_output
+
+# OS specific files
+.DS_Store

.mocharc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  color: true,
+  extension: ['.test.ts'],
+  ignore: ['node_modules'],
+  recursive: true,
+  require: ['ts-node/register', 'source-map-support/register'],
+  testEnvironment: 'node',
+  ui: 'bdd',
+  'watch-files': ['src', 'test'],
+};

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  tabWidth: 2,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all'
+}

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+## Workflow
+
+- Fork and clone the project
+- Install dependencies
+
+```sh
+npm install
+```
+
+- Run the lint and format checks
+
+```sh
+npm run lint
+```
+
+- Fix lint / format checks that can be repaired automatically
+
+```sh
+npm run lint-fix
+```
+
+- Make sure to add tests for your changes. Watch the tests
+
+```sh
+npm run test-watch
+```
+
+- When you're ready with your new changes, update the version in the
+  package.json file based on [SemVer standards][semver].
+
+
+[semver]: https://semver.org/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Nicholas Cronquist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,17 @@
-# S3 Helper
+# Node Library Module Template
+
+This is a template project for creating other Node.js library modules and
+publishing them to NPM.
+
+
+## Installation
+
+```sh
+npm install --save-prod --save-exact node-library-module-template
+```
+
+
+## Contributing
+
+See the [CONTRIBUTING](./CONTRIBUTING.md) guide to see the workflow for making
+changes.

nyc.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: '@istanbuljs/nyc-config-typescript',
+  all: true,
+  exclude: [
+    '.eslintrc.js',
+    '.mocharc.js',
+    '.prettierrc.js',
+    'nyc.config.js',
+    'test/**',
+  ]
+}