Add code

Author: PythonCoderAS

README.md

@@ -1,11 +1,16 @@
-# typescript-project-template
-Template repo for new TypeScript projects.
+# @pythoncoderas/get-github-token
 
-This repo assumes the following:
+Get a github token from multiple locations.
 
-* Source code lives in the `src` directory.
-* The main export is located in `src/index.ts`.
-* Tests live in the `test` directory.
-* Each test is name `<name>.test.ts`.
-* The `npm_token`, `app_id`, and `app_private_key` secrets are present in the repo.
-* The code will be a CommonJS module.
+## API
+
+### `getToken(tokenInput?: string | null, environmentVariableName = "GITHUB_TOKEN"): string | null`
+
+Gets a token from the environment or a command line argument.
+
+**Parameters**
+
+* `tokenInput?: string | null` - The token input from the command line.
+* `environmentVariableName: string"` - The environment variable name to check for a token. Defaults to `GITHUB_TOKEN`.
+
+**Returns**: `string | null` - The token if found, otherwise returns `null`.

package-lock.json

@@ -1,7 +1,8 @@
 {
-  "name": "<package-name>",
+  "name": "@pythoncoderas/get-github-token",
+  "private": false,
   "version": "1.0.0",
-  "description": "<package-description>",
+  "description": "Get a github token from multiple locations.",
   "main": "dist/index.js",
   "type": "commonjs",
   "types": "dist/index.d.ts",
@@ -13,16 +14,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/PythonCoderAS/<package-name>.git"
+    "url": "git+https://github.com/PythonCoderAS/get-github-token.git"
   },
   "keywords": [],
   "author": "PythonCoderAS",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/PythonCoderAS/<package-name>/issues"
+    "url": "https://github.com/PythonCoderAS/get-github-token/issues"
   },
-  "homepage": "https://github.com/PythonCoderAS/<package-name>#readme",
+  "homepage": "https://github.com/PythonCoderAS/get-github-token#readme",
   "dependencies": {
+    "dotenv": "^16.0.1"
   },
   "devDependencies": {
     "@types/chai": "^4.3.1",

package.json

@@ -0,0 +1,19 @@
+import "dotenv/config";
+
+/**
+ * Gets a token from the environment or a command line argument.
+ * @param tokenInput The value of the command line argument, if any.
+ * @param environmentVariableName The name of the environment variable to check.
+ * @returns The token.
+ */
+export default function getToken(tokenInput?: string | null, environmentVariableName = "GITHUB_TOKEN"): string | null {
+  if (tokenInput) {
+    return tokenInput;
+  }
+
+  if (process.env[environmentVariableName]) {
+    return process.env[environmentVariableName] || null;
+  }
+
+  return null;
+}