@gesslar/licensed 1.0.0

package/UNLICENSE.txt

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@gesslar/licensed",
+  "version": "1.0.0",
+  "description": "Simple CLI to produce license copy for README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gesslar/licensed.git"
+  },
+  "keywords": [],
+  "author": {
+    "name": "gesslar",
+    "url": "https://gesslar.dev"
+  },
+  "license": "Unlicense",
+  "type": "module",
+  "homepage": "https://github.com/gesslar/licensed#readme",
+  "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",
+    "exec": "node ./src/cli.js",
+    "lint": "eslint src/",
+    "submit": "npm publish --access public --//registry.npmjs.org/:_authToken=\"${NPM_ACCESS_TOKEN}\"",
+    "update": "npx npm-check-updates -u && npm install",
+    "pr": "gt submit -p --ai",
+    "patch": "npm version patch",
+    "minor": "npm version minor",
+    "major": "npm version major"
+  },
+  "dependencies": {
+    "@gesslar/toolkit": "^3.42.0"
+  },
+  "devDependencies": {
+    "@gesslar/uglier": "^2.0.0",
+    "eslint": "^10.0.2"
+  },
+  "engines": {
+    "node": ">=v24.13.0"
+  },
+  "files": [
+    "UNLICENSE.txt",
+    "src/**/*.js"
+  ]
+}

package/src/cli.js

@@ -0,0 +1,83 @@
+#!/usr/bin/env node
+
+import * as TK from "@gesslar/toolkit"
+
+import {execFile} from "node:child_process"
+import {promisify} from "node:util"
+
+;(async() => {
+  const exec = promisify(execFile)
+
+  const cwd = new TK.DirectoryObject()
+  const jsonFile = cwd.getFile("package.json")
+  const pkg = await jsonFile.loadData()
+
+  // Detect license file in project root
+  const licenseFile = (await cwd.glob("{LICEN[CS]E,UNLICEN[CS]E}{,.txt,.md}"))?.files[0]
+
+  // Project name without scope
+  const name = pkg.name?.replace(/^@[^/]+\//, "") ?? "this project"
+  const license = pkg.license ?? "Unknown"
+
+  const publicDomain = ["Unlicense", "0BSD", "CC0-1.0"]
+  const phrase = publicDomain.includes(license)
+    ? `${name} is released into the public domain under the`
+    : `${name} is released under the`
+
+  const lines = [
+    "## License",
+    "",
+    phrase,
+    `[${license}](${licenseFile?.name ?? "LICENSE"}).`,
+  ]
+
+  const deps = Object.keys(pkg.dependencies ?? {}).sort()
+
+  if(deps.length) {
+    lines.push(
+      "",
+      "This package includes or depends on third-party components under their own",
+      "licenses:",
+      "",
+      "| Dependency | License |",
+      "| --- | --- |",
+    )
+
+    const results = await Promise.all(deps.map(dep => npmView(dep)))
+
+    for(const {name: dep, license: depLicense, repo} of results) {
+      const link = repo ? `[${dep}](${repo})` : dep
+      lines.push(`| ${link} | ${depLicense} |`)
+    }
+  }
+
+  TK.Glog(lines.join("\n"))
+
+  async function npmView(dep) {
+    try {
+      const {stdout} = await exec(
+        "npm", ["view", dep, "repository.url", "license", "--json"]
+      )
+      const data = JSON.parse(stdout)
+
+      return {
+        name: dep,
+        license: data.license ?? "Unknown",
+        repo: cleanUrl(data["repository.url"]),
+      }
+    } catch {
+      return {name: dep, license: "Unknown", repo: null}
+    }
+  }
+
+  function cleanUrl(raw) {
+    if(!raw)
+      return null
+
+    return raw
+      .replace(/^git\+/, "")
+      .replace(/\.git$/, "")
+      .replace(/^ssh:\/\/git@github\.com/, "https://github.com")
+      .replace(/^git:\/\//, "https://")
+  }
+})()