wikibase-cli 18.2.1 → 18.3.0

package/lib/config/check_config_file_existance.js

@@ -0,0 +1,28 @@
+import { access, writeFile } from 'fs/promises'
+import read from 'read'
+
+export async function checkConfigFileExistance (configFilePath) {
+  try {
+    await access(configFilePath)
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      await offerToCreateMissingConfigFile(configFilePath)
+    } else {
+      throw err
+    }
+  }
+}
+
+async function offerToCreateMissingConfigFile (configFilePath) {
+  try {
+    const res = await read({ prompt: `Config file not found at ${configFilePath}. Create? y/N` })
+    if (res.trim() === 'y') {
+      await writeFile(configFilePath, '{}', { mode: 0o600 })
+    } else {
+      process.exit(1)
+    }
+  } catch (err) {
+    if (err.message === 'canceled') process.exit(1)
+    else throw err
+  }
+}

package/lib/config/file_path.js

@@ -1,20 +1,29 @@
-import { accessSync, writeFileSync } from 'node:fs'
+import { join, resolve } from '#lib/platform_agnostic_path'
 import configFolderFactory from '../get_folder_path.js'
-import path from '../path.js'
-
-const configFolder = configFolderFactory('config')
+import { checkConfigFileExistance } from './check_config_file_existance.js'
 
 export let configFilePath
 
-if (configFolder != null) {
-  configFilePath = path.join(configFolder, 'config.json')
+const configFolder = configFolderFactory('config')
 
-  try {
-    accessSync(configFilePath)
-  } catch (err) {
-    // Initialize if it doesn't exist
-    writeFileSync(configFilePath, '{}', { mode: 0o600 })
+// Arguments parsing needs to be done manually as relying on lib/program
+// would be a circular dependecy
+const args = process.argv.slice(2)
+const configArg = args.find(arg => arg.startsWith('--config'))
+if (configArg) {
+  let configFilePathFromArgs
+  if (configArg.split('=')[1]) {
+    configFilePathFromArgs = configArg.split('=')[1]
+  } else {
+    configFilePathFromArgs = args[args.indexOf(configArg) + 1]
   }
+  configFilePath = resolve(process.cwd(), configFilePathFromArgs)
+} else if (process.env.WB_CONFIG) {
+  configFilePath = process.env.WB_CONFIG
+} else if (configFolder != null) {
+  configFilePath = join(configFolder, 'config.json')
 } else {
   configFilePath = null
 }
+
+if (configFilePath) await checkConfigFileExistance(configFilePath)

package/lib/get_claims_texts.js

@@ -21,7 +21,7 @@ const buildClaimsText = (labels, prop, values, propertiesData) => {
   if (!propData) return missingProperty(prop)
 
   const { label, type } = propData
-  const propColor = propTypes[type].color
+  const propColor = propTypes[type]?.color
   const propLabel = propColor ? chalk[propColor](label) : black(bgWhite(label))
 
   const propText = formatEntity(propLabel, prop) + grey(': ')

package/lib/global_options_help.js

@@ -1,4 +1,8 @@
-export default {
+export const globalOptions = {
+  config: [ '--config <path>', 'Path to the config.json file' ],
+}
+
+export const commandSpecificOptions = {
   lang: [ '-l, --lang <lang>', 'specify the language to use' ],
   verbose: [ '-v, --verbose', 'make the output more verbose' ],
   dry: [ '-d, --dry', 'output the generated data, do not run the query' ],

package/lib/platform_agnostic_path.js

@@ -0,0 +1,6 @@
+import path from 'node:path'
+
+const platformAgnosticPath = process.platform === 'win32' ? path.win32 : path
+
+export const resolve = platformAgnosticPath.resolve
+export const join = platformAgnosticPath.join

package/lib/program.js

@@ -3,7 +3,7 @@
 import program from 'commander'
 import { debug } from '#lib/debug'
 import { applyEnvAndConfigDefault } from './apply_env_and_config_default.js'
-import globalOptionsHelp from './global_options_help.js'
+import { globalOptions, commandSpecificOptions } from './global_options_help.js'
 import logCommandExamples from './log_command_examples.js'
 
 program.process = async command => {
@@ -14,9 +14,12 @@ program.process = async command => {
     ;({ options } = metadata)
     program.arguments(args)
     program.description(description)
-    Object.keys(globalOptionsHelp).forEach(key => {
-      if (options[key]) program.option(...globalOptionsHelp[key])
-    })
+    for (const [ name, params ] of Object.entries(commandSpecificOptions)) {
+      if (options[name]) program.option(...params)
+    }
+    for (const params of Object.values(globalOptions)) {
+      program.option(...params)
+    }
     program.on('--help', () => logCommandExamples(command, examples, doc))
   }
   const isCommandsWithCustomHelpMenu = program.customHelpOption != null

package/lib/properties.js

@@ -3,21 +3,22 @@ export const mainProps = {
 }
 
 export const propTypes = {
-  'external-id': { factor: 0.1, color: 'grey' },
-  string: { factor: 1 },
-  'wikibase-item': { factor: 1 },
-  time: { factor: 1 },
-  monolingualtext: { factor: 2 },
-  quantity: { factor: 1 },
-  'wikibase-property': { factor: 1 },
-  url: { factor: 0.5 },
   commonsMedia: { factor: 0.5 },
+  'entity-schema': { factor: 0.5 },
+  'external-id': { factor: 0.1, color: 'grey' },
+  'geo-shape': { factor: 0.5 },
   'globe-coordinate': { factor: 0.5 },
   math: { factor: 0.5 },
-  'geo-shape': { factor: 0.5 },
+  monolingualtext: { factor: 2 },
+  'musical-notation': { factor: 0.5 },
+  quantity: { factor: 1 },
+  string: { factor: 1 },
   'tabular-data': { factor: 0.5 },
-  'wikibase-lexeme': { factor: 0.5 },
+  time: { factor: 1 },
+  url: { factor: 0.5 },
   'wikibase-form': { factor: 0.5 },
+  'wikibase-item': { factor: 1 },
+  'wikibase-lexeme': { factor: 0.5 },
+  'wikibase-property': { factor: 1 },
   'wikibase-sense': { factor: 0.5 },
-  'musical-notation': { factor: 0.5 },
 }

package/package.json

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

package/lib/path.js

@@ -1,3 +0,0 @@
-import path from 'node:path'
-
-export default process.platform === 'win32' ? path.win32 : path