wikibase-cli 20.0.0 → 20.1.0

package/README.md

@@ -55,7 +55,7 @@ See [CHANGELOG.md](CHANGELOG.md) for version info
 ## Dependencies
 
 ### General
-* [NodeJs](https://nodejs.org) **>= v18** (recommended way to install it: use [NVM](https://github.com/creationix/nvm) to install the latest LTS version `nvm install --lts`)
+* [NodeJS](https://nodejs.org) **>= v20.12.0** (Older NodeJS versions can be used for older wikibase-cli version, see [changelogs](./CHANGELOG.md). Recommendable way to install NodeJS: you may use [NVM](https://github.com/creationix/nvm) to install the latest LTS version `nvm install --lts`)
 * [Git](https://git-scm.com/)
 
 ### Per feature

package/bin/wb-graph-path.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { map, partition, uniq, without } from 'lodash-es'
+import { map, partition, uniq, values, without } from 'lodash-es'
 import { grey } from 'tiny-chalk'
 import { isEntityId, isPropertyId } from 'wikibase-sdk'
 import errors_ from '#lib/errors'
@@ -8,9 +8,10 @@ import { makeSparqlQuery } from '#lib/make_sparql_query'
 import program from '#lib/program'
 
 await program
+.option('-f, --format <format>', 'Available alternative formats: mermaid')
 .process('graph-path')
 
-const { args } = program
+const { args, format } = program
 const [ subject, property, joinedObjects ] = args
 
 if (!(subject && property && joinedObjects)) {
@@ -41,35 +42,44 @@ if (rows.length === 0) {
 const intermediaries = uniq(map(rows, 'intermediary'))
 const relevantRows = rows.filter(row => intermediaries.includes(row.next))
 
-let remainingRows = relevantRows
-let nextSubjects = [ subject ]
-let paths = [ subject ]
-const replacedPaths = []
+const allEntityIds = uniq(relevantRows.flatMap(row => values(row)))
+const labels = await getEntitiesLabels(allEntityIds, program.lang)
 
-while (remainingRows.length > 0) {
-  const newPaths = []
-  const [ nextRows, rest ] = partition(remainingRows, ({ intermediary }) => {
-    return nextSubjects.includes(intermediary)
-  })
-  if (rest.length === remainingRows.length) throw new Error('stuck')
-  remainingRows = rest
-  nextRows.forEach(({ intermediary, next }) => {
-    const relevantPaths = paths.filter(path => {
-      const pathParts = path.split('.')
-      return pathParts.at(-1) === intermediary
-    })
-    const updatedPaths = relevantPaths.map(path => `${path}.${next}`)
-    // Leave the relevantPaths in paths, to let other rows fork them if needed
-    replacedPaths.push(...relevantPaths)
-    newPaths.push(...updatedPaths)
-  })
-  nextSubjects = uniq(map(nextRows, 'next'))
-  paths = [ ...without(paths, ...replacedPaths), ...newPaths ]
-}
+if (format === 'mermaid') {
+  let output = 'graph LR\n'
+  const getNodeLabel = id => `${labels[id]} (${id})`
+  for (const { intermediary, next } of relevantRows) {
+    output += `${getNodeLabel(intermediary)} --> ${getNodeLabel(next)}\n`
+  }
+  console.log(output.trim())
+} else {
+  let remainingRows = relevantRows
+  let nextSubjects = [ subject ]
+  let paths = [ subject ]
+  const replacedPaths = []
 
-const allParts = uniq(paths.flatMap(path => path.split('.')))
-const labels = await getEntitiesLabels(allParts, program.lang)
+  while (remainingRows.length > 0) {
+    const newPaths = []
+    const [ nextRows, rest ] = partition(remainingRows, ({ intermediary }) => {
+      return nextSubjects.includes(intermediary)
+    })
+    if (rest.length === remainingRows.length) throw new Error('stuck')
+    remainingRows = rest
+    nextRows.forEach(({ intermediary, next }) => {
+      const relevantPaths = paths.filter(path => {
+        const pathParts = path.split('.')
+        return pathParts.at(-1) === intermediary
+      })
+      const updatedPaths = relevantPaths.map(path => `${path}.${next}`)
+      // Leave the relevantPaths in paths, to let other rows fork them if needed
+      replacedPaths.push(...relevantPaths)
+      newPaths.push(...updatedPaths)
+    })
+    nextSubjects = uniq(map(nextRows, 'next'))
+    paths = [ ...without(paths, ...replacedPaths), ...newPaths ]
+  }
 
-for (const path of paths) {
-  console.log(path.split('.').map(part => `${labels[part]} ${grey(`(${part})`)}`).join(' → '))
+  for (const path of paths) {
+    console.log(path.split('.').map(part => `${labels[part]} ${grey(`(${part})`)}`).join(' → '))
+  }
 }

package/metadata/graph-path.js

@@ -1,7 +1,7 @@
 export default {
   alias: 'gp',
   args: '<subject> <property> <object>',
-  description: 'Find the path between a subject and an object on the entity relations graph',
+  description: 'Find the path between a subject and an object via a given property, on the entities relations graph',
   options: {
     lang: true,
     verbose: true,
@@ -13,5 +13,6 @@ export default {
   examples: [
     { args: 'Q336 P279 Q5891', comment: 'Find by which path science (Q336) is a subclass of (P279) philosophy (Q5891)' },
     { args: 'Q336 P279 Q5891,Q2198855,Q3326717,Q968159', comment: 'Find by which path science (Q336) is a subclass of (P279) either philosophy (Q5891), literary movement (Q3326717), or art movement (Q968159)' },
+    { args: 'wd gp Q506259 P279 Q2509280 --format mermaid | mermaid-ascii -f -', comment: 'Output graph in the [mermaid format](https://mermaid.js.org/) and pipe it to [mermaid-ascii](https://github.com/AlexanderGrooff/mermaid-ascii) to visualize the graph in the terminal' },
   ],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikibase-cli",
-  "version": "20.0.0",
+  "version": "20.1.0",
   "description": "A command-line interface to Wikibase",
   "type": "module",
   "main": "index.js",