Initial commit

psanders · web-flow · commit e3b28d3b4392 · 2023-09-01T22:04:48.000-04:00
diff --git a/.dockerignore b/.dockerignore
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,37 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "no-loops",
+    "prettier",
+    "notice"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "google",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "rules": {
+    "quotes": [
+      "error",
+      "double"
+    ],
+    "notice/notice": [
+      "error",
+      {
+        "mustMatch": "Licensed under the MIT License",
+        "templateFile": ".scripts/copyright.js"
+      }
+    ],
+    "no-loops/no-loops": 2,
+    "no-console": 1,
+    "prettier/prettier": 2
+  }
+}
diff --git a/.github/workflows/gh_docker.yml b/.github/workflows/gh_docker.yml
@@ -0,0 +1,19 @@
+name: publish to docker hub
+on: [push, workflow_dispatch]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Get the version
+        id: get_version
+        run: echo ::set-output name=VERSION::$(node -e "console.log(require('./package.json').version)")        
+      - name: Publish
+        uses: elgohr/Publish-Docker-Github-Action@master
+        with:
+          name: fonoster/nodejs-service
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+          workdir: .
+          tags: "latest, ${{ steps.get_version.outputs.VERSION }}"
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+.env*
+node_modules
+*.log
+reporting/*
+out/*
+dist
+coverage
+.nyc_output
diff --git a/.gitpod.yml b/.gitpod.yml
@@ -0,0 +1,28 @@
+## Learn more about this file at 'https://www.gitpod.io/docs/references/gitpod-yml'
+##
+## This '.gitpod.yml' file when placed at the root of a project instructs
+## Gitpod how to prepare & build the project, start development environments
+## and configure continuous prebuilds. Prebuilds when enabled builds a project
+## like a CI server so you can start coding right away - no more waiting for
+## dependencies to download and builds to finish when reviewing pull-requests
+## or hacking on something new.
+##
+tasks:
+  - name: Setup & start
+    init: npm install
+    command: npm start
+
+ports:
+  - port: 3000
+    visibility: public
+    onOpen: notify
+
+github:
+  prebuilds:
+    master: true
+    branches: true
+    pullRequests: true
+    pullRequestsFromForks: true
+    addCheck: true
+    addComment: false
+    addBadge: true
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test
+npm run format
+npm run lint
diff --git a/.mocharc.json b/.mocharc.json
@@ -0,0 +1,8 @@
+{
+  "extension": [
+    "ts"
+  ],
+  "timeout": 5000,
+  "exit": true,
+  "require": "ts-node/register"
+}
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,11 @@
+node_modules
+.nyc_output
+coverage
+src
+test
+*.log
+README.md
+tsconfig.json
+.dockerignore
+.mocharc.json
+*.ts
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+**/dist
+**/package-lock.json
+**/*.md
+**/generated/*
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "trailingComma": "none",
+  "singleQuote": false,
+  "printWidth": 80,
+  "bracketSpacing": true,
+  "useTabs": false,
+  "tabWidth": 2
+}
diff --git a/.scripts/copyright.js b/.scripts/copyright.js
@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) <%= YEAR %> by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of nodejs-service
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
diff --git a/.scripts/docs-generator.js b/.scripts/docs-generator.js
@@ -0,0 +1,35 @@
+#!/usr/bin/node
+"use strict";
+const jsdoc2md = require("jsdoc-to-markdown");
+const fs = require("fs");
+const path = require("path");
+
+/* input and output paths */
+const inputFile = path.join(__dirname, "../dist/src/*.js");
+const outputDir = path.join(__dirname, "../docs");
+
+/* get template data */
+const templateData = jsdoc2md.getTemplateDataSync({ files: inputFile });
+
+jsdoc2md.get
+
+/* reduce templateData to an array of class names */
+const classNames = templateData.reduce((names, identifier) => {
+  if (identifier.kind === "class") names.push(identifier.name);
+  return names;
+}, []);
+
+console.log(templateData);
+
+/* create a documentation file for each class */
+for (const className of classNames) {
+  // Workaround an issue with the inputFile picking up wrong classes
+  if (["Scanner", "Walker", "Parser", "Filter"].includes(className)) continue;
+  const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`;
+  console.log(`rendering ${className}, template: ${template}`);
+  const output = jsdoc2md.renderSync({
+    data: templateData,
+    template: template
+  });
+  fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output);
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# How to contribute
+
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on
+top of things.
+
+## Getting Started
+
+* Fork the repository
+* Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
+* Run the tests. We only take pull requests with passing tests
+
+## Submitting Changes
+
+* Push your changes to your fork
+* Submit a pull request
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,21 @@
+##
+## Build
+##
+FROM node:lts-alpine as builder
+LABEL Fonoster Team <fonosterteam@fonoster.com>
+
+COPY . /build
+WORKDIR /build
+
+RUN npm install && npm run build
+
+##
+## Runner
+##
+FROM gcr.io/distroless/nodejs:18 as runner
+
+COPY --from=builder /build/dist/bundle.js /app/bundle.js
+
+WORKDIR /app
+
+CMD ["./bundle.js"]
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fonoster Inc
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,92 @@
+# Fonoster {Service Name}
+
+> {A short description of the image, same as the Github Repo description.}
+
+{Badges should all be in one row without carriage returns. Replace the {name} with your docker image name.}
+
+<a href="https://gitpod.io/#https://github.com/fonoster/nodejs-service"> <img src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod" alt="Contribute with Gitpod" /> </a> [![publish to docker hub](https://github.com/fonoster/nodejs-service/actions/workflows/gh_docker.yml/badge.svg)](https://github.com/fonoster/nodejs-service/actions/workflows/gh_docker.yml)
+
+{Longer description of what the image provides.}
+
+Please read the [documentation](link) on how Fonoster services are created and how to work with them.
+
+## Available Versions
+
+{Keep this as-is, but replace {name} with your Docker image name.}
+
+You can see all images available to pull from Docker Hub via the [Tags]() page. Docker tag names that begin with a "change type" word such as task, bug, or feature are available for testing and may be removed at any time.
+
+## Installation
+
+You can clone this repository and manually build it.
+
+```
+cd fonoster/{service}\:%%VERSION%%
+docker build -t fonoster/{service}:%%VERSION%% .
+```
+
+Otherwise, you can pull this image from the docker index.
+
+```
+docker pull fonoster/{service}:%%VERSION%%
+```
+
+## Usage Example
+
+{An example of running the container. Most Fonoster services use docker-compose, and docker run is also beneficial.}
+
+The following is a basic example of using this image.
+
+```bash
+docker run ...
+```
+
+or with Node:
+
+```bash
+npm i
+npm start
+```
+
+## Specs
+
+Optional specification notes.
+
+{List of packages and tools, H3 section breakouts for more detail}
+
+## Environment Variables
+
+Environment variables are used in the entry point script to render configuration templates. You can specify the values of these variables during `docker run`, `docker-compose up`, or in Kubernetes manifests in the `env` array.
+
+{Each environment variable might have 1-2 sentences of description. For anything longer, we should probably have a sub-section within Specs to elaborate.}
+
+- `EXAMPLE_VAR1` - Example of required variable. **Required**
+- `EXAMPLE_VAR2` - Example of optional variable
+
+## Exposed ports
+
+- `3000` - Default application port for HTTP
+
+## Volumes
+
+- `/your/file/location` - File location
+- `/some/special/script.sh` - List special scripts
+
+## Useful File Locations
+
+- `/some/special/script.sh` - List special scripts
+- `/magic/dir` - And also directories
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://github.com/fonoster/fonoster/blob/master/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests to us.
+
+## Authors
+
+- [Pedro Sanders](https://github.com/psanders)
+
+See the List of contributors who [participated](https://github.com/fonoster/nodejs-service/contributors) in this project.
+
+## License
+
+Copyright (C) 2023 by Fonoster Inc. MIT License (see [LICENSE](https://github.com/fonoster/fonoster/blob/master/LICENSE) for details).
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,14 @@
+version: '3.7'
+
+services:
+  nodejsservice:
+    build:
+      context: .  
+    image: fonoster/nodejsservice:latest
+    restart: always
+    ports:
+      - 3000:3000
+    environment:
+      LOGS_LEVEL: verbose
+      # Uncomment the following line to enable fluent transport
+      # LOGS_TRANSPORT: fluent
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/runner.ts b/src/runner.ts
diff --git a/test/unit.test.ts b/test/unit.test.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/webpack.config.js b/webpack.config.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +**/dist
 +**/package-lock.json
 +**/*.md
 +**/generated/*