wikibase-cli 16.3.3 → 17.0.1

package/lib/apply_env_and_config_default.js

@@ -1,4 +1,7 @@
-const config = require('./config/config')
+import { camelCase, snakeCase } from 'lodash-es'
+import { localLang } from '#lib/local_lang'
+import { config } from './config/config.js'
+
 const fallbackConfigOptions = [
   'bot',
   'clipboard',
@@ -7,15 +10,14 @@ const fallbackConfigOptions = [
   'lang',
   'maxlag',
   'sparql-endpoint',
-  'verbose'
+  'verbose',
 ]
-const { camelCase, snakeCase } = require('lodash')
 
-module.exports = program => {
+export function applyEnvAndConfigDefault (program) {
   // If a --lang option is passed, it should be considered a request to not fallback on other langs
   if (program.lang != null) program.strictLang = program.lang
   fallbackConfigOptions.forEach(fallbackToConfigOption(program))
-  program.lang = program.lang || config.lang || require('./local_lang')
+  program.lang = program.lang || config.lang || localLang
 }
 
 const fallbackToConfigOption = program => parameter => {

package/lib/chalk.js

@@ -0,0 +1,12 @@
+import chalk from 'chalk'
+
+export const bgBlue = chalk.bgBlue
+export const bgGreen = chalk.bgGreen
+export const bgMagenta = chalk.bgMagenta
+export const blue = chalk.blue
+export const green = chalk.green
+export const grey = chalk.grey
+export const inverse = chalk.inverse
+export const red = chalk.red
+export const white = chalk.white
+export const yellow = chalk.yellow

package/lib/command_with_template_custom_help.js

@@ -1,18 +1,18 @@
-const program = require('commander')
-const path = require('path')
-const logCommandExamples = require('./log_command_examples')
-const { validateTemplateCommand } = require('./utils')
+import { resolve } from 'node:path'
+import program from 'commander'
+import { validateTemplateCommand } from '#lib/utils'
+import logCommandExamples from './log_command_examples.js'
 
 // Called when the -h,--help flag was set, and we now need to figure out what to display
-module.exports = () => {
+export async function commandWithTemplateCustomHelp () {
   const { args } = program
   if (args.length === 0) return program.helpAndExit()
 
   let filePath, jsPath, jsModule
   try {
     filePath = args[0]
-    jsPath = path.resolve(filePath)
-    jsModule = require(jsPath)
+    jsPath = resolve(filePath)
+    ;({ default: jsModule } = await import(jsPath))
   } catch (err) {
     console.error("Couldn't parse template file metadata", err, { filePath, jsPath, jsModule })
     process.exit(1)

package/lib/common_command_args_parser.js

@@ -1,7 +1,9 @@
-const termCommandArgsParser = termType => ([ id, language, ...value ]) => {
-  value = dropQuotes(value.join(' '))
-  if (termType === 'alias') value = value.split('|')
-  return [ { id, language, value } ]
+export function termCommandArgsParser (termType) {
+  return function ([ id, language, ...value ]) {
+    value = dropQuotes(value.join(' '))
+    if (termType === 'alias') value = value.split('|')
+    return [ { id, language, value } ]
+  }
 }
 
 const dropQuotes = value => {
@@ -10,12 +12,7 @@ const dropQuotes = value => {
   return value
 }
 
-const badgesCommandArgsParser = ([ id, site, badges ]) => {
+export function badgesCommandArgsParser ([ id, site, badges ]) {
   badges = badges.split(/[,|]/)
   return [ { id, site, badges } ]
 }
-
-module.exports = {
-  termCommandArgsParser,
-  badgesCommandArgsParser,
-}

package/lib/common_errors.js

@@ -1,9 +1,7 @@
-const { red } = require('chalk')
+import { red } from '#lib/chalk'
 
-module.exports = {
-  missingProperty: property => {
-    console.error(red(`the property ${property} could not be found\n`) +
-      'run `wb props --reset` to refresh the local properties list')
-    process.exit(1)
-  }
+export const missingProperty = property => {
+  console.error(red(`the property ${property} could not be found\n`) +
+    'run `wb props --reset` to refresh the local properties list')
+  process.exit(1)
 }

package/lib/common_options.js

@@ -1,25 +1,24 @@
-module.exports = {
-  editCommands: {
-    lang: false,
-    verbose: true,
-    dry: true,
-    clipboard: false,
-    json: false,
-    instance: true,
-    sparqlEndpoint: false,
-    batch: true,
-    noExitOnError: true,
-    summary: true,
-    baserevid: true,
-    maxlag: true,
-  },
-  entityAttributeCommands: {
-    lang: true,
-    verbose: false,
-    dry: false,
-    clipboard: true,
-    json: false,
-    instance: true,
-    sparqlEndpoint: false
-  }
+export const editCommandsOptions = {
+  lang: false,
+  verbose: true,
+  dry: true,
+  clipboard: false,
+  json: false,
+  instance: true,
+  sparqlEndpoint: false,
+  batch: true,
+  noExitOnError: true,
+  summary: true,
+  baserevid: true,
+  maxlag: true,
+}
+
+export const entityAttributeCommandsOptions = {
+  lang: true,
+  verbose: false,
+  dry: false,
+  clipboard: true,
+  json: false,
+  instance: true,
+  sparqlEndpoint: false,
 }

package/lib/config/config.js

@@ -1,9 +1,14 @@
+import { readJsonFile } from '#lib/json'
+import { configFilePath } from './file_path.js'
+
 const isEnvTest = process.env.NODE_ENV === 'tests'
-if (isEnvTest) {
+
+export let config = {}
+
 // Neutralize the local config for tests
-  module.exports = {}
-} else {
-  const filePath = require('./file_path')
+if (!isEnvTest) {
   // Fallback to an empty config if no config path could be determined
-  module.exports = filePath ? require(filePath) : {}
+  if (configFilePath) {
+    config = readJsonFile(configFilePath)
+  }
 }

package/lib/config/credentials_config.js

@@ -1,9 +1,10 @@
-const fileOps = require('./file_operations')
-const errors_ = require('../errors')
-const { yellow, green } = require('chalk')
-const validateInstanceCredentials = require('../edit/validate_instance_credentials')
+import { yellow, green } from '#lib/chalk'
+import { initCredentials } from '#lib/edit/init_credentials'
+import validateInstanceCredentials from '../edit/validate_instance_credentials.js'
+import errors_ from '../errors.js'
+import fileOps from './file_operations.js'
 
-module.exports = async (instance, arg) => {
+export async function configurateCredentials (instance, arg) {
   const credentials = fileOps.get('credentials') || {}
   const knownInstance = Object.keys(credentials)
 
@@ -17,7 +18,7 @@ module.exports = async (instance, arg) => {
     console.log(yellow(`credentials for instance ${instance} not found`))
     if (knownInstance.length > 0) console.log(`\nKnown instance(s):\n\n${knownInstance.join('\n')}\n`)
     else console.log()
-    return require('../edit/init_credentials')(instance)
+    return initCredentials(instance)
   }
 
   if (!arg) return console.log(JSON.stringify(instanceCredentials, null, 2))

package/lib/config/file_operations.js

@@ -1,13 +1,14 @@
 // Could be replaced by fs.promises.writeFile once we drop support for NodeJS <= v10
-const { writeFileSync } = require('fs')
-const errors_ = require('../errors')
-const valueParsers = require('../value_parsers')
-const parameters = require('./parameters')
+import { writeFileSync } from 'node:fs'
+import errors_ from '../errors.js'
+import valueParsers from '../value_parsers.js'
+import { config } from './config.js'
+import { configFilePath } from './file_path.js'
+import parameters from './parameters.js'
+
 const parametersKeys = Object.keys(parameters)
-const configFilePath = require('./file_path')
-const config = require('./config')
 
-module.exports = {
+export default {
   get: key => {
     validateKey(key)
     const param = parameters[key]
@@ -37,7 +38,7 @@ module.exports = {
   configFilePath,
   clear: async () => {
     if (configFilePath) writeFileSync(configFilePath, '{}')
-  }
+  },
 }
 
 const validateKey = key => {

package/lib/config/file_path.js

@@ -1,17 +1,20 @@
-const fs = require('fs')
-const path = require('../path')
-const configFolder = require('../get_folder_path')('config')
+import { accessSync, writeFileSync } from 'node:fs'
+import configFolderFactory from '../get_folder_path.js'
+import path from '../path.js'
+
+const configFolder = configFolderFactory('config')
+
+export let configFilePath
 
 if (configFolder != null) {
-  const configPath = path.join(configFolder, 'config.json')
+  configFilePath = path.join(configFolder, 'config.json')
 
   try {
-    fs.accessSync(configPath)
+    accessSync(configFilePath)
   } catch (err) {
     // Initialize if it doesn't exist
-    fs.writeFileSync(configPath, '{}', { mode: 0o600 })
+    writeFileSync(configFilePath, '{}', { mode: 0o600 })
   }
-  module.exports = configPath
 } else {
-  module.exports = null
+  configFilePath = null
 }

package/lib/config/parameters.js

@@ -1,45 +1,46 @@
-const { isPlainObject } = require('lodash')
+import { isPlainObject } from 'lodash-es'
+import { localLang } from '#lib/local_lang'
 
 const boolean = {
   type: 'boolean',
-  default: false
+  default: false,
 }
 
 const integer = {
   type: 'number',
   default: 5,
-  test: num => Number.isInteger(num) && num >= 0
+  test: num => Number.isInteger(num) && num >= 0,
 }
 
 const nonEmptyString = {
   type: 'string',
-  test: str => typeof str === 'string' && str.length > 0
+  test: str => typeof str === 'string' && str.length > 0,
 }
 
 const object = {
   managed: true,
   type: 'object',
-  test: isPlainObject
+  test: isPlainObject,
 }
 
 const url = defaultUrl => ({
   type: 'string',
   default: defaultUrl,
-  test: url => nonEmptyString.test(url) && url.startsWith('http')
+  test: url => nonEmptyString.test(url) && url.startsWith('http'),
 })
 
-module.exports = {
+export default {
   clipboard: boolean,
   json: boolean,
   lang: {
     type: 'lang',
-    default: require('../local_lang'),
-    test: str => typeof str === 'string' && str.length <= 3
+    default: localLang,
+    test: str => typeof str === 'string' && str.length <= 3,
   },
   verbose: boolean,
   credentials: object,
   bot: boolean,
   maxlag: integer,
   instance: url('https://wikidata.org'),
-  'sparql-endpoint': url('https://query.wikidata.org/sparql')
+  'sparql-endpoint': url('https://query.wikidata.org/sparql'),
 }

package/lib/convert_ids.js

@@ -1,13 +1,15 @@
 // Convert external ids to Wikibase ids
 
-const { chunk, uniq } = require('lodash')
-const makeSparqlQuery = require('./make_sparql_query')
-const program = require('./program')
-const { average } = require('./utils')
-const output = require('./output')(program)
-const errors_ = require('./errors')
-
-module.exports = async (property, ids, fromWdIds) => {
+import { chunk, uniq } from 'lodash-es'
+import errors_ from './errors.js'
+import makeSparqlQuery from './make_sparql_query.js'
+import { outputFactory } from './output.js'
+import program from './program.js'
+import { average } from './utils.js'
+
+const output = outputFactory(program)
+
+export default async (property, ids, fromWdIds) => {
   ids = uniq(ids)
   if (ids.length === 0) return output({})
   const sparqlBuilder = fromWdIds ? fromWbIds : fromExternalIds

package/lib/copy.js

@@ -1,6 +1,6 @@
-const { copy } = require('copy-paste')
+import { copy } from 'copy-paste'
 
-module.exports = text => {
+export function copyAndExit (text) {
   copy(text, () => {
     console.log(text)
     process.exit(0)

package/lib/drop_non_selected_subprops.js

@@ -1,13 +1,13 @@
-const _ = require('lodash')
+import { pick } from 'lodash-es'
 
-module.exports = (entity, requestedPropsAndSubProps) => {
+export default (entity, requestedPropsAndSubProps) => {
   if (!requestedPropsAndSubProps) return
 
   const requestedProps = Object.keys(requestedPropsAndSubProps)
   requestedProps.forEach(prop => {
     const subkeys = Object.keys(requestedPropsAndSubProps[prop])
     if (subkeys && subkeys.length > 0) {
-      entity[prop] = _.pick(entity[prop], subkeys)
+      entity[prop] = pick(entity[prop], subkeys)
       subkeys.forEach(subkey => {
         if (!entity[prop][subkey]) entity[prop][subkey] = null
       })

package/lib/edit/assert_credentials.js

@@ -1,7 +1,7 @@
-const { yellow } = require('chalk')
-const initCredentials = require('./init_credentials')
+import { yellow } from '#lib/chalk'
+import { initCredentials } from './init_credentials.js'
 
-module.exports = async ({ instance, credentials, batch }) => {
+export default async ({ instance, credentials, batch }) => {
   if (!credentials) return requestCredentials(instance, batch)
 
   const instanceCredentials = credentials[instance]

package/lib/edit/edit_command.js

@@ -1,15 +1,15 @@
-const program = require('../program')
-const wbEdit = require('wikibase-edit')
-const parseObjectValue = require('./parse_object_value')
-const parseBatchLine = require('./parse_batch_line')
-const assertCredentials = require('./assert_credentials')
-const split = require('split')
-const config = require('../config/config')
-const errors_ = require('../errors')
-const { red } = require('chalk')
-const { inspect } = require('util')
-
-module.exports = async (section, action) => {
+import { inspect } from 'node:util'
+import split from 'split'
+import wbEdit from 'wikibase-edit'
+import { red } from '#lib/chalk'
+import { config } from '../config/config.js'
+import errors_ from '../errors.js'
+import program from '../program.js'
+import assertCredentials from './assert_credentials.js'
+import parseBatchLine from './parse_batch_line.js'
+import parseObjectValue from './parse_object_value.js'
+
+export async function execEditCommand (section, action) {
   let name
   if (typeof section === 'object') {
     // Pass a name when it can not be deduced from the wikibase-edit section
@@ -19,7 +19,7 @@ module.exports = async (section, action) => {
   } else {
     name = `${action}-${section}`
   }
-  program.process(name)
+  await program.process(name)
 
   if (program.showHelp) return program.customHelpOption()
 
@@ -58,13 +58,13 @@ const instanceHint = `* Wikidata: use the 'wd' executable
   * set the '--instance <http://my.instance>' option
   * or set the instance in config: 'wb config instance http://my.instance'`
 
-const runOnce = async (section, action, args) => {
+async function runOnce (section, action, args) {
   // Allow to define a customArgsParser on program to convert the command-line input
   // into what the wikibase-edit interface expects.
   // Running this after program.process allows to pass after the options
   // where removed from the args array
   if (program.customArgsParser) {
-    args = program.customArgsParser(args)
+    args = await program.customArgsParser(args)
   }
 
   // Resolve arguments that might be promises
@@ -78,7 +78,7 @@ const runOnce = async (section, action, args) => {
 // and keep cached data such as properties
 let wbEditConfig
 
-const runEditCommand = async (section, action, args) => {
+async function runEditCommand (section, action, args) {
   if (program.dry) {
     if (args.length > 0) console.log(JSON.stringify({ section, action, args }))
     return
@@ -100,7 +100,7 @@ const runEditCommand = async (section, action, args) => {
   }
 }
 
-const getWbEditConfig = () => {
+function getWbEditConfig () {
   const { editGroup } = program
   let { summary, baserevid, maxlag } = program
 
@@ -135,11 +135,11 @@ const getWbEditConfig = () => {
     bot: config.bot,
     maxlag,
     // maxlag=-1 can be used for testing that passing maxlag does work
-    autoRetry: maxlag !== -1
+    autoRetry: maxlag !== -1,
   }
 }
 
-const runInBatch = (section, action, exitOnError) => {
+function runInBatch (section, action, exitOnError) {
   let counter = 0
   let successes = 0
   let errors = 0

package/lib/edit/init_credentials.js

@@ -1,9 +1,9 @@
-const prompt = require('./prompt')
-const { green, red } = require('chalk')
-const configOps = require('../config/file_operations')
-const validateInstanceCredentials = require('./validate_instance_credentials')
+import { green, red } from '#lib/chalk'
+import configOps from '../config/file_operations.js'
+import prompt from './prompt.js'
+import validateInstanceCredentials from './validate_instance_credentials.js'
 
-module.exports = instance => {
+export async function initCredentials (instance) {
   return chooseCredentialsType(instance)
   .catch(cleanExitOnPromptCancelation)
 }
@@ -14,8 +14,8 @@ const chooseCredentialsType = async instance => {
       key: 'type',
       label: `Which authentication mechanism would you like to use to login to ${instance} ?`,
       info: '/!\\ Beware that those will be stored in plain text on your computer',
-      options: [ 'username - password', 'OAuth tokens' ]
-    }
+      options: [ 'username - password', 'OAuth tokens' ],
+    },
   ])
   if (type === '1') {
     await requestUsernameAndPassword(instance)
@@ -47,7 +47,7 @@ In case you don't have a sufficiant authorization level and thus can't create an
     { key: 'consumer_key', label: 'Consumer token', pattern: patterns.key },
     { key: 'consumer_secret', label: 'Consumer secret', pattern: patterns.secret },
     { key: 'token', label: 'Access token', pattern: patterns.key },
-    { key: 'token_secret', label: 'Access secret', pattern: patterns.secret }
+    { key: 'token_secret', label: 'Access secret', pattern: patterns.secret },
   ])
   const credentials = { oauth: oauthTokens }
   return getTokenOrRetry({ instance, credentials })
@@ -55,13 +55,13 @@ In case you don't have a sufficiant authorization level and thus can't create an
 
 const patterns = {
   key: /^[0-9a-f]{32}$/,
-  secret: /^[0-9a-f]{40}$/
+  secret: /^[0-9a-f]{40}$/,
 }
 
 const prefilledParams = [
   'wpname=wikibase-cli-myusername',
   'wpdescription=tokens%20for%20wikibase-cli%20%28https%3A%2F%2Fgithub.com%2Fmaxlath%2Fwikibase-cli%29',
-  'wpownerOnly=1'
+  'wpownerOnly=1',
 ].join('&')
 
 const oauthConsumerRegistrationPathname = `/wiki/Special:OAuthConsumerRegistration/propose/oauth1a?${prefilledParams}`
@@ -80,7 +80,7 @@ This is especially recommended as those credentials will be saved in plain text
   `)
   return prompt([
     { key: 'username', pattern: nonEmptyStringPattern },
-    { key: 'password', pattern: nonEmptyStringPattern }
+    { key: 'password', pattern: nonEmptyStringPattern },
   ])
   .then(({ username, password }) => {
     const credentials = { username, password }

package/lib/edit/parse_batch_line.js

@@ -1,9 +1,9 @@
 // Args can't be just a line splitted on spaces
 // as there are JSON strings arguments, and signle or double quoted strings args
 
-const { parse } = require('shell-quote')
+import parse from 'shell-quote/parse.js'
 
-module.exports = line => {
+export default line => {
   // One JSON object as single argument
   // typically for (create|edit)-entity commands
   // ex: { "id": "Q1", "labels": { "en": "foo" } }

package/lib/edit/parse_object_value.js

@@ -1,13 +1,14 @@
-const qs = require('querystring')
-const errors_ = require('../errors')
-const { isPlainObject } = require('lodash')
+import qs from 'node:querystring'
+import { isPlainObject } from 'lodash-es'
+import errors_ from '../errors.js'
+
 const stringValueKeys = [
   'value',
   'oldValue',
-  'newValue'
+  'newValue',
 ]
 
-module.exports = value => {
+export default value => {
   if (isPlainObject(value)) {
     stringValueKeys.forEach(parseObjKeyValue(value))
     return value

package/lib/edit/prompt.js

@@ -1,8 +1,7 @@
-const { promisify } = require('util')
-const read = promisify(require('read'))
-const { blue, yellow, grey } = require('chalk')
+import read from 'read'
+import { blue, yellow, grey } from '#lib/chalk'
 
-module.exports = readsData => {
+export default readsData => {
   const results = {}
 
   const promptSequentially = async () => {

package/lib/edit/validate_instance_credentials.js

@@ -1,6 +1,6 @@
-const wbEdit = require('wikibase-edit')
+import wbEdit from 'wikibase-edit'
 
-module.exports = async ({ instance, credentials }) => {
+export default async ({ instance, credentials }) => {
   const { token } = await wbEdit({ instance, credentials }).getAuthData()()
   if (token.length !== 42) throw new Error('invalid credentials')
 }

package/lib/entity_attribute_command.js

@@ -1,10 +1,10 @@
-const entityDataParser = require('./entity_data_parser')
-const entityAttributeParser = require('./entity_attribute_parser')
-const pluralize = require('./pluralize')
-const { grey, red } = require('chalk')
-const _ = require('lodash')
+import { max, padEnd, values } from 'lodash-es'
+import { grey, red } from '#lib/chalk'
+import entityAttributeParser from './entity_attribute_parser.js'
+import { entityDataParser } from './entity_data_parser.js'
+import pluralize from './pluralize.js'
 
-module.exports = (attribute, extraParams) => {
+export async function entityAttributeCommand (attribute, extraParams) {
   let commandName, ids
   if (extraParams) {
     ids = extraParams.ids
@@ -15,13 +15,13 @@ module.exports = (attribute, extraParams) => {
   const props = [ pluarlizedAttribute ]
 
   const parser = async ({ lang, strictLang, output, entities }) => {
-    const entitiesList = _.values(entities)
+    const entitiesList = values(entities)
     const multiEntities = entitiesList.length > 1
-    const maxLength = _.max(entitiesList.map(entity => entity.id.length)) + 1
+    const maxLength = max(entitiesList.map(entity => entity.id.length)) + 1
     entitiesList.forEach(logAttribute(attribute, lang, strictLang, multiEntities, maxLength, output))
   }
 
-  entityDataParser({ commandName, props, parser, ids })
+  await entityDataParser({ commandName, props, parser, ids })
 }
 
 const logAttribute = (attribute, lang, strictLang, multiEntities, maxLength, output) => entity => {
@@ -38,7 +38,7 @@ const logAttribute = (attribute, lang, strictLang, multiEntities, maxLength, out
   }
   // Prefix value with the id if there are multiple entities
   if (multiEntities) {
-    console.log(grey(_.padEnd(entity.id, maxLength)), value || grey('not found'))
+    console.log(grey(padEnd(entity.id, maxLength)), value || grey('not found'))
   } else {
     output(value)
   }