oss-mariner - npm Package Compare versions

Comparing version 0.6.0-beta to 0.7.0-beta

dist/src/gitHubIssueFetcher.js

@@ -43,3 +43,3 @@ "use strict";
                     }
-    	        }
+                }
             }
@@ -46,0 +46,0 @@ }

dist/src/mariner/index.d.ts

@@ -5,3 +5,3 @@ export { DependencyDetailsRetriever } from '../dependency-details-retriever';
 export { Logger, getLogger, setLogger } from '../tab-level-logger';
-export { generateConfluenceMarkdown } from '../Utilities/generateConfluenceMarkdown';
+export { generateConfluenceMarkup as generateConfluenceMarkdown } from '../Utilities/generateConfluenceMarkup';
 export { generateHtml } from '../Utilities/generateHtml';

dist/src/mariner/index.js

@@ -13,5 +13,5 @@ "use strict";
 Object.defineProperty(exports, "setLogger", { enumerable: true, get: function () { return tab_level_logger_1.setLogger; } });
-var generateConfluenceMarkdown_1 = require("../Utilities/generateConfluenceMarkdown");
-Object.defineProperty(exports, "generateConfluenceMarkdown", { enumerable: true, get: function () { return generateConfluenceMarkdown_1.generateConfluenceMarkdown; } });
+var generateConfluenceMarkup_1 = require("../Utilities/generateConfluenceMarkup");
+Object.defineProperty(exports, "generateConfluenceMarkdown", { enumerable: true, get: function () { return generateConfluenceMarkup_1.generateConfluenceMarkup; } });
 var generateHtml_1 = require("../Utilities/generateHtml");
 Object.defineProperty(exports, "generateHtml", { enumerable: true, get: function () { return generateHtml_1.generateHtml; } });

dist/src/Utilities/generateHtml.js

@@ -6,3 +6,3 @@ "use strict";
 const luxon_1 = require("luxon");
-const generateConfluenceMarkdown_1 = require("./generateConfluenceMarkdown");
+const generateConfluenceMarkup_1 = require("./generateConfluenceMarkup");
 function generateHtml(issuesByDependency, maxIssuesAge = 30) {
@@ -16,3 +16,3 @@ const now = luxon_1.DateTime.utc();
         const relevantIssues = issues.filter((issue) => {
-            const ageInWholeDays = generateConfluenceMarkdown_1.calculateAgeInWholeDays(issue.createdAt, now);
+            const ageInWholeDays = generateConfluenceMarkup_1.calculateAgeInWholeDays(issue.createdAt, now);
             return ageInWholeDays < maxIssuesAge;
@@ -36,3 +36,3 @@ });
     relevantIssues.forEach((issue) => {
-        const ageInWholeDays = generateConfluenceMarkdown_1.calculateAgeInWholeDays(issue.createdAt, now);
+        const ageInWholeDays = generateConfluenceMarkup_1.calculateAgeInWholeDays(issue.createdAt, now);
         const title = html_entities_1.encode(issue.title);
@@ -39,0 +39,0 @@ const url = html_entities_1.encode(issue.url);

package.json

 {
     "name": "oss-mariner",
-    "version": "0.6.0-beta",
+    "version": "0.7.0-beta",
     "description": "A node.js library for analyzing open source library dependencies",
@@ -5,0 +5,0 @@ "main": "dist/src/mariner/index.js",

README.md

 # Mariner
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/indeedeng/Mariner.svg)
+![GitHub version](https://img.shields.io/github/v/release/indeedeng/Mariner?color=informational)
+![License](https://img.shields.io/github/license/indeedeng/Mariner)
+![Project language](https://img.shields.io/badge/project%20language-TypeScript-blue)
+![Issues](https://img.shields.io/github/issues/indeedeng/Mariner)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
 
@@ -24,6 +29,2 @@ ## Introduction
 
-### Plans to rename the default branch from master
-
-We anticipate renaming the default branch of this repository from `master` to `main`.
-
 ## Getting Started Using Mariner
@@ -57,10 +58,9 @@
 
-### Optional: Generating Markdown
+### Optional: Generating Markup
 
-- You can generate markdown for use in Confluence/jira
-- The generateConfluenceMarkdown() creates the markdown based on two parameters: `maxIssuesAge` and `issuesByDependency`
+- You can generate markup for use in Confluence/jira
+- The generateConfluenceMarkup() creates the markup based on two parameters: `maxIssuesAge` and `issuesByDependency`
 - `maxIssueAge` defaults to 30 days, anything over 30 days won't get written, You can edit this number.
 - Square brackets and curly braces in issue titles will be replaced by parentheses.
-- You can see an example of how to use in the `runExample.ts` file.
-Example of confluenceMarkdown.md output:
+- Example of confluenceMarkup output:
 
@@ -81,5 +81,2 @@ ```md
 
-- The `runExample.ts` example now demonstrates how to call this new function
-  - <https://github.com/indeedeng/Mariner/blob/master/examples/runExample.ts>
-
 ### Config.json Format
@@ -86,0 +83,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

72269

increased by3.4%

Number of package files

31

increased by6.9%

Lines of code

1104

increased by4.94%

Worsened metrics

Number of lines in readme file

250

decreased by-1.19%

No dependency changes