wikibase-cli 18.1.0 → 18.2.1

package/bin/wb-badges.js

@@ -5,6 +5,8 @@ import { exitOnMissingInstance } from '#lib/exit_on_missing'
 import program from '#lib/program'
 import { get } from '#lib/request'
 
+program.canHaveZeroArguments = true
+
 await program.process('badges')
 
 const { instance } = program

package/bin/wb-config.js

@@ -5,6 +5,8 @@ import { configurateCredentials } from '#lib/config/credentials_config'
 import fileOps from '#lib/config/file_operations'
 import program from '#lib/program'
 
+program.canHaveZeroArguments = true
+
 await program.process('config')
 
 const { args, json } = program

package/bin/wb-convert.js

@@ -5,6 +5,8 @@ import errors_ from '#lib/errors'
 import { getStdinInput } from '#lib/get_stdin_input'
 import program from '#lib/program'
 
+program.canHaveZeroArguments = true
+
 await program
 .option('-s, --subjects [subjects...]', 'set a subject')
 .option('-p, --property <property>', 'set a property')

package/bin/wb-data.js

@@ -4,6 +4,8 @@ import { parseGuid } from '#lib/parse_command_utils'
 import program from '#lib/program'
 import { tolerantIdParserFactory } from '#lib/tolerant_id_parser'
 
+program.acceptsArgsOnStdin = true
+
 await program
 .option('-s, --simplify', 'get simplified entities data')
 .option('-k, --keep <props>', 'data to keep when simplifying claims (ids,richvalues,types,references,qualifiers,hashes,nontruthy,nondeprecated,ranks)')

package/bin/wb-generate-template.js

@@ -9,10 +9,12 @@ import { readIdsFromStdin } from '#lib/read_ids_from_stdin'
 import { tolerantIdParserFactory } from '#lib/tolerant_id_parser'
 import { getWbk } from '#lib/wbk'
 
+program.acceptsArgsOnStdin = true
+
 await program
 .option('-p, --props <props>', 'request only certain properties (info, sitelinks, aliases, labels, descriptions, claims, datatype)')
 .option('-r, --revision <id>', 'request a specific revision')
-.option('-f, --format <format>', 'Default: js when fetching a single entity, json otherwise. Note that the -j, --json option is equivalent to "--format json"')
+.option('-f, --format <format>', 'Options: js, json, mjs. Default: js when fetching a single entity, json otherwise. Note that the -j, --json option is equivalent to "--format json"')
 .option('-m, --create-mode', 'optimize for creating an entity from a previously existing one, namely dropping ids from the existing entity used as template')
 .option('-z, --no-minimize', 'disable claims minimization, making the output format more predictable; i.e. single claims will still be in arrays')
 .process('generate-template')
@@ -47,7 +49,7 @@ const handleIds = async ids => {
 
   const batchMode = ids.length > 1
 
-  if (batchMode && format === 'js') {
+  if (batchMode && format.endsWith('js')) {
     throw new Error("js format can't be used when several entities are requested")
   }
 

package/bin/wb-props.js

@@ -7,6 +7,8 @@ import getPatternFilter from '#lib/get_pattern_filter'
 import program from '#lib/program'
 import resetProperties from '#lib/reset_properties'
 
+program.canHaveZeroArguments = true
+
 await program
 .option('-d, --details', 'include properties labels, types, descriptions, and aliases')
 .option('-t, --type [type]', 'include properties types, or if a type is specified, keep only properties with that type')

package/bin/wb-query.js

@@ -7,6 +7,9 @@ import { outputFactory } from '#lib/output'
 import program from '#lib/program'
 import { sparqlQueryCommand } from '#lib/sparql_query_command'
 
+// All arguments are passed as options values making program.args.length === 0 likely
+program.canHaveZeroArguments = true
+
 await program
 .option('-s, --subject <subject>', 'set a subject')
 .option('-p, --property <property>', 'set a property')

package/bin/wb-revisions.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { values } from 'lodash-es'
+import { chunk, values } from 'lodash-es'
 import { isEntityId } from 'wikibase-sdk'
 import errors_ from '#lib/errors'
 import { exitOnMissingInstance } from '#lib/exit_on_missing'
@@ -9,58 +9,82 @@ import { get } from '#lib/request'
 import { isPositiveIntegerString } from '#lib/types'
 import { getWbk } from '#lib/wbk'
 
+program.acceptsArgsOnStdin = true
+
 await program
 .option('-s, --start <date>', 'start date')
 .option('-e, --end <date>', 'end date')
 .option('-n, --limit <num>', 'maximum number of revisions')
+.option('-p, --props <props>', 'requested props, separated by a comma. Available props: https://www.mediawiki.org/wiki/API:Revisions#query+revisions:rvprop')
 .process('revisions')
 
 exitOnMissingInstance(program.instance)
 
 const { getRevisions } = getWbk(program)
 
-// Not parsing the ids with ../lib/tolerant_id_parser as that would
-// remove prefixes which are required for entities out of the main namespace
-// Ex: Property:P570
-const ids = program.args
-if (!(ids && ids.length > 0)) program.helpAndExit(0)
-
-ids.forEach(id => {
-  let [ prefix, entityId ] = id.split(':')
-  if (entityId) {
-    if (prefix !== 'Property' && prefix !== 'Item') {
-      throw new Error(`invalid entity prefix: ${prefix}`)
+async function fetchAndLogRevisions (ids) {
+  ids.forEach(id => {
+    let [ prefix, entityId ] = id.split(':')
+    if (entityId) {
+      if (prefix !== 'Property' && prefix !== 'Item') {
+        throw new Error(`invalid entity prefix: ${prefix}`)
+      }
+    } else {
+      entityId = prefix
     }
-  } else {
-    entityId = prefix
-  }
-  if (!isEntityId(entityId)) throw new Error(`invalid entity id: ${id}`)
-})
+    if (!isEntityId(entityId)) throw new Error(`invalid entity id: ${id}`)
+  })
+
+  const query = {}
+  let { start, end, limit, props, verbose } = program
+  if (isPositiveIntegerString(start)) start = parseInt(start)
+  if (isPositiveIntegerString(end)) end = parseInt(end)
 
-const query = {}
-let { start, end, limit, verbose } = program
-if (isPositiveIntegerString(start)) start = parseInt(start)
-if (isPositiveIntegerString(end)) end = parseInt(end)
+  if (start != null) query.start = start
+  if (end != null) query.end = end
+  if (limit != null) query.limit = limit
+  if (props != null) query.prop = props?.split(/[,|]/)
 
-query.start = start
-query.end = end
-query.limit = limit
+  // Prevent error "titles, pageids or a generator was used to supply multiple pages, but the rvlimit, rvstartid, rvendid, rvdir=newer, rvuser, rvexcludeuser, rvstart, and rvend parameters may only be used on a single page. "
+  const usesSinglePageParam = limit != null || start != null || end != null
 
-const getAndLogRevisions = id => {
-  const url = getRevisions({ ids: [ id ], ...query })
-  if (verbose) console.log(`revision query: ${id}`, url)
-  return get(url)
-  .then(body => values(body.query.pages)[0])
+  async function getAndLogRevisions (ids) {
+    const url = getRevisions({ ids, ...query })
+    if (verbose) console.log(`revision query: ${ids}`, url)
+    const body = await get(url)
+    return values(body.query.pages)
+  }
+
+  if (usesSinglePageParam) {
+    const idsBatches = chunk(ids, 10)
+    for (const batch of idsBatches) {
+      // Getting revisisions data individually to be able to pass parameters
+      // cf https://github.com/maxlath/wikibase-sdk/blob/master/docs/get_revisions.md
+      await Promise.all(batch.map(getAndLogRevisions))
+      .then(logNdjson)
+      .catch(errors_.exit)
+    }
+  } else {
+    const idsBatches = chunk(ids, 50)
+    for (const batch of idsBatches) {
+      await getAndLogRevisions(batch)
+      .then(logNdjson)
+      .catch(errors_.exit)
+    }
+  }
 }
 
-if (ids.length === 1) {
-  getAndLogRevisions(ids[0])
-  .then(data => console.log(JSON.stringify(data)))
-  .catch(errors_.exit)
+// process.stdin.isTTY will be undefined if the process is receiving
+// its stdin from another process
+if (program.args.length === 0 && process.stdin.isTTY) {
+  program.helpAndExit(0)
+} else if (program.args.length > 0) {
+  // Not parsing the ids with ../lib/tolerant_id_parser as that would
+  // remove prefixes which are required for entities out of the main namespace
+  // Ex: Property:P570
+  const ids = program.args
+  fetchAndLogRevisions(ids)
 } else {
-  // Getting revisisions data individually to be able to pass parameters
-  // cf https://github.com/maxlath/wikibase-sdk/blob/master/docs/get_revisions.md
-  Promise.all(ids.map(getAndLogRevisions))
-  .then(logNdjson)
-  .catch(errors_.exit)
+  const { readIdsFromStdin } = await import('#lib/read_ids_from_stdin')
+  readIdsFromStdin(fetchAndLogRevisions)
 }

package/lib/edit/edit_command.js

@@ -106,11 +106,10 @@ function getWbEditConfig () {
   const { editGroup } = program
   let { summary, baserevid, maxlag } = program
 
+  let summarySuffix
   if (editGroup) {
     const compactEditGroupUrl = getEditGroupUrl(':toollabs:', editGroup)
-    summary = summary || ''
-    summary += ` ([[${compactEditGroupUrl}|details]])`
-    summary = summary.trim()
+    summarySuffix = `([[${compactEditGroupUrl}|details]])`
   }
 
   const { instance, credentials } = config
@@ -132,6 +131,7 @@ function getWbEditConfig () {
     instance,
     credentials: { oauth, username, password },
     summary,
+    summarySuffix,
     baserevid,
     tags,
     bot: config.bot,

package/lib/log_ndjson.js

@@ -1,7 +1,7 @@
 // Log as newline-delimited JSON: one obj JSON per line. No comma.
 
 export default array => {
-  for (const obj of array) {
+  for (const obj of array.flat()) {
     process.stdout.write(JSON.stringify(obj))
     process.stdout.write('\n')
   }

package/lib/object_arg_parser.js

@@ -1,6 +1,7 @@
+import { existsSync } from 'node:fs'
 import { red } from '#lib/chalk'
 import { readJsonFile } from '#lib/json'
-import { isFilePathSync, isJsonString, getAbsoluteFilePath, validateTemplateCommand } from '#lib/utils'
+import { isJsonString, getAbsoluteFileUrl, validateTemplateCommand } from '#lib/utils'
 import { parseGuid } from './parse_command_utils.js'
 import program from './program.js'
 import validateFunctionArgs from './validate_function_args.js'
@@ -20,22 +21,22 @@ const getData = args => {
     return JSON.parse(arg)
   }
 
-  const filepath = getAbsoluteFilePath(arg)
+  const fileUrl = getAbsoluteFileUrl(arg)
 
-  if (!isFilePathSync(filepath)) {
+  if (!existsSync(fileUrl)) {
     console.error(red('the argument should be a valid JSON or a JSON file path or a JS function file path'))
     console.error("- it doesn't look like inline JSON")
-    console.error(`couldn't parse arguments: ${filepath} is not the path to an existing file`)
+    console.error(`couldn't parse arguments: ${fileUrl} is not the path to an existing file`)
     process.exit(1)
   }
 
   try {
     // Try to parse it as a JSON file
-    return readJsonFile(filepath)
+    return readJsonFile(fileUrl)
   } catch (err1) {
     // Try to parse it as a JS module
     try {
-      return getDataFromJsModule(filepath, args)
+      return getDataFromJsModule(fileUrl, args)
     } catch (err2) {
       if (err2 === 'SyntaxError') {
         console.error(red('the argument should be a valid JSON or a JSON file path or a JS function file path'))
@@ -50,8 +51,8 @@ const getData = args => {
   }
 }
 
-async function getDataFromJsModule (filepath, args) {
-  const { default: jsModule } = await import(filepath)
+async function getDataFromJsModule (fileUrl, args) {
+  const { default: jsModule } = await import(fileUrl)
   if (typeof jsModule === 'function') {
     const inputArgs = args.slice(1)
     validateFunctionArgs(jsModule, inputArgs, jsModule)

package/lib/output_templates.js

@@ -10,8 +10,8 @@ export function outputTemplatesFactory ({ batchMode, format, propsToPick, reques
   const formatEntity = FormatEntity(batchMode, propsToPick, requestedPropsAndSubProps, minimize)
   return async function outputTemplates (entities) {
     entities = entities.map(formatEntity)
-    if (format === 'js') {
-      const jsFile = await stringifyAsJsFunction(entities[0], program.lang)
+    if (format.endsWith('js')) {
+      const jsFile = await stringifyAsJsFunction(entities[0], program.lang, format)
       console.log(jsFile)
     } else {
       const newLines = entities.map(entity => JSON.stringify(entity)).join('\n')

package/lib/program.js

@@ -27,9 +27,9 @@ program.process = async command => {
   } else if (showHelp) {
     program.helpAndExit(0)
   } else if (program.args.length === 0 && !program.batch) {
-    if (commandsTakingArgsOnStdin.includes(command)) {
+    if (program.acceptsArgsOnStdin) {
       if (process.stdin.isTTY) program.helpAndExit(0)
-    } else if (!commandsAcceptingZeroArguments.includes(command)) {
+    } else if (!program.canHaveZeroArguments) {
       program.helpAndExit(0)
     }
   }
@@ -48,23 +48,6 @@ function getOptionsKeyValues (options) {
   return Object.fromEntries(optionsEntries)
 }
 
-const commandsAcceptingZeroArguments = [
-  // Can be called without argument
-  'props',
-  'badges',
-  // All arguments are passed as options values
-  // making program.args.length === 0 likely
-  'query',
-  'convert',
-  // Needs to also log the current config
-  'config',
-]
-
-const commandsTakingArgsOnStdin = [
-  'data',
-  'generate-template',
-]
-
 const parseArgv = (argv, isCommandsWithCustomHelpMenu) => {
   // Make a copy to be able to mutate the array without affecting other operations
   // that might rely on that array being intact

package/lib/read_ids_from_stdin.js

@@ -1,12 +1,15 @@
 import split from 'split'
 import through from 'through'
+import program from '#lib/program'
 
 let ids = []
 
 export function readIdsFromStdin (handleIdsBatch) {
-  const write = function (id) {
+  let count = 0
+  async function write (id) {
     id = id.trim()
     if (id === '') return
+    count++
     ids.push(id)
     if (ids.length < 50) return
 
@@ -15,18 +18,23 @@ export function readIdsFromStdin (handleIdsBatch) {
     const batch = ids
     ids = []
 
-    handleIdsBatch(batch)
-    .then(() => this.resume())
+    await handleIdsBatch(batch)
+    this.resume()
   }
 
-  const end = function () {
+  async function end () {
+    if (count === 0) program.helpAndExit(0)
     if (ids.length === 0) return this.emit('end')
-    handleIdsBatch(ids)
-    .then(this.emit.bind(this, 'end'))
+    await handleIdsBatch(ids)
+    this.emit('end')
   }
 
   process.stdin
   .pipe(split(/\s/))
   .pipe(through(write, end))
   .on('error', console.error)
+
+  setTimeout(() => {
+    if (count === 0) program.helpAndExit(0)
+  }, 500)
 }

package/lib/stringify_as_js_function.js

@@ -70,11 +70,12 @@ const getPatternComment = (line, pattern, entitiesLabels) => {
   }
 }
 
-export default async (entity, lang) => {
+export default async (entity, lang, format) => {
   const json = JSON.stringify(entity, null, 2)
   // Use the classic syntax function to avoid the implicit return syntax
   // which might be confusion to users unfamiliar with JS
-  const file = `module.exports = function () {
+  const moduleExport = format === 'mjs' ? 'export default function' : 'module.exports = function'
+  const file = `${moduleExport} () {
   return ${formatJsObj(json)}
 }`
   const entitiesIds = collectEntitiesIds(json)

package/lib/utils.js

@@ -1,29 +1,30 @@
 import { existsSync } from 'node:fs'
 import path from 'node:path'
+import { pathToFileURL } from 'node:url'
 import errors_ from './errors.js'
 
 export const wait = ms => new Promise(resolve => setTimeout(resolve, ms))
 
 export const sum = (a, b) => a + b
 
-export const average = values => {
+export function average (values) {
   if (values.length > 0) return values.reduce(sum, 0) / values.length
   else return 0
 }
 
-export const getAbsoluteFilePath = filepath => path.resolve(process.cwd(), filepath)
+export const getAbsoluteFileUrl = filepath => pathToFileURL(path.resolve(process.cwd(), filepath))
 
-export const isFilePathSync = arg => {
-  const possibleFilePath = getAbsoluteFilePath(arg)
-  return existsSync(possibleFilePath)
+export function isFilePathSync (arg) {
+  const possibleFileUrl = getAbsoluteFileUrl(arg)
+  return existsSync(possibleFileUrl)
 }
 
-export const isJsonString = str => {
+export function isJsonString (str) {
   if (typeof str !== 'string') return false
   else return (str.trim()[0] === '{' || str.trim()[0] === '[')
 }
 
-export const validateTemplateCommand = ({ commandName, validCommands }) => {
+export function validateTemplateCommand ({ commandName, validCommands }) {
   if (!validCommands) return
   if (validCommands && !validCommands.includes(commandName)) {
     throw errors_.exitMessage('wrong command for this template', { commandName, validCommands })

package/metadata/data.js

@@ -16,7 +16,7 @@ export default {
     { args: '--simplify Q123', comment: 'fetch Q123 simplified data' },
     { args: '--simplify --keep ids,references,qualifiers,hashes,nontruthy Q123', comment: 'simplified Q123 data, but keep some attributes' },
     { args: '--simplify --keep all Q123', comment: 'same as above' },
-    { args: 'Q1496 | jd labels.pt', comment: "take advantage of the raw data being output as JSON\n    # to pass it to a JSON parsers (here jsondepth a.k.a. jd)\n    # and get only the piece of data you're looking for" },
-    { args: '--simplify --keep ids Q123 | jd claims.P138 -j', comment: 'get Q123 P138 claims ids' },
+    { args: 'Q1496 | jq .labels.pt', comment: "take advantage of the raw data being output as JSON\n    # to pass it to jq (a JSON parsers https://jqlang.github.io/jq/)\n    # and get only the piece of data you're looking for" },
+    { args: '--simplify --keep ids Q123 | jq .claims.P138 -j', comment: 'get Q123 P138 claims ids' },
   ],
 }

package/metadata/query.js

@@ -15,7 +15,7 @@ export default {
     { args: '--property P921 --object Q44559 --labels', comment: 'find out which works have exoplanets (Q44559) for main subject (P921)\n    # and include labels' },
     { args: '--property P7476 --count', comment: 'get a list of all the claims using the property (P7476)' },
     { args: '-p P921 -o Q44559 -a', comment: 'as always, you can also use the short options syntax' },
-    { args: '-p P921 -o Q44559 -a | jd 2', comment: 'the output is valid JSON, so you can pipe it to any JSON parser you like\n    # (here jsondepth a.k.a. jd)' },
+    { args: "-p P921 -o Q44559 -a | jq '.[]' -cr", comment: 'the output is valid JSON, so you can pipe it to any JSON parser you like\n    # (here jq https://jqlang.github.io/jq/)' },
     { args: '-s Q15228 -p P674 -a', comment: 'find out which are the characters (P674) in The Lord of The Ring (Q15228)' },
     { args: '-s Q15228 -o Q177499 -a', comment: 'find out which property link The Lord of The Ring (Q15228) and Gandalf (Q177499)' },
     { args: '-s Q177499 -a', comment: 'get the properties and objects for all the triples (subject, property, object) having Gandalf (Q177499) as subject' },

package/metadata/revisions.js

@@ -12,6 +12,7 @@ export default {
   },
   examples: [
     { args: 'Q3548931', comment: "fetch Q3548931's revisions data" },
+    { args: 'Q3548931 -p content,user,ids', comment: "fetch only certain attributes from Q3548931's revisions data" },
     { args: 'Property:P31', comment: "fetch P31's revisions data" },
   ],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikibase-cli",
-  "version": "18.1.0",
+  "version": "18.2.1",
   "description": "A command-line interface to Wikibase",
   "type": "module",
   "main": "index.js",
@@ -16,7 +16,7 @@
     "lint-staged": "./scripts/lint_staged",
     "prepublishOnly": "export MOCHA_OPTIONS='--bail'; npm run lint && npm test",
     "postpublish": "npm run docker:publish && git push --tags",
-    "test": "mocha --exit --timeout 20000 $MOCHA_OPTIONS",
+    "test": "export FORCE_COLOR=false; mocha --exit --timeout 20000 $MOCHA_OPTIONS",
     "update-toc": "./scripts/update_toc"
   },
   "repository": {
@@ -57,7 +57,7 @@
     "shell-quote": "^1.8.1",
     "split": "^1.0.1",
     "through": "^2.3.8",
-    "wikibase-edit": "^7.1.0",
+    "wikibase-edit": "^7.1.2",
     "wikibase-sdk": "^10.1.0",
     "wikidata-lang": "^2.0.11"
   },