From 0a6098f209677580f2c7b1e54f08e43baed0ba97 Mon Sep 17 00:00:00 2001
From: Seth Falco <seth@falco.fun>
Date: Sun, 11 Jul 2021 00:53:31 +0200
Subject: [PATCH] feat: add option to include file url

---
 README.md                                    |  6 ++++--
 package.json                                 | 10 ++++++++--
 src/extension.ts                             |  5 +----
 src/providers/github-gitignore-api.ts        |  9 ++++++++-
 src/providers/github-gitignore-repository.ts |  8 ++++++++
 5 files changed, 29 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index ec12544..40c0b0b 100644
--- a/README.md
+++ b/README.md
@@ -20,8 +20,10 @@ Start command palette (with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> or <kb
 
 ```JavaScript
 {
-    // Number of seconds the list of `.gitignore` files retrieved from github will be cached
-    "gitignore.cacheExpirationInterval": 3600
+	// Number of seconds the list of `.gitignore` files retrieved from GitHub will be cached.
+	"gitignore.cacheExpirationInterval": 3600,
+	// Prepend a comment with the URL to the file on GitHub.
+	"gitignore.includeUrl": false
 }
 ```
 
diff --git a/package.json b/package.json
index 9ded372..f27cbb0 100644
--- a/package.json
+++ b/package.json
@@ -43,7 +43,12 @@
 				"gitignore.cacheExpirationInterval": {
 					"type": "integer",
 					"default": 3600,
-					"description": "Number of seconds the list of `.gitignore` files retrieved from github will be cached"
+					"description": "Number of seconds the list of `.gitignore` files retrieved from GitHub will be cached."
+				},
+				"gitignore.includeUrl": {
+					"type": "boolean",
+					"default": false,
+					"description": "Prepend a comment with the URL to the file on GitHub."
 				}
 			}
 		},
@@ -76,7 +81,8 @@
 		"watch-tests": "tsc -p . -w --outDir out",
 		"pretest": "npm run compile-tests && npm run compile && npm run lint",
 		"lint": "eslint src --ext ts",
-		"test": "node ./out/test/runTest.js"
+		"test": "node ./out/test/runTest.js",
+		"test:headless": "xvfb-run -a npm run test"
 	},
 	"devDependencies": {
 		"@types/glob": "^7.2.0",
diff --git a/src/extension.ts b/src/extension.ts
index c6373a7..2bf2f8e 100644
--- a/src/extension.ts
+++ b/src/extension.ts
@@ -6,7 +6,6 @@ import { Cache } from './cache';
 import { GitignoreTemplate, GitignoreOperation, GitignoreOperationType, GitignoreProvider } from './interfaces';
 import { GithubGitignoreRepositoryProvider } from './providers/github-gitignore-repository';
 
-
 class CancellationError extends Error {
 
 }
@@ -15,15 +14,13 @@ interface GitignoreQuickPickItem extends vscode.QuickPickItem {
 	template: GitignoreTemplate;
 }
 
-
 // Initialize
 const config = vscode.workspace.getConfiguration('gitignore');
 const cache = new Cache(config.get('cacheExpirationInterval', 3600));
 
 // Create gitignore repository provider
 const gitignoreRepository: GitignoreProvider = new GithubGitignoreRepositoryProvider(cache);
-//const gitignoreRepository : GitignoreProvider = new GithubGitignoreApiProvider(cache);
-
+// const gitignoreRepository: GitignoreProvider = new GithubGitignoreApiProvider(cache);
 
 /**
  * Resolves the workspace folder by
diff --git a/src/providers/github-gitignore-api.ts b/src/providers/github-gitignore-api.ts
index 24524e1..16f94c6 100644
--- a/src/providers/github-gitignore-api.ts
+++ b/src/providers/github-gitignore-api.ts
@@ -1,9 +1,9 @@
+import * as vscode from 'vscode';
 import * as https from 'https';
 import * as fs from 'fs';
 import * as url from 'url';
 import { WriteStream } from 'fs';
 
-
 import { Cache, CacheItem } from '../cache';
 import { GitignoreProvider, GitignoreTemplate, GitignoreOperation, GitignoreOperationType } from '../interfaces';
 import { getAgent, getDefaultHeaders } from '../http-client';
@@ -86,6 +86,13 @@ export class GithubGitignoreApiProvider implements GitignoreProvider {
 				file.write('\n');
 			}
 
+			const config = vscode.workspace.getConfiguration('gitignore');
+			const includeUrl = config.get('includeUrl', false);
+
+			if (includeUrl) {
+				file.write(`# https://github.com/github/gitignore/blob/main/${operation.template.path}\n`);
+			}
+
 			/*
 			curl \
 				-H "Accept: application/vnd.github.v3.raw" \
diff --git a/src/providers/github-gitignore-repository.ts b/src/providers/github-gitignore-repository.ts
index e8055df..aed5fbe 100644
--- a/src/providers/github-gitignore-repository.ts
+++ b/src/providers/github-gitignore-repository.ts
@@ -1,3 +1,4 @@
+import * as vscode from 'vscode';
 import * as https from 'https';
 import * as fs from 'fs';
 import * as url from 'url';
@@ -120,6 +121,13 @@ export class GithubGitignoreRepositoryProvider implements GitignoreProvider {
 				file.write('\n');
 			}
 
+			const config = vscode.workspace.getConfiguration('gitignore');
+			const includeUrl = config.get('includeUrl', false);
+
+			if (includeUrl) {
+				file.write(`# https://github.com/github/gitignore/blob/main/${operation.template.path}\n`);
+			}
+
 			/*
 			curl \
 				-H "Accept: application/vnd.github.v3.raw" \