Initial commit.

Author: neogeek

.eslintrc

@@ -0,0 +1,23 @@
+{
+  "env": {
+    "node": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "error",
+    "@typescript-eslint/no-unused-vars": "error",
+    "no-warning-comments": ["warn", { "terms": ["todo"], "location": "start" }],
+    "no-magic-numbers": [
+      "error",
+      {
+        "ignore": [-1, 0, 1]
+      }
+    ]
+  }
+}

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+
+dist/

.npmignore

@@ -0,0 +1,8 @@
+src/
+
+.eslintrc
+
+.prettierignore
+.prettierrc
+
+tsconfig.json

.prettierignore

@@ -0,0 +1 @@
+dist/

.prettierrc

@@ -0,0 +1,14 @@
+{
+  "arrowParens": "avoid",
+  "singleQuote": true,
+  "tabWidth": 4,
+  "trailingComma": "none",
+  "overrides": [
+    {
+      "files": ["*.json", ".*rc", "*.md"],
+      "options": {
+        "tabWidth": 2
+      }
+    }
+  ]
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Scott Doxey
+
+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

@@ -0,0 +1,69 @@
+# doxdox-fetch
+
+> Fetch utilities for doxdox server.
+
+[![NPM version](https://img.shields.io/npm/v/doxdox-fetch?style=flat-square)](https://www.npmjs.org/package/doxdox-fetch)
+[![NPM downloads per month](https://img.shields.io/npm/dm/doxdox-fetch?style=flat-square)](https://www.npmjs.org/package/doxdox-fetch)
+[![doxdox documentation](https://img.shields.io/badge/doxdox-documentation-%23E85E95?style=flat-square)](https://doxdox.org)
+
+## Install
+
+```bash
+$ npm install doxdox-fetch --save
+```
+
+## Usage
+
+<https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>
+
+**.env**
+
+```yaml
+GITHUB_API_TOKEN_READONLY=xxxxx
+```
+
+**package.json**
+
+```json
+{
+  "type": "module",
+  "dependencies": {
+    "doxdox-fetch": "1.0.0"
+  },
+  "devDependencies": {
+    "dotenv": "16.0.0"
+  },
+  "scripts": {
+    "test": "node -r dotenv/config index.js"
+  },
+  "private": true
+}
+```
+
+**index.js**
+
+```javascript
+import { downloadFile, getRepoData, parseFiles } from 'doxdox-fetch';
+
+(async () => {
+  const data = await getRepoData('neogeek', 'pocket-sized-facade.js');
+
+  const files = await downloadFile(
+    'neogeek',
+    'pocket-sized-facade.js',
+    data.default_branch,
+    [/.js$/, /package.json$/, /\.doxdoxignore$/]
+  );
+
+  const jsFiles = files.filter(
+    ({ path }) => path.match(/\.js$/) && !path.match(/\.min\.js$/)
+  );
+
+  const doc = {
+    ...data,
+    files: await parseFiles(jsFiles)
+  };
+
+  console.log(doc);
+})();
+```