npm-pkgbuild 7.20.2 → 7.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "7.20.2",
+  "version": "7.21.0",
   "publishConfig": {
     "access": "public"
   },

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

@@ -1,12 +1,13 @@
 import { tmpdir } from "os";
 import { join } from "path";
-import { cp, mkdtemp, readFile, writeFile } from "fs/promises";
+import { mkdtemp, readFile, writeFile } from "fs/promises";
 import { globby } from "globby";
 import Arborist from "@npmcli/arborist";
+import { StringContentEntry } from "content-entry";
 import { FileSystemEntry } from "content-entry-filesystem";
 import { ContentProvider } from "./content-provider.mjs";
 import { utf8StreamOptions } from "../util.mjs";
-
+import { shrinkNPM } from "../npm-shrink.mjs";
 /**
  * Content from node_modules
  */
@@ -46,77 +47,125 @@ export class NodeModulesContentProvider extends ContentProvider {
     );
 
     const arb = new Arborist({ path: tmp });
-    await arb.buildIdealTree({ update: true, prune: true, saveType: "prod" });
+    await arb.buildIdealTree({
+      rm: ["@types/node"],
+      update: true,
+      prune: true,
+      saveType: "prod"
+    });
     await arb.prune({ saveType: "prod" });
     await arb.reify({ save: true });
 
     for (const name of await globby("node_modules/**/*", {
       cwd: tmp
     })) {
-      if (
-        !name.match(
-          /(~|\.map|\.ts|\.orig|\.log|\.tmp|\.bak|\.bat|\.gyp|yarn\.lock|\.DS_Store|\.travis\.yml|\.jshint(rc)?|\.npm.*|\.git.*|rollup\.config\.(js|mjs|cjs)|UPGRAD(E|ING)(\.md)?|AUTHORS(\.md)?|CONTRIBUT(ORS|ING)(.md)?|CHANGELOG(\.md)?|HISTORY(\.md)?|LICENSE(\-\w+|\.md|\.txt)?|README(.*\.md)?|\.o|\.a|\.c|\.cc|\.h|\.in|Makefile|\.cmake|\.mk|\.\d)$/i
-        )
-      ) {
-        yield Object.assign(
-          new FileSystemEntry(name, tmp),
-          this.entryProperties
-        );
+      if (!toBeSkipped.test(name)) {
+        if (name.endsWith("package.json")) {
+          const json = shrinkNPM(
+            JSON.parse(await readFile(join(tmp, name), utf8StreamOptions))
+          );
+
+          if (json) {
+            yield Object.assign(
+              new StringContentEntry(name, JSON.stringify(json)),
+              this.entryProperties
+            );
+          }
+        } else {
+          yield Object.assign(
+            new FileSystemEntry(name, tmp),
+            this.entryProperties
+          );
+        }
       }
     }
   }
 }
 
-const toBeIgnored = [
-  {
-    pattern: [
-      "*.d.ts*",
-      "*.patch",
-      ".jshintrc*",
-      ".esl*",
-      ".zuul.yml",
-      ".doclets.yml",
-      ".editorconfig",
-      ".tern-project",
-      ".dockerignore",
-      ".dir-locals.el",
-      "appveyor.yml",
-      "gulpfile.js",
-      "jsdoc.json",
-      "Gruntfile.js",
-      "karma.conf.js",
-      "verb.md",
-      ".nvmrc",
-      "config.gypi",
-      "bower.json",
-      "*.bash_completion.*",
-      ".coveralls.yml",
-      ".istanbul.yml",
-      ".babelrc.*",
-      ".nycrc",
-      ".env",
-      "x-package.json5",
-      "component.json",
-      "tsconfig.json",
-      "cypress.json",
-      ".airtap.yml",
-      ".jscs.json",
-      "sauce-labs.svg",
-      "PATENTS*",
-      "NOTICE*",
-      "SUMMARY.md",
-      "MIGRAT*.md",
-      "PULL_REQUEST_TEMPLATE.md",
-      "PATTERNS.md",
-      "REFERENCE.md",
-      "SECURITY.md",
-      "SFTPStream.md",
-      "LIMITS.md",
-      "GOVERNANCE.md",
-      "Porting-Buffer.md",
-      "chains and topics.md",
-      "CODE_OF_CONDUCT*",
-      "CODEOWNERS"
-    ]
-  }
-];
+const toBeSkipped = new RegExp(
+  "(" +
+    [
+      "~",
+      "\\.map",
+      "\\.ts",
+      "\\.orig",
+      "\\.log",
+      "\\.tmp",
+      "\\.bak",
+      "\\.bat",
+      "\\.gypi",
+      "\\.gyp",
+      "appveyor\\.yml",
+      "yarn\\.lock",
+      "\\.DS_Store",
+      "jenkinsfile",
+      "\\.travis\\.yml",
+      "\\.jshint(rc)?",
+      "\\.npm.*",
+      "\\.git.*",
+      "rollup\\.config\\.(js|mjs|cjs)",
+      "CODE_OF_CONDUCT(\\.md)?",
+      "GOVERNANCE(\\.md)?",
+      "CODEOWNERS(\\.md)?",
+      "UPGRAD(E|ING)(\\.md)?",
+      "AUTHORS(\\.md)?",
+      "CONTRIBUT(ORS|ING)(\\.md)?",
+      "CHANGELOG(\\.md)?",
+      "HISTORY(\\.md)?",
+      "LICENSE(-w+|\\.md|\\.txt)?",
+      "README(.*\\.md)?",
+      "\\.o",
+      "\\.a",
+      "\\.c",
+      "\\.cc",
+      "\\.h",
+      "\\.in",
+      "Makefile",
+      "\\.cmake",
+      "\\.mk",
+      "\\.d",
+
+      "\\.patch",
+      "\\.esl*",
+      "\\.zuul\\.yml",
+      "\\.doclets\\.yml",
+      "\\.editorconfig",
+      "\\.tern-project",
+      "\\.dockerignore",
+      "\\.dir-locals\\.el",
+      "gulpfile\\.js",
+      "jsdoc\\.json",
+      "Gruntfile\\.js",
+      "karma\\.conf\\.js",
+      "verb\\.md",
+      "\\.nvmrc",
+      "bower\\.json",
+      "\\.bash_completion.*",
+      "\\.coveralls\\.yml",
+      "\\.istanbul\\.yml",
+      "\\.babelrc.*",
+      "\\.nycrc",
+      "\\.env",
+      "x-package\\.json5",
+      "component\\.json",
+      "tsconfig\\.json",
+      "cypress\\.json",
+      "\\.airtap\\.yml",
+      "\\.jscs\\.json",
+      "sauce-labs\\.svg",
+      "PATENTS(\\.md)?",
+      "NOTICE(\\.md)?",
+      "SUMMARY\\.md",
+      "MIGRAT.*\\.md",
+      "PULL_REQUEST_TEMPLATE\\.md",
+      "PATTERNS\\.md",
+      "REFERENCE\\.md",
+      "SECURITY\\.md",
+      "SFTPStream\\.md",
+      "LIMITS\\.md",
+      "Porting-Buffer\\.md",
+      "chains and topics\\.md"
+    ].join("|") +
+    ")$",
+  "i"
+);

package/src/npm-shrink.mjs

@@ -0,0 +1,124 @@
+export function shrinkNPM(pkg) {
+  [
+    "version",
+    "name",
+    "dependencies",
+    "sideEffects",
+    "jspm",
+    "jsnext:main",
+    "man",
+    "files",
+    "directories",
+    "devDependencies",
+    "bundleDependencies",
+    "peerDependencies",
+    "peerDependenciesMeta",
+    "optionalDependencies",
+    "optionalDevDependencies",
+    "sideEffects",
+    "pika",
+    "private",
+    "publishConfig",
+    "repository",
+    "license",
+    "licenses",
+    "changelog",
+    "keywords",
+    "homepage",
+    "bugs",
+    "scripts",
+    "types",
+    "deprecated",
+    "description",
+    "decription",
+    "engine",
+    "engines",
+    "author",
+    "authors",
+    "contributors",
+    "maintainers",
+    "verb",
+    "xo",
+    "prettier",
+    "jest",
+    "remarkConfig",
+    "nyc",
+    "ava",
+    "publishConfig",
+    "typeScriptVersion",
+    "typesPublisherContentHash",
+    "typings",
+    "systemd",
+    "pacman",
+    "pkg",
+    "lintDeps",
+    "icon",
+    "config",
+    "release",
+    "template",
+    "spm",
+    "precommit.silent",
+    "greenkeeper",
+    "bundlesize",
+    "standard",
+    "ignore",
+    "ender",
+    "dojoBuild",
+    "component",
+    "eslintConfig",
+    "env",
+    "commitlint",
+    "standard-version",
+    "lint-staged",
+    "lintStaged",
+    "ci",
+    "husky",
+    "verbiage",
+    "os",
+    "gypfile",
+    "coordinates",
+    "tap",
+    "typesVersions",
+    "node-gyp-build-optional",
+    "node-gyp-build-test",
+    "gitHead",
+    "hallmark",
+    "funding",
+    "eslintIgnore",
+    "react-native",
+    "sharec",
+    "source",
+    "support",
+    "auto-changelog",
+    "readmeFilename",
+    "readme",
+    "node-gyp-build-optional",
+    "node-gyp-build-test"
+  ].map(key => {
+    delete pkg[key];
+  });
+
+  switch (pkg.main) {
+    case "index":
+    case "./index":
+    case "index.js":
+    case "./index.js":
+    case "":
+      delete pkg.main;
+  }
+
+  for (const key of Object.keys(pkg)) {
+    if (key[0] === "_") {
+      delete pkg[key];
+    }
+  }
+
+  for (const toBeRemoved of ["types", "unpkg", "shim", "browser", "testling"]) {
+    // TODO mark files as to be skipped
+
+    delete pkg[toBeRemoved];
+  }
+
+  return Object.keys(pkg).length === 0 ? undefined : pkg
+}
+

package/src/output/rpm.mjs

@@ -37,7 +37,7 @@ export class RPM extends Packager {
       named: {
         staging: "BUILDROOT"
       },
-      others: ["RPMS", "SRPMS", "SOURCES", "SPECS"],
+      others: ["RPMS", "SRPMS", "SOURCES", "SPECS"]
     };
   }
 
@@ -51,7 +51,8 @@ export class RPM extends Packager {
   }
 
   async execute(sources, transformer, dependencies, options, expander) {
-    const { properties, tmpdir, staging, destination } = await this.prepareExecute(options);
+    const { properties, tmpdir, staging, destination } =
+      await this.prepareExecute(options);
 
     properties.Requires = Object.entries(dependencies)
       .map(([n, e]) => `${n}${e}`)
@@ -125,12 +126,14 @@ export class RPM extends Packager {
       console.log(rpmbuild.stdout);
     }
 
+    const packageFile = join(destination, this.packageFileName);
+
     await cp(
       join(tmpdir, "RPMS", properties.arch, this.packageFileName),
-      join(destination, this.packageFileName),
+      packageFile,
       { preserveTimestamps: true }
     );
-    return join(destination, this.packageFileName);
+    return packageFile;
   }
 }
 

package/src/npm-cleanup.mjs

@@ -1,164 +0,0 @@
-import { unlink, readFile, writeFile } from "fs/promises";
-import { globby} from "globby";
-import { join, dirname } from "path";
-import { utf8StreamOptions } from "./util.mjs";
-
-async function rm(file) {
-  try {
-    console.log("rm", file);
-    return await unlink(file);
-  } catch (error) {
-    console.log(error);
-  }
-}
-
-async function iterate(o, cb) {
-  switch (typeof o) {
-    case "string":
-      return cb(o);
-  }
-
-  if (Array.isArray(o)) {
-    for (const x of o) {
-      await iterate(x, cb);
-    }
-  }
-  for (const k in o) {
-    await iterate(o[k], cb);
-  }
-}
-
-const blacklist = new Set(["parse-client-options", "@octokit/rest"]);
-
-export async function cleanup(context, stagingDir) {
-  for (const name of await globby(["**/package.json"], {
-    cwd: stagingDir
-  })) {
-    const pkgFile = join(stagingDir, name);
-    const pkg = JSON.parse(await readFile(pkgFile, utf8StreamOptions));
-
-    if (!blacklist.has(pkg.name)) {
-      console.log(`cleanup ${pkgFile}`);
-
-      // unused files may also be deleted
-      await Promise.all(
-        ["types", "unpkg", "shim", "browser", "testling", "source"].map(
-          async key => {
-            await iterate(pkg[key], async o => rm(join(dirname(pkgFile), o)));
-            delete pkg[key];
-          }
-        )
-      );
-
-      [
-        "version",
-        "name",
-        "dependencies",
-        "sideEffects",
-        "jspm",
-        "jsnext:main",
-        "man",
-        "files",
-        "directories",
-        "devDependencies",
-        "bundleDependencies",
-        "peerDependencies",
-        "optionalDependencies",
-        "sideEffects",
-        "pika",
-        "private",
-        "publishConfig",
-        "repository",
-        "license",
-        "licenses",
-        "changelog",
-        "keywords",
-        "homepage",
-        "bugs",
-        "scripts",
-        "types",
-        "deprecated",
-        "description",
-        "decription",
-        "engine",
-        "engines",
-        "author",
-        "authors",
-        "contributors",
-        "maintainers",
-        "verb",
-        "xo",
-        "prettier",
-        "jest",
-        "remarkConfig",
-        "nyc",
-        "ava",
-        "publishConfig",
-        "typeScriptVersion",
-        "typesPublisherContentHash",
-        "typings",
-        "systemd",
-        "pacman",
-        "lintDeps",
-        "icon",
-        "config",
-        "release",
-        "template",
-        "spm",
-        "precommit.silent",
-        "greenkeeper",
-        "bundlesize",
-        "standard",
-        "ignore",
-        "ender",
-        "dojoBuild",
-        "component",
-        "eslintConfig",
-        "env",
-        "commitlint",
-        "standard-version",
-        "lint-staged",
-        "lintStaged",
-        "ci",
-        "husky",
-        "verbiage",
-        "os",
-        "gypfile",
-        "coordinates",
-        "tap",
-        "typesVersions",
-        "node-gyp-build-optional",
-        "node-gyp-build-test",
-        "gitHead",
-        "hallmark",
-        "funding",
-        "eslintIgnore",
-        "react-native",
-        "sharec"
-      ].map(key => {
-        delete pkg[key];
-      });
-
-      for (const key of Object.keys(pkg)) {
-        if (key[0] === "_") {
-          delete pkg[key];
-        }
-      }
-
-      switch (pkg.main) {
-        case "index":
-        case "./index":
-        case "index.js":
-        case "./index.js":
-        case "":
-          delete pkg.main;
-      }
-
-      if (Object.keys(pkg).length === 0 || pkg.type === "module") {
-        await unlink(pkgFile);
-      } else {
-        await writeFile(pkgFile, JSON.stringify(pkg), utf8StreamOptions);
-      }
-    }
-  }
-}