Add Issue Template (#84)

smashedr · web-flow · commit 955d779ad0f8 · 2024-07-03T17:09:20.000-07:00
* Add Issue Template

* Update Options

* Update README.md

* Add Paths to Test
diff --git a/.github/ISSUE_TEMPLATE/0-bug.yaml b/.github/ISSUE_TEMPLATE/0-bug.yaml
@@ -0,0 +1,39 @@
+name: "⚠️ Report an Issue"
+description: "Something Not Working Right? Please let us know..."
+title: "[Bug] "
+labels: ["bug"]
+assignees:
+  - smashedr
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        All bugs that we can verify will be fixed. Thank you for taking the time to make this report!
+
+  - type: input
+    id: website
+    validations:
+      required: false
+    attributes:
+      label: Site Link
+      description: Please provide a link to the site you are having issues on if possible.
+      placeholder: https://example.com/
+
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: Details
+      description: Please describe the issue you are experiencing and how to reproduce.
+      placeholder: Provide as many details as you can...
+
+  - type: textarea
+    id: logs
+    validations:
+      required: true
+    attributes:
+      label: Paste Support Information
+      description: Open the extension options, scroll to the bottom, click Copy Support Information and paste below.
+      render: shell
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,17 @@
+blank_issues_enabled: true
+contact_links:
+  - name: "💡 Request a Feature"
+    about: Request a New Feature or Enhancement in the Discussions.
+    url: https://github.com/cssnr/link-extractor/discussions/new?category=feature-requests
+
+  - name: "❔ Ask a Question"
+    about: Ask a General Question or start a Discussions.
+    url: https://github.com/cssnr/link-extractor/discussions/new?category=q-a
+
+  - name: "💬 Join Discord"
+    about: Chat with us about Issues, Features, Questions and More.
+    url: https://discord.gg/wXy6m2X8wY
+
+  - name: "📝 Submit Feedback"
+    about: Send General Feedback Anonymously.
+    url: https://cssnr.github.io/feedback
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -3,8 +3,12 @@ name: "Test"
 on:
   push:
     branches: ["master"]
+    paths:
+      - "src/**"
   pull_request:
     branches: ["master"]
+    paths:
+      - "src/**"
   workflow_dispatch:
 
 jobs:
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -5,13 +5,13 @@
   "singleQuote": true,
   "overrides": [
     {
-      "files": ["**/*.html", "**/*.yaml"],
+      "files": ["**/*.html", "**/*.yaml", "**/*.yml"],
       "options": {
         "singleQuote": false
       }
     },
     {
-      "files": ["**/*.json", "**/*.yaml"],
+      "files": ["**/*.json", "**/*.yaml", "**/*.yml"],
       "options": {
         "tabWidth": 2
       }
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
-[![Chrome Web Store Users](https://img.shields.io/chrome-web-store/users/ifefifghpkllfibejafbakmflidjcjfp?logo=google&logoColor=white&label=google%20users)](https://chromewebstore.google.com/detail/link-extractor/ifefifghpkllfibejafbakmflidjcjfp)
-[![Mozilla Add-on Users](https://img.shields.io/amo/users/link-extractor?logo=mozilla&label=mozilla%20users)](https://addons.mozilla.org/addon/link-extractor)
+[![Chrome Web Store Users](https://img.shields.io/chrome-web-store/users/ifefifghpkllfibejafbakmflidjcjfp?logo=google&logoColor=white&label=users)](https://chromewebstore.google.com/detail/link-extractor/ifefifghpkllfibejafbakmflidjcjfp)
+[![Mozilla Add-on Users](https://img.shields.io/amo/users/link-extractor?logo=mozilla&label=users)](https://addons.mozilla.org/addon/link-extractor)
 [![Chrome Web Store Rating](https://img.shields.io/chrome-web-store/rating/ifefifghpkllfibejafbakmflidjcjfp?logo=google&logoColor=white)](https://chromewebstore.google.com/detail/link-extractor/ifefifghpkllfibejafbakmflidjcjfp)
 [![Mozilla Add-on Rating](https://img.shields.io/amo/rating/link-extractor?logo=mozilla&logoColor=white)](https://addons.mozilla.org/addon/link-extractor)
 [![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/ifefifghpkllfibejafbakmflidjcjfp?label=chrome&logo=googlechrome)](https://chromewebstore.google.com/detail/link-extractor/ifefifghpkllfibejafbakmflidjcjfp)
 [![Mozilla Add-on Version](https://img.shields.io/amo/v/link-extractor?label=firefox&logo=firefox)](https://addons.mozilla.org/addon/link-extractor)
 [![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/link-extractor?logo=github)](https://github.com/cssnr/link-extractor/releases/latest)
-[![Build](https://github.com/cssnr/link-extractor/actions/workflows/build.yaml/badge.svg)](https://github.com/cssnr/link-extractor/actions/workflows/build.yaml)
+[![Build](https://img.shields.io/github/actions/workflow/status/cssnr/link-extractor/build.yaml?logo=github&logoColor=white&label=build)](https://github.com/cssnr/link-extractor/actions/workflows/build.yaml)
+[![Test](https://img.shields.io/github/actions/workflow/status/cssnr/link-extractor/test.yaml?logo=github&logoColor=white&label=test)](https://github.com/cssnr/link-extractor/actions/workflows/test.yaml)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_link-extractor&metric=alert_status&label=quality)](https://sonarcloud.io/summary/overall?id=cssnr_link-extractor)
+[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
 # Link Extractor
 
 Modern Chrome Web Extension and Firefox Browser Addon to easily extract, parse, or open all links/domains from a site or text with optional filters.
@@ -18,6 +20,7 @@ Website: https://link-extractor.cssnr.com/
 *   [Features](#features)
     -   [Upcoming](#planned-upcoming-features)
 *   [Configuration](#configuration)
+*   [Support](#support)
 *   [Development](#development)
     -   [Building](#building)
 
@@ -50,6 +53,7 @@ For any issues, bugs or concerns; please [Open an Issue](https://github.com/cssn
 *   Extract Links from Selected Text on any Site
 *   Extract Links from Clipboard or Any Text
 *   Extract Links from All Selected Tabs
+*   Display Additional Link Details and Text
 *   Open Multiple Links in Tabs from Text
 *   Download Links and Domains as a Text File
 *   Copy the Text from a Link via Context Menu
@@ -63,7 +67,6 @@ For any issues, bugs or concerns; please [Open an Issue](https://github.com/cssn
 
 ## Planned Upcoming Features
 
-*   Option to Extract and Display Link Titles
 *   Option to Set Names/Titles for Saved Filters
 *   Option to Extract Using Multiple Filters with AND/OR
 
@@ -73,7 +76,7 @@ For any issues, bugs or concerns; please [Open an Issue](https://github.com/cssn
 
 # Configuration
 
-**Full Documentation:** https://link-extractor.cssnr.com/docs/
+- [View Configuration Documentation on Website](https://link-extractor.cssnr.com/docs/#configure)
 
 You can pin the Addon by clicking the `Puzzle Piece`, find the Link Extractor icon, then;  
 **Chrome,** click the `Pin` icon.  
@@ -86,6 +89,25 @@ Make sure to click`Save Options` when finished.
 
 For more information on regex, see: https://regex101.com/  
 
+# Support
+
+For help using the web extension, utilize any these resources:
+
+- Documentation: https://link-extractor.cssnr.com/docs/
+- Q&A Discussion: https://github.com/cssnr/link-extractor/discussions/categories/q-a
+- Request a Feature: https://github.com/cssnr/link-extractor/discussions/categories/feature-requests
+
+If you are experiencing an issue/bug or getting unexpected results, use:
+
+- Report an Issue: https://github.com/cssnr/link-extractor/issues
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
+- Provide Anonymous Feedback: https://cssnr.github.io/feedback
+
+Logs can be found inspecting the page (Ctrl+Shift+I), clicking on the Console, and; 
+Firefox: toggling Debug logs, Chrome: toggling Verbose from levels dropdown.
+
+Note: When providing anonymous feedback there is no way to follow up and get more information unless you provide a contact method.
+
 # Development
 
 **Quick Start**
diff --git a/src/html/options.html b/src/html/options.html
@@ -184,18 +184,20 @@ <h1>Link Extractor</h1>
     </table>
 
     <p class="fst-italic small mt-3">
-        <a id="copy-support" href="#0">Copy Support/Debugging Information</a> to clipboard.
+        <a id="copy-support" href="#0">Copy Support Information</a> for issue reporting.
     </p>
 
-    <div class="text-center mb-3">
+    <hr class="mt-0">
+
+    <div class="text-center">
         <a class="link-body-emphasis text-decoration-none" target="_blank" rel="noopener"
-           href="https://link-extractor.cssnr.com/docs/">Get Help</a>
+           href="https://link-extractor.cssnr.com/docs/">View Docs</a>
         <svg><use xlink:href="#bi-dot" /></svg>
         <a class="link-body-emphasis text-decoration-none" target="_blank" rel="noopener"
            href="https://github.com/cssnr/link-extractor/discussions/categories/feature-requests">Request Feature</a>
         <svg><use xlink:href="#bi-dot" /></svg>
         <a class="link-body-emphasis text-decoration-none" target="_blank" rel="noopener"
-           href="https://github.com/cssnr/link-extractor/issues">Open Issue</a>
+           href="https://github.com/cssnr/link-extractor/issues">Report Issue</a>
     </div>
 </div> <!-- card-body -->
 </div> <!-- card -->
diff --git a/src/js/options.js b/src/js/options.js
@@ -483,14 +483,12 @@ async function copySupport(event) {
     const permissions = await chrome.permissions.getAll()
     const local = window.localStorage
     const result = [
-        '```',
         `${manifest.name} - ${manifest.version}`,
         navigator.userAgent,
         `permissions.origins: ${JSON.stringify(permissions.origins)}`,
         `options: ${JSON.stringify(options)}`,
         `links-table: ${local['DataTables_links-table_/html/links.html']}`,
         `domains-table: ${local['DataTables_domains-table_/html/links.html']}`,
-        '```',
     ]
     await navigator.clipboard.writeText(result.join('\n'))
     showToast('Support Information Copied.')
diff --git a/tests/test.js b/tests/test.js
@@ -103,6 +103,7 @@ async function scrollPage() {
     await screenshot('popup')
 
     await page.locator('#linksNoWrap').click()
+    await new Promise((resolve) => setTimeout(resolve, 500))
     await screenshot('popup')
 
     // await page.locator('[href="../html/options.html"]').click()

Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,13 @@`
`5`	`5`	`"singleQuote": true,`
`6`	`6`	`"overrides": [`
`7`	`7`	`{`
`8`		`- "files": ["*/.html", "*/.yaml"],`
	`8`	`+ "files": ["*/.html", "*/.yaml", "*/.yml"],`
`9`	`9`	`"options": {`
`10`	`10`	`"singleQuote": false`
`11`	`11`	`}`
`12`	`12`	`},`
`13`	`13`	`{`
`14`		`- "files": ["*/.json", "*/.yaml"],`
	`14`	`+ "files": ["*/.json", "*/.yaml", "*/.yml"],`
`15`	`15`	`"options": {`
`16`	`16`	`"tabWidth": 2`
`17`	`17`	`}`