wikibase-cli 18.2.0 → 18.2.1

package/bin/wb-generate-template.js

@@ -14,7 +14,7 @@ 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')
@@ -49,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/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/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/package.json

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