@gesslar/licensed 1.3.0 → 2.0.1

package/README.md

@@ -53,7 +53,7 @@ The returned object has the following shape:
   name: "my-package",        // package name, or null
   license: "MIT",            // SPDX license identifier, or null
   licenseFile: "LICENSE.txt", // detected license filename, or null
-  publicDomain: false,       // true for Unlicense, 0BSD, CC0-1.0, MIT-0
+  publicDomain: false,       // true for Unlicense, CC0-1.0
   dependencies: [
     { name: "lodash", license: "MIT", repo: "https://github.com/lodash/lodash" },
     { name: "private-pkg", license: "Unknown", repo: null },
@@ -93,7 +93,7 @@ const markdown = buildLicenseSection({
 
 ## License
 
-`@gesslar/licensed` is released into the public domain under the [0BSD](LICENSE.txt).
+`@gesslar/licensed` is released under the [0BSD](LICENSE.txt).
 
 This package includes or depends on third-party components under their own
 licenses:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/licensed",
-  "version": "1.3.0",
+  "version": "2.0.1",
   "description": "CLI and library for generating license sections in README.md",
   "repository": {
     "type": "git",
@@ -17,8 +17,8 @@
   "scripts": {
     "clean": "rm -rfv ./dist",
     "build": "mkdir -pv ./dist && npm pack --pack-destination ./dist/",
-    "types": "node -e \"require('fs').rmSync('types',{recursive:true,force:true});\" && tsc -p tsconfig.types.json && sed -i '1{/^#!.*/d}' types/index.d.ts",
-    "exec": "node ./src/index.js",
+    "types": "node -e \"require('fs').rmSync('types',{recursive:true,force:true});\" && tsc -p tsconfig.types.json",
+    "exec": "node ./src/cli.js",
     "test": "node --test tests/**/*.test.js",
     "lint": "eslint src/",
     "submit": "npm publish --access public --//registry.npmjs.org/:_authToken=\"${NPM_ACCESS_TOKEN}\"",
@@ -47,9 +47,9 @@
   ],
   "exports": {
     ".": {
-      "types": "./types/index.d.ts",
-      "default": "./src/index.js"
+      "types": "./types/lib.d.ts",
+      "default": "./src/lib.js"
     }
   },
-  "bin": "./src/index.js"
+  "bin": "./src/cli.js"
 }

package/src/cli.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+import * as TK from "@gesslar/toolkit"
+import {buildLicenseSection, licensed} from "./lib.js"
+
+const cwd = new TK.DirectoryObject(TK.FileSystem.cwd)
+const jsonFile = cwd.getFile("package.json")
+const data = await licensed(jsonFile)
+
+const output = buildLicenseSection({
+  name: data.name,
+  license: data.license,
+  licenseFile: data.licenseFile,
+  depResults: data.dependencies,
+})
+
+TK.Glog(output)

package/src/lib.js

@@ -1,9 +1,10 @@
+import * as TK from "@gesslar/toolkit"
 import {execFile} from "node:child_process"
 import {promisify} from "node:util"
 
 const exec = promisify(execFile)
 
-export const PUBLIC_DOMAIN = ["Unlicense", "0BSD", "CC0-1.0", "MIT-0"]
+const PUBLIC_DOMAIN = ["Unlicense", "CC0-1.0"]
 
 /**
  * Cleans a repository URL to a normalized HTTPS form.
@@ -89,3 +90,34 @@ export function buildLicenseSection({name, license, licenseFile, depResults}) {
 
   return lines.join("\n")
 }
+
+/**
+ * Generates structured license data for a project.
+ *
+ * @param {TK.FileObject} jsonFile - A FileObject pointing to the project's
+ *   package.json.
+ * @returns {Promise<{name: string|null, license: string|null,
+ *   licenseFile: string|null, publicDomain: boolean,
+ *   dependencies: Array<{name: string, license: string,
+ *   repo: string|null}>}>} Structured license data.
+ */
+export async function licensed(jsonFile) {
+  const pkg = await jsonFile.loadData()
+  const cwd = jsonFile.parent
+
+  const licenseFileObj =
+    (await cwd.glob("{LICEN[CS]E,UNLICEN[CS]E}{,.txt,.md}"))?.files[0]
+
+  const deps = Object.keys(pkg.dependencies ?? {}).sort()
+  const depResults = deps.length
+    ? await Promise.all(deps.map(dep => npmView(dep)))
+    : []
+
+  return {
+    name: pkg.name ?? null,
+    license: pkg.license ?? null,
+    licenseFile: licenseFileObj?.name ?? null,
+    publicDomain: PUBLIC_DOMAIN.includes(pkg.license),
+    dependencies: depResults,
+  }
+}

package/types/lib.d.ts

@@ -38,5 +38,26 @@ export function buildLicenseSection({ name, license, licenseFile, depResults }:
         repo: string | null;
     }>;
 }): string;
-export const PUBLIC_DOMAIN: string[];
+/**
+ * Generates structured license data for a project.
+ *
+ * @param {TK.FileObject} jsonFile - A FileObject pointing to the project's
+ *   package.json.
+ * @returns {Promise<{name: string|null, license: string|null,
+ *   licenseFile: string|null, publicDomain: boolean,
+ *   dependencies: Array<{name: string, license: string,
+ *   repo: string|null}>}>} Structured license data.
+ */
+export function licensed(jsonFile: TK.FileObject): Promise<{
+    name: string | null;
+    license: string | null;
+    licenseFile: string | null;
+    publicDomain: boolean;
+    dependencies: Array<{
+        name: string;
+        license: string;
+        repo: string | null;
+    }>;
+}>;
+import * as TK from "@gesslar/toolkit";
 //# sourceMappingURL=lib.d.ts.map

package/types/lib.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../src/lib.js"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,8BAHW,MAAM,GAAC,IAAI,GAAC,SAAS,GACnB,MAAM,GAAC,IAAI,CAWvB;AAED;;;;;;GAMG;AACH,6BAJW,MAAM,GACJ,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,GAAC,IAAI,CAAA;CAAC,CAAC,CAkBvE;AAED;;;;;;;;;;GAUG;AACH,gFAPG;IAAkC,IAAI,EAA9B,MAAM,GAAC,SAAS;IACU,OAAO,EAAjC,MAAM,GAAC,SAAS;IACU,WAAW,EAArC,MAAM,GAAC,SAAS;IAEd,UAAU,EADZ,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,GAAC,IAAI,CAAA;KAAC,CAAC;CAEjE,GAAU,MAAM,CAiClB;AArFD,qCAAsE"}
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../src/lib.js"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,8BAHW,MAAM,GAAC,IAAI,GAAC,SAAS,GACnB,MAAM,GAAC,IAAI,CAWvB;AAED;;;;;;GAMG;AACH,6BAJW,MAAM,GACJ,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,GAAC,IAAI,CAAA;CAAC,CAAC,CAkBvE;AAED;;;;;;;;;;GAUG;AACH,gFAPG;IAAkC,IAAI,EAA9B,MAAM,GAAC,SAAS;IACU,OAAO,EAAjC,MAAM,GAAC,SAAS;IACU,WAAW,EAArC,MAAM,GAAC,SAAS;IAEd,UAAU,EADZ,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,GAAC,IAAI,CAAA;KAAC,CAAC;CAEjE,GAAU,MAAM,CAiClB;AAED;;;;;;;;;GASG;AACH,mCAPW,EAAE,CAAC,UAAU,GAEX,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,GAAC,IAAI,CAAC;IAAC,OAAO,EAAE,MAAM,GAAC,IAAI,CAAC;IACzD,WAAW,EAAE,MAAM,GAAC,IAAI,CAAC;IAAC,YAAY,EAAE,OAAO,CAAC;IAChD,YAAY,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QACnD,IAAI,EAAE,MAAM,GAAC,IAAI,CAAA;KAAC,CAAC,CAAA;CAAC,CAAC,CAqBzB;oBA1HmB,kBAAkB"}

package/src/index.js

@@ -1,54 +0,0 @@
-#!/usr/bin/env node
-
-import * as TK from "@gesslar/toolkit"
-import {buildLicenseSection, npmView, PUBLIC_DOMAIN} from "./lib.js"
-import {fileURLToPath} from "node:url"
-
-/**
- * Generates structured license data for a project.
- *
- * @param {import("@gesslar/toolkit").FileObject} jsonFile - A FileObject
- *   pointing to the project's package.json.
- * @returns {Promise<{name: string|null, license: string|null,
- *   licenseFile: string|null, publicDomain: boolean,
- *   dependencies: Array<{name: string, license: string,
- *   repo: string|null}>}>} Structured license data.
- */
-export async function licensed(jsonFile) {
-  const pkg = await jsonFile.loadData()
-  const cwd = jsonFile.parent
-
-  const licenseFileObj =
-    (await cwd.glob("{LICEN[CS]E,UNLICEN[CS]E}{,.txt,.md}"))?.files[0]
-
-  const deps = Object.keys(pkg.dependencies ?? {}).sort()
-  const depResults = deps.length
-    ? await Promise.all(deps.map(dep => npmView(dep)))
-    : []
-
-  return {
-    name: pkg.name ?? null,
-    license: pkg.license ?? null,
-    licenseFile: licenseFileObj?.name ?? null,
-    publicDomain: PUBLIC_DOMAIN.includes(pkg.license),
-    dependencies: depResults,
-  }
-}
-
-export {buildLicenseSection, cleanUrl, npmView} from "./lib.js"
-
-// CLI mode
-if(process.argv[1] === fileURLToPath(import.meta.url)) {
-  const cwd = new TK.DirectoryObject()
-  const jsonFile = cwd.getFile("package.json")
-  const data = await licensed(jsonFile)
-
-  const output = buildLicenseSection({
-    name: data.name,
-    license: data.license,
-    licenseFile: data.licenseFile,
-    depResults: data.dependencies,
-  })
-
-  TK.Glog(output)
-}

package/types/index.d.ts

@@ -1,23 +0,0 @@
-/**
- * Generates structured license data for a project.
- *
- * @param {import("@gesslar/toolkit").FileObject} jsonFile - A FileObject
- *   pointing to the project's package.json.
- * @returns {Promise<{name: string|null, license: string|null,
- *   licenseFile: string|null, publicDomain: boolean,
- *   dependencies: Array<{name: string, license: string,
- *   repo: string|null}>}>} Structured license data.
- */
-export function licensed(jsonFile: import("@gesslar/toolkit").FileObject): Promise<{
-    name: string | null;
-    license: string | null;
-    licenseFile: string | null;
-    publicDomain: boolean;
-    dependencies: Array<{
-        name: string;
-        license: string;
-        repo: string | null;
-    }>;
-}>;
-export { buildLicenseSection, cleanUrl, npmView } from "./lib.js";
-//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";AAMA;;;;;;;;;GASG;AACH,mCAPW,OAAO,kBAAkB,EAAE,UAAU,GAEnC,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,GAAC,IAAI,CAAC;IAAC,OAAO,EAAE,MAAM,GAAC,IAAI,CAAC;IACzD,WAAW,EAAE,MAAM,GAAC,IAAI,CAAC;IAAC,YAAY,EAAE,OAAO,CAAC;IAChD,YAAY,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QACnD,IAAI,EAAE,MAAM,GAAC,IAAI,CAAA;KAAC,CAAC,CAAA;CAAC,CAAC,CAqBzB"}