npm-pkgbuild 11.7.7 → 11.7.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "11.7.7",
+  "version": "11.7.9",
   "publishConfig": {
     "access": "public"
   },
@@ -36,8 +36,9 @@
     "test:ava": "ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --moduleResolution nodenext ./src/*.mjs"
   },
   "dependencies": {
     "@npmcli/arborist": "^6.2.7",
@@ -62,11 +63,13 @@
     "tar-stream": "^3.0.0"
   },
   "devDependencies": {
+    "@types/node": "^18.15.11",
     "ava": "^5.2.0",
     "c8": "^7.13.0",
     "documentation": "^14.0.1",
     "semantic-release": "^21.0.1",
-    "stream-buffers": "^3.0.2"
+    "stream-buffers": "^3.0.2",
+    "typescript": "^5.0.4"
   },
   "engines": {
     "node": ">=16.20.0"
@@ -82,7 +85,8 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-esm-only"
+      "arlac77/template-esm-only",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/content/content-provider.mjs

@@ -1,10 +1,13 @@
+import { ContentEntry } from "content-entry";
+
 /**
  * Source of package content.
+ * @property {string} dir
  */
 export class ContentProvider {
   /**
    * List all entries.
-   * @return {asyncIterator<ContentEntry>} all entries
+   * @return {AsyncIterator<ContentEntry>} all entries
    */
   async *[Symbol.asyncIterator]() {
   }

package/src/content/node-modules-content-provider.mjs

@@ -12,6 +12,8 @@ import { shrinkNPM } from "../npm-shrink.mjs";
 
 /**
  * Content from node_modules
+ * 
+ * @property {boolean} withoutDevelpmentDependencies
  */
 export class NodeModulesContentProvider extends ContentProvider {
   /**

package/src/extract-from-package.mjs

@@ -8,6 +8,7 @@ import { NPMPackContentProvider } from "./content/npm-pack-content-provider.mjs"
 import { NodeModulesContentProvider } from "./content/node-modules-content-provider.mjs";
 import { FileContentProvider } from "./content/file-content-provider.mjs";
 import { NFTContentProvider } from "./content/nft-content-provider.mjs";
+import { ContentProvider } from "./content/content-provider.mjs";
 import { DEBIAN } from "./output/debian.mjs";
 import { ARCH } from "./output/arch.mjs";
 import { RPM } from "./output/rpm.mjs";

package/src/npm-shrink.mjs

@@ -1,6 +1,6 @@
 const nameAndVersion = ["name", "version"];
 
-export function shrinkNPM(pkg, options = { removeKeys: nameAndVersion, removeDefaults: flase }) {
+export function shrinkNPM(pkg, options = { removeKeys: nameAndVersion, removeDefaults: false }) {
   const toBeRemoved = [
     "dependencies",
     "sideEffects",

package/src/output/arch.mjs

@@ -32,7 +32,7 @@ function* keyValueLines(key, value, options) {
 }
 
 /**
- * @type KeyValueTransformOptions
+ * @type {Object} KeyValueTransformOptions
  * Options to describe key value pair separated by an equal sign '='
  */
 export const pkgKeyValuePairOptions = {
@@ -208,6 +208,7 @@ function person(contributors) {
 }
 
 const default_attribute = { type: "string" };
+const default_array_attribute = { type: "string[]" };
 
 /**
  * well known package properties
@@ -225,19 +226,19 @@ const fields = {
   license: { type: "string[]", mandatory: true },
   install: { type: "string" },
   changelog: { type: "string" },
-  source: default_attribute,
-  validpgpkeys: default_attribute,
+  source: default_array_attribute,
+  validpgpkeys: default_array_attribute,
   noextract: default_attribute,
-  cksums: default_attribute,
-  md5sums: default_attribute,
-  sha1sums: default_attribute,
-  sha256sums: default_attribute,
-  sha384sums: default_attribute,
-  sha512sums: default_attribute,
-  groups: default_attribute,
-  arch: { default: ["any"], type: "string[]", mandatory: true },
+  cksums: default_array_attribute,
+  md5sums: default_array_attribute,
+  sha1sums: default_array_attribute,
+  sha256sums: default_array_attribute,
+  sha384sums: default_array_attribute,
+  sha512sums: default_array_attribute,
+  groups: default_array_attribute,
+  arch: { ...default_array_attribute, default: ["any"], mandatory: true },
   backup: default_attribute,
-  depends: default_attribute,
+  depends: default_array_attribute,
   makedepends: default_attribute,
   checkdepends: default_attribute,
   optdepends: default_attribute,

package/src/output/docker.mjs

@@ -132,7 +132,7 @@ export class DOCKER extends Packager {
 }
 
 /**
- * @see {https://docs.docker.com/engine/reference/builder/}
+ * @see {@link https://docs.docker.com/engine/reference/builder/}
  */
 const fields = {
   version: { type: "string", mandatory: true },

package/src/output/rpm.mjs

@@ -45,6 +45,9 @@ export function requiresFromDependencies(dependencies) {
   );
 }
 
+/**
+ * produce rpm packages
+ */
 export class RPM extends Packager {
   static get name() {
     return "rpm";
@@ -78,7 +81,10 @@ export class RPM extends Packager {
 
   /**
    * Check for rpmbuild presence.
-   * @returns {boolean} true when rpmbuild is present
+   * @param {Object} options
+   * @param {Object} variant
+   * @param {string} variant.arch
+   * @returns {Promise<boolean>} true when rpmbuild executable is present
    */
   static async prepare(options, variant) {
     try {

package/src/util.mjs

@@ -2,7 +2,12 @@ import { join, dirname } from "node:path";
 import { mkdir } from "node:fs/promises";
 import { pipeline } from "node:stream/promises";
 import { createWriteStream } from "node:fs";
+import { ContentEntry } from "content-entry";
 
+/**
+ * @type {Object}
+ * @property {BufferEncoding} encoding
+ */
 export const utf8StreamOptions = { encoding: "utf8" };
 
 /**
@@ -147,7 +152,6 @@ export function fieldProvider(properties, fields) {
  * @param {AsyncIterator<ContentEntry>} source
  * @param {string} destinationDirectory
  * @param {Expander} expander
- * @param {ContentEntryAttribute[]} attributes
  */
 export async function* copyEntries(
   source,