add contributions, updated format style, and applied style

Luke Goodfellow · Luke Goodfellow · commit d03fc06b664c · 2024-01-10T20:25:57.000Z
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,22 +1,22 @@
 // For format details, see https://aka.ms/devcontainer.json.
 {
-    "name": "Codefresh Support Package",
-    "image": "denoland/deno:1.39.1",
-    "onCreateCommand": "apt-get update && apt-get install git zip -y",
-    "mounts": [
-        "type=bind,source=${localEnv:HOME}/.ssh,target=/root/.ssh,readonly"
-    ],
-    "customizations": {
-        "vscode": {
-            "settings": {
-                "deno.enable": true,
-                "deno.lint": true,
-                "deno.unstable": false
-            },
-            "extensions": [
-                "denoland.vscode-deno",
-                "davidanson.vscode-markdownlint"
-            ]
-        }
+  "name": "Codefresh Support Package",
+  "image": "denoland/deno:1.39.1",
+  "onCreateCommand": "apt-get update && apt-get install git zip -y",
+  "mounts": [
+    "type=bind,source=${localEnv:HOME}/.ssh,target=/root/.ssh,readonly"
+  ],
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "deno.enable": true,
+        "deno.lint": true,
+        "deno.unstable": false
+      },
+      "extensions": [
+        "denoland.vscode-deno",
+        "davidanson.vscode-markdownlint"
+      ]
     }
+  }
 }
diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md
@@ -0,0 +1,38 @@
+# Contributing to Our Project
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Fixing a bug
+- Proposing new features
+- Correct misspellings
+- etc.
+
+## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+
+Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Development
+
+- We utilize Dev Containers for development and VS Code as our IDE.
+  - VSCode extension is `ms-vscode-remote.remote-containers`.
+  - Docker needs to be installed to run the containers.
+  - If extensions are stuck on installing utilize `ctrl + shift + p` and utilize `Developer: Reload Window` command.
+- 2 spaces for indentation rather than tabs.
+- You can try running `deno lint` && `deno fmt` for style unification.
+  - suggest running this command under `/src`.
+- Update [VERSIONS](./VERSION) file when you need a new release version.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.
diff --git a/deno.json b/deno.json
@@ -1,16 +1,16 @@
 {
-    "fmt": {
-        "indentWidth": 4,
-        "lineWidth": 160,
-        "singleQuote": true,
-        "semiColons": true
-    },
-    "tasks": {
-        "pre-compile": "rm -rf ./bin && mkdir ./bin",
-        "compile:linux": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_linux_x86_64 --target=x86_64-unknown-linux-gnu ./src/main.js",
-        "compile:windows": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_windows_x86_64 --target=x86_64-pc-windows-msvc ./src/main.js",
-        "compile:apple_x86_64": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_darwin_x86_64 --target=x86_64-apple-darwin ./src/main.js",
-        "compile:apple_arm64": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_darwin_arm64 --target=aarch64-apple-darwin ./src/main.js",
-        "compile": "deno task pre-compile && deno task compile:linux && deno task compile:windows && deno task compile:apple_x86_64 && deno task compile:apple_arm64"
-    }
+  "fmt": {
+    "indentWidth": 2,
+    "lineWidth": 160,
+    "singleQuote": true,
+    "semiColons": true
+  },
+  "tasks": {
+    "pre-compile": "rm -rf ./bin && mkdir ./bin",
+    "compile:linux": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_linux_x86_64 --target=x86_64-unknown-linux-gnu ./src/main.js",
+    "compile:windows": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_windows_x86_64 --target=x86_64-pc-windows-msvc ./src/main.js",
+    "compile:apple_x86_64": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_darwin_x86_64 --target=x86_64-apple-darwin ./src/main.js",
+    "compile:apple_arm64": "deno compile --config=./deno.json --allow-env --allow-read --allow-write=./ --allow-net --allow-run --output=./bin/cf-support_darwin_arm64 --target=aarch64-apple-darwin ./src/main.js",
+    "compile": "deno task pre-compile && deno task compile:linux && deno task compile:windows && deno task compile:apple_x86_64 && deno task compile:apple_arm64"
+  }
 }
diff --git a/src/codefresh.js b/src/codefresh.js
@@ -2,57 +2,57 @@
 import { parse } from 'https://deno.land/std@0.208.0/yaml/mod.ts';
 
 class Codefresh {
-    async init() {
-        this.apiKey = await this.getEnvVarOrConfig('CF_API_KEY', 'token');
-        this.apiURL = await this.getEnvVarOrConfig('CF_URL', 'url');
+  async init() {
+    this.apiKey = await this.getEnvVarOrConfig('CF_API_KEY', 'token');
+    this.apiURL = await this.getEnvVarOrConfig('CF_URL', 'url');
 
-        this.headers = {
-            Authorization: this.apiKey,
-        };
-        this.baseURL = this.apiURL + `/api`;
-    }
+    this.headers = {
+      Authorization: this.apiKey,
+    };
+    this.baseURL = this.apiURL + `/api`;
+  }
 
-    async getEnvVarOrConfig(envVar, configKey) {
-        if (Deno.env.has(envVar)) {
-            return Deno.env.get(envVar);
+  async getEnvVarOrConfig(envVar, configKey) {
+    if (Deno.env.has(envVar)) {
+      return Deno.env.get(envVar);
+    } else {
+      try {
+        let cfConfig;
+        if (Deno.build.os === 'windows') {
+          cfConfig = parse(await Deno.readTextFile(`${Deno.env.get('USERPROFILE')}/.cfconfig`));
         } else {
-            try {
-                let cfConfig;
-                if (Deno.build.os === 'windows') {
-                    cfConfig = parse(await Deno.readTextFile(`${Deno.env.get('USERPROFILE')}/.cfconfig`));
-                } else {
-                    cfConfig = parse(await Deno.readTextFile(`${Deno.env.get('HOME')}/.cfconfig`));
-                }
-
-                return cfConfig.contexts[cfConfig['current-context']][configKey];
-            } catch (error) {
-                console.error(error);
-            }
+          cfConfig = parse(await Deno.readTextFile(`${Deno.env.get('HOME')}/.cfconfig`));
         }
+
+        return cfConfig.contexts[cfConfig['current-context']][configKey];
+      } catch (error) {
+        console.error(error);
+      }
     }
+  }
 
-    async getAllRuntimes() {
-        try {
-            const response = await fetch(`${this.baseURL}/runtime-environments`, {
-                method: 'GET',
-                headers: this.headers,
-            });
-            const runtimes = await response.json();
-            this.runtimes = runtimes;
-            return runtimes.map((re) => re.metadata.name);
-        } catch (error) {
-            console.error(error);
-        }
+  async getAllRuntimes() {
+    try {
+      const response = await fetch(`${this.baseURL}/runtime-environments`, {
+        method: 'GET',
+        headers: this.headers,
+      });
+      const runtimes = await response.json();
+      this.runtimes = runtimes;
+      return runtimes.map((re) => re.metadata.name);
+    } catch (error) {
+      console.error(error);
     }
+  }
 
-    getRuntimeInfo(name) {
-        try {
-            const runtime = this.runtimes.find((re) => re.metadata.name === name);
-            return runtime;
-        } catch (error) {
-            console.error(error);
-        }
+  getRuntimeInfo(name) {
+    try {
+      const runtime = this.runtimes.find((re) => re.metadata.name === name);
+      return runtime;
+    } catch (error) {
+      console.error(error);
     }
+  }
 }
 
 export { Codefresh };
diff --git a/src/main.js b/src/main.js
