add license command (#144)

Author: Sebastian McKenzie

src/cli/commands/index.js

@@ -18,6 +18,9 @@ export { ls };
 import * as why from "./why.js";
 export { why };
 
+import * as licenses from "./licenses.js";
+export { licenses };
+
 import * as uninstall from "./uninstall.js";
 export { uninstall };
 

src/cli/commands/install.js

@@ -80,10 +80,12 @@ export class Install {
 
   async fetchRequestFromCwd(excludePatterns?: Array<string> = []): Promise<[
     DependencyRequestPatterns,
-    Array<string>
+    Array<string>,
+    Object
   ]> {
     let patterns = [];
     let deps = [];
+    let manifest = {};
 
     // exclude package names that are in install args
     let excludeNames = [];
@@ -107,6 +109,7 @@ export class Install {
 
         let json = await fs.readJson(loc);
         Object.assign(this.resolutions, json.resolutions);
+        Object.assign(manifest, json);
 
         let pushDeps = (depType, { hint, ignore, optional }) => {
           let depMap = json[depType];
@@ -134,7 +137,7 @@ export class Install {
       }
     }
 
-    return [deps, patterns];
+    return [deps, patterns, manifest];
   }
 
   async init(): Promise<void> {

src/cli/commands/licenses.js

@@ -0,0 +1,93 @@
+/**
+ * Copyright (c) 2016-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
+ */
+
+import type { Reporter } from "../../reporters/index.js";
+import type Config from "../../config.js";
+import { MessageError } from "../../errors.js";
+import { Install } from "./install.js";
+import Lockfile from "../../lockfile/index.js";
+
+export function hasWrapper(flags: Object, args: Array<string>): boolean {
+  return args[0] != "generate-disclaimer";
+}
+
+export function setFlags(commander: Object) {
+  commander.usage("licenses [ls | generate-disclaimer]");
+}
+
+export async function run(
+  config: Config,
+  reporter: Reporter,
+  flags: Object,
+  args: Array<string>
+): Promise<void> {
+  // validate subcommand
+  let cmd = args[0];
+  if (args.length !== 1 || (cmd !== "generate-disclaimer" && cmd !== "ls")) {
+    throw new MessageError(
+      "Invalid subcommand, use `kpm licenses generate-disclaimer` or `kpm licenses ls`"
+    );
+  }
+
+  let lockfile = await Lockfile.fromDirectory(config.cwd, reporter, {
+    silent: true,
+    strictIfPresent: true
+  });
+
+  let install = new Install("ls", flags, args, config, reporter, lockfile);
+
+  let [depRequests,, manifest] = await install.fetchRequestFromCwd();
+  await install.resolver.init(depRequests);
+
+  if (cmd === "generate-disclaimer") {
+    console.log(
+      "THE FOLLOWING SETS FORTH ATTRIBUTION NOTICES FOR THIRD PARTY SOFTWARE THAT MAY BE CONTAINED " +
+      `IN PORTIONS OF THE ${String(manifest.name).toUpperCase().replace(/-/g, " ")} PRODUCT.`
+    );
+    console.log();
+
+    // get manifests and sort them by package name
+    let manifests = install.resolver.getManifests();
+    manifests = manifests.sort((a, b) => {
+      if (!a.name && !b.name) return 0;
+      if (!a.name) return 1;
+      if (!b.name) return -1;
+      return a.name.localeCompare(b.name);
+    });
+
+    for (let { name, license, licenseText, repository } of manifests) {
+      console.log("-----");
+      console.log();
+
+      let heading = [];
+      heading.push(`The following software may be included in this product: ${name}.`);
+
+      let url = repository && repository.url;
+      if (url) {
+        heading.push(`A copy of the source code may be downloaded from ${url}.`);
+      }
+
+      heading.push("This software contains the following license and notice below:");
+
+      console.log(heading.join(" "));
+      console.log();
+
+      if (licenseText) {
+        console.log(licenseText.trim());
+      } else {
+        // what do we do here? base it on `license`?
+        license;
+      }
+
+      console.log();
+    }
+  }
+}

src/cli/index.js

@@ -95,7 +95,9 @@ let config = new Config(reporter, {
 });
 
 // print header
-reporter.header(commandName, pkg);
+let outputWrapper = true;
+if (command.hasWrapper) outputWrapper = command.hasWrapper(commander, commander.args);
+if (outputWrapper) reporter.header(commandName, pkg);
 
 //
 if (commander.yes) {
@@ -120,7 +122,7 @@ if (command.requireLockfile && !fs.existsSync(path.join(config.cwd, constants.LO
 const run = () => {
   return command.run(config, reporter, commander, commander.args).then(function () {
     reporter.close();
-    reporter.footer(false);
+    if (outputWrapper) reporter.footer(false);
   });
 };
 

src/types.js

@@ -48,6 +48,21 @@ export type Manifest = {
   name: string,
   version: string,
 
+  license?: string,
+  licenseText?: string,
+
+  readme?: string,
+  readmeFilename?: string,
+
+  repository?: {
+    type: "git",
+    url: string
+  },
+
+  bugs?: {
+    url: string
+  },
+
   // the package reference that we pass around as a minimal way to refer to it
   reference?: ?PackageReference,
 

src/util/normalise-manifest/fix.js

@@ -168,14 +168,16 @@ export default async function (info: Object, moduleLoc: string): Promise<void> {
 
   // infer license file
   // TODO: show that this were inferred and may not be accurate
-  if (!info.license) {
-    let licenseFile = _.find(files, (filename) => {
-      let lower = filename.toLowerCase();
-      return lower === "license" || lower.indexOf("license.") === 0;
-    });
+  let licenseFile = _.find(files, (filename) => {
+    let lower = filename.toLowerCase();
+    return lower === "license" || lower.indexOf("license.") === 0;
+  });
+
+  if (licenseFile) {
+    let licenseContent = await fs.readFile(path.join(moduleLoc, licenseFile));
+    info.licenseText = licenseContent;
 
-    if (licenseFile) {
-      let licenseContent = await fs.readFile(path.join(moduleLoc, licenseFile));
+    if (!info.license) {
       info.license = inferLicense(licenseContent) || inferLicense(info.readme);
     }
   }

src/util/normalise-manifest/infer-license.js

@@ -21,7 +21,7 @@ export default function (license: string): ?string {
   for (let licenseName in REGEXES) {
     for (let regex of REGEXES[licenseName]) {
       if (regex.test(license)) {
-        return licenseName;
+        return `${licenseName}*`;
       }
     }
   }