Fixed number of new lines added before description in readme

This commit is contained in:
Greg Jacobs
2024-06-06 04:23:49 -04:00
parent 8c28e761e0
commit 3f25aef4f2
2 changed files with 1 additions and 15 deletions

View File

@@ -5,36 +5,28 @@ This project contains several files that perform various tasks. Here's a brief o
# File Summary # File Summary
## [dag.js](src\utils\bookmarklets\dag.js) ## [dag.js](src\utils\bookmarklets\dag.js)
Opens the DAG Task details page(s) based on user input. Opens the DAG Task details page(s) based on user input.
If user provides a comma-separated list of DAG Task numbers, it opens each task's details page in a new tab. If user provides a comma-separated list of DAG Task numbers, it opens each task's details page in a new tab.
If user does not provide any input, it opens the default DAG Tasks page in a new tab.
If user does not provide any input, it opens the default DAG Tasks page in a new tab. If user does not provide any input, it opens the default DAG Tasks page in a new tab.
## [hashid.js](src\utils\bookmarklets\hashid.js) ## [hashid.js](src\utils\bookmarklets\hashid.js)
This JavaScript function takes a string, decodes it using decodeURIComponent, This JavaScript function takes a string, decodes it using decodeURIComponent,
alerts the decoded string, and copies the result to the clipboard. alerts the decoded string, and copies the result to the clipboard.
The function works as follows:
The function works as follows: The function works as follows:
1. Takes a string as input. 1. Takes a string as input.
4. Copies the decoded string to the clipboard.
2. Decodes the string using decodeURIComponent. 2. Decodes the string using decodeURIComponent.
3. Alerts the decoded string. 3. Alerts the decoded string.
4. Copies the decoded string to the clipboard. 4. Copies the decoded string to the clipboard.
## [jira.js](src\utils\bookmarklets\jira.js)
Note: This function uses the Clipboard API which might not be fully supported in all browsers. Note: This function uses the Clipboard API which might not be fully supported in all browsers.
and then opens a new browser tab with the corresponding JIRA page for that ticket.
## [jira.js](src\utils\bookmarklets\jira.js) ## [jira.js](src\utils\bookmarklets\jira.js)
This JavaScript function is a bookmarklet that prompts the user for a JIRA ticket number This JavaScript function is a bookmarklet that prompts the user for a JIRA ticket number
and then opens a new browser tab with the corresponding JIRA page for that ticket. and then opens a new browser tab with the corresponding JIRA page for that ticket.
3. Checks if the user entered a value in the prompt.
The function works as follows: The function works as follows:
1. Prompts the user to enter a JIRA ticket number. The entered value is stored in the `answer` variable. 1. Prompts the user to enter a JIRA ticket number. The entered value is stored in the `answer` variable.
@@ -44,25 +36,19 @@ The process repeats for each security in the array with a delay of 2.5 seconds b
5. Opens the URL in a new browser tab and brings focus to it. 5. Opens the URL in a new browser tab and brings focus to it.
Note: This function is wrapped in a self-invoking function `(function() {...})();` which means it will automatically execute as soon as it is defined. Note: This function is wrapped in a self-invoking function `(function() {...})();` which means it will automatically execute as soon as it is defined.
and then opens a new browser tab for each corresponding Jira page for those MOIDs.
## [moids.js](src\utils\bookmarklets\moids.js) ## [moids.js](src\utils\bookmarklets\moids.js)
2. Sets a default URL to the Jira dashboard.
This JavaScript function is a bookmarklet that prompts the user for multiple MOID (Markit On Demand) numbers This JavaScript function is a bookmarklet that prompts the user for multiple MOID (Markit On Demand) numbers
and then opens a new browser tab for each corresponding Jira page for those MOIDs. and then opens a new browser tab for each corresponding Jira page for those MOIDs.
The function works as follows: The function works as follows:
1. Prompts the user to enter MOID numbers separated by commas. The entered values are stored in the `answers` array. 1. Prompts the user to enter MOID numbers separated by commas. The entered values are stored in the `answers` array.
2. Sets a default URL to the Jira dashboard. 2. Sets a default URL to the Jira dashboard.
3. Checks if the user entered any values in the prompt. 3. Checks if the user entered any values in the prompt.
4. If the user entered values, changes the URL to point to the specific Jira page for each entered MOID number. 4. If the user entered values, changes the URL to point to the specific Jira page for each entered MOID number.
5. Opens each URL in a new browser tab and brings focus to the last opened tab. 5. Opens each URL in a new browser tab and brings focus to the last opened tab.
and saves the updated flags back to the session storage when the user clicks the save button.
Note: This function is wrapped in a self-invoking function `(function() {...})();` which means it will automatically execute as soon as it is defined. Note: This function is wrapped in a self-invoking function `(function() {...})();` which means it will automatically execute as soon as it is defined.
## [rbc-di-featureflags.js](src\utils\bookmarklets\rbc-di-featureflags.js) ## [rbc-di-featureflags.js](src\utils\bookmarklets\rbc-di-featureflags.js)

View File

@@ -26,7 +26,7 @@ fs.readdir(utilsDir, (err, files) => {
if (stats.isFile()) { if (stats.isFile()) {
const fileContent = fs.readFileSync(filePath, 'utf8'); const fileContent = fs.readFileSync(filePath, 'utf8');
const description = getFileDescription(fileContent); const description = getFileDescription(fileContent);
fileLinks.push(`## [${file}](${path.relative(resolvedPath, filePath)})\n\n${description}`); fileLinks.push(`## [${file}](${path.relative(resolvedPath, filePath)})\n${description}`);
} else if (stats.isDirectory()) { } else if (stats.isDirectory()) {
fileLinks.push(...readDirectory(filePath)); fileLinks.push(...readDirectory(filePath));
} }