antsibull-docs - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/cjs/dom.js

@@ -26,3 +26,3 @@ "use strict";
     PartType[PartType["RETURN_VALUE"] = 14] = "RETURN_VALUE";
-})(PartType = exports.PartType || (exports.PartType = {}));
+})(PartType || (exports.PartType = PartType = {}));
 //# sourceMappingURL=dom.js.map

dist/cjs/md.js

@@ -47,6 +47,6 @@ "use strict";
     formatItalic: (part) => `<em>${quoteMD(part.text)}</em>`,
-    formatLink: (part) => `[${quoteMD(part.text)}](${encodeURI(part.url)})`,
+    formatLink: (part) => `[${quoteMD(part.text)}](${quoteMD(encodeURI(part.url))})`,
     formatModule: (part, url) => (url ? `[${quoteMD(part.fqcn)}](${quoteMD(encodeURI(url))})` : `${quoteMD(part.fqcn)}`),
     formatRSTRef: (part) => `${quoteMD(part.text)}`,
-    formatURL: (part) => `[${quoteMD(encodeURI(part.url))}](${encodeURI(part.url)})`,
+    formatURL: (part) => `[${quoteMD(encodeURI(part.url))}](${quoteMD(encodeURI(part.url))})`,
     formatText: (part) => quoteMD(part.text),
@@ -53,0 +53,0 @@ formatEnvVariable: (part) => `<code>${quoteMD(part.name)}</code>`,

dist/esm/md.js

@@ -43,6 +43,6 @@ /*
     formatItalic: (part) => `<em>${quoteMD(part.text)}</em>`,
-    formatLink: (part) => `[${quoteMD(part.text)}](${encodeURI(part.url)})`,
+    formatLink: (part) => `[${quoteMD(part.text)}](${quoteMD(encodeURI(part.url))})`,
     formatModule: (part, url) => (url ? `[${quoteMD(part.fqcn)}](${quoteMD(encodeURI(url))})` : `${quoteMD(part.fqcn)}`),
     formatRSTRef: (part) => `${quoteMD(part.text)}`,
-    formatURL: (part) => `[${quoteMD(encodeURI(part.url))}](${encodeURI(part.url)})`,
+    formatURL: (part) => `[${quoteMD(encodeURI(part.url))}](${quoteMD(encodeURI(part.url))})`,
     formatText: (part) => quoteMD(part.text),
@@ -49,0 +49,0 @@ formatEnvVariable: (part) => `<code>${quoteMD(part.name)}</code>`,

package.json

 {
   "name": "antsibull-docs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "TypeScript library for processing Ansible documentation markup",
@@ -17,2 +17,3 @@ "main": "dist/cjs/index.js",
     "tsconfig.json",
+    "CHANGELOG.md",
     "CHANGELOG.rst",
@@ -41,16 +42,26 @@ "LICENSE",
   ],
-  "author": "Felix Fontein (@felixfontein)",
+  "author": {
+    "name": "Felix Fontein",
+    "email": "[e-mail]"
+  },
   "license": "BSD-2-Clause",
-  "repository": "https://github.com/ansible-community/antsibull-docs-ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ansible-community/antsibull-docs-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ansible-community/antsibull-docs-ts/issues"
+  },
   "devDependencies": {
-    "@types/jest": "^29.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "@typescript-eslint/parser": "^5.54.0",
-    "eslint": "^8.35.0",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.4",
-    "ts-jest": "^29.0.5",
-    "typescript": "^5.0.2",
-    "yaml": "^2.2.1"
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.0.1",
+    "@typescript-eslint/parser": "^7.0.1",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3",
+    "yaml": "^2.3.4"
   }
 }

README.md

@@ -9,2 +9,3 @@ <!--
 
+[![Discuss on Matrix at #antsibull:ansible.com](https://img.shields.io/matrix/antsibull:ansible.com.svg?server_fqdn=ansible-accounts.ems.host&label=Discuss%20on%20Matrix%20at%20%23antsibull:ansible.com&logo=matrix)](https://matrix.to/#/#antsibull:ansible.com)
 [![REUSE badge](https://github.com/ansible-community/antsibull-docs-ts/actions/workflows/reuse.yml/badge.svg)](https://github.com/ansible-community/antsibull-docs-ts/actions/workflows/reuse.yml)
@@ -14,3 +15,3 @@ [![TypeScript badge](https://github.com/ansible-community/antsibull-docs-ts/actions/workflows/typescript.yml/badge.svg)](https://github.com/ansible-community/antsibull-docs-ts/actions/workflows/typescript.yml)
 
-This is a TypeScript library for processing Ansible documentation markup. It is named after [the Python package of the same name](https://github.com/ansible-community/antsibull-docs/).
+This is a TypeScript library for processing Ansible documentation markup. It is named after [the Python package of the same name](https://github.com/ansible-community/antsibull-docs/). It is the TypeScript/JavaScript version of the Python [antsibull-docs-parser](https://github.com/ansible-community/antsibull-docs-parser/) package, which is used by antsibull-docs.
 
@@ -17,0 +18,0 @@ ## How to use this

src/md.ts

@@ -52,6 +52,6 @@ /*
   formatItalic: (part) => `<em>${quoteMD(part.text)}</em>`,
-  formatLink: (part) => `[${quoteMD(part.text)}](${encodeURI(part.url)})`,
+  formatLink: (part) => `[${quoteMD(part.text)}](${quoteMD(encodeURI(part.url))})`,
   formatModule: (part, url) => (url ? `[${quoteMD(part.fqcn)}](${quoteMD(encodeURI(url))})` : `${quoteMD(part.fqcn)}`),
   formatRSTRef: (part) => `${quoteMD(part.text)}`,
-  formatURL: (part) => `[${quoteMD(encodeURI(part.url))}](${encodeURI(part.url)})`,
+  formatURL: (part) => `[${quoteMD(encodeURI(part.url))}](${quoteMD(encodeURI(part.url))})`,
   formatText: (part) => quoteMD(part.text),
@@ -58,0 +58,0 @@ formatEnvVariable: (part) => `<code>${quoteMD(part.name)}</code>`,

tsconfig.json

@@ -1,6 +0,1 @@
-/*
-  Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
-  SPDX-FileCopyrightText: Ansible Project
-  SPDX-License-Identifier: BSD-2-Clause
-*/
 {
@@ -7,0 +2,0 @@ "compilerOptions": {

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

411494

increased by2.97%

Number of package files

97

increased by1.04%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

119

increased by0.85%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

10

increased by11.11%

Lines of code

4291

decreased by-0.12%

No dependency changes