wikibase-cli 15.15.6 → 15.16.3

package/README.md

@@ -5,6 +5,8 @@ This tool is mostly a CLI interface to the JS modules [wikibase-edit](https://ww
 
 It was primarily developed to target [Wikidata](https://wikidata.org), but as then been decoupled to support any Wikibase instance.
 
+Supported systems: any system that can run [NodeJS](https://nodejs.org/en/download/) (Linux, Mac OS, Windows, and more)
+
 This project received [a Wikimedia Project Grant](https://meta.wikimedia.org/wiki/Grants:Project/WikidataJS).
 
 <div align="center">

package/bin/wb-claims

@@ -3,6 +3,7 @@ const program = require('../lib/program')
 
 program
 .option('-a, --all', 'include all claims, not only the truthy ones')
+.option('-t, --type <type>', 'Keep only claims with the specified datatype')
 .process('claims')
 
 const { yellow } = require('chalk')

package/bin/wb-props

@@ -4,7 +4,7 @@ const { red } = require('chalk')
 
 program
 .option('-d, --details', 'include properties labels, types, descriptions, and aliases')
-.option('-t, --type', 'include properties types')
+.option('-t, --type [type]', 'include properties types, or if a type is specified, keep only properties with that type')
 .option('--no-cache', 'ignore properties cache')
 .option('-r, --reset', 'clear properties cache')
 .process('props')

package/bin/wd

@@ -1,2 +1,9 @@
-#!/usr/bin/env sh
-export WB_INSTANCE=https://www.wikidata.org WB_SPARQL_ENDPOINT=https://query.wikidata.org/sparql ; wb "$@"
+#!/usr/bin/env node
+
+process.env.WB_INSTANCE = 'https://www.wikidata.org'
+process.env.WB_SPARQL_ENDPOINT = 'https://query.wikidata.org/sparql'
+// Fake the executed script to be wb to trick commander to believe it
+// as it would otherwise fail to build subcommand paths
+process.argv[1] = process.argv[1].replace(/\/wd$/, '/wb')
+
+require('./wb')

package/lib/get_pattern_filter.js

@@ -1,9 +1,18 @@
+const program = require('./program')
 const { propTypes } = require('./properties')
 
 module.exports = (pattern, includeTypes) => {
-  if (!(pattern && pattern.length > 0)) return
+  const { type } = program
+  if (!(pattern && pattern.length > 0)) {
+    if (typeof type === 'string') {
+      // Consider that what was passed as a type argument was actually a pattern
+      if (!(type.toLowerCase() in propTypes)) pattern = type
+    } else {
+      return
+    }
+  }
 
-  if (includeTypes && pattern in propTypes) {
+  if (includeTypes && pattern.toLowerCase() in propTypes) {
     return propData => propData.type === pattern
   }
 
@@ -13,7 +22,15 @@ module.exports = (pattern, includeTypes) => {
   const flag = allLowercased ? 'ig' : 'g'
   const filterRegex = new RegExp(pattern, flag)
 
+  let typeFilter
+  if (typeof type === 'string' && type.toLowerCase() in propTypes) {
+    typeFilter = propData => propData.type === type
+  } else {
+    typeFilter = () => true
+  }
+
   const filterFn = propData => {
+    if (!typeFilter(propData)) return false
     if (propData == null) return false
     const { label, description, aliases } = propData
     const propStr = [ label, description, aliases ].join(' ')

package/lib/log_claims.js

@@ -16,7 +16,7 @@ module.exports = async ({ program, simplifiedClaims, extraData = {}, pattern, re
 
   logExtraData(extraData, labels)
 
-  if (pattern) {
+  if (pattern || program.type) {
     simplifiedClaims = filterClaimsProperties(propertiesData, simplifiedClaims, pattern)
   }
 

package/lib/output.js

@@ -1,8 +1,10 @@
 const types = require('./types')
+const { promisify } = require('util')
+const stdoutWrite = promisify(process.stdout.write).bind(process.stdout)
 
 // Calling program just in time, so that code running
 // after this first level function can still change the option
-module.exports = program => (data, optional, customColors) => {
+module.exports = program => async (data, optional, customColors) => {
   const isArray = types.isArray(data)
   const isPlainObject = types.isPlainObject(data)
   const isCollection = types.isCollection(data)
@@ -16,7 +18,7 @@ module.exports = program => (data, optional, customColors) => {
   if (optional) {
     if (!program.verbose) return
     if (!customColors) data = require('chalk').grey(data)
-    log(data)
+    await log(data)
   } else {
     if (isArray && !isCollection && !program.json) {
       if (program.format === 'inline') data = data.join(' ')
@@ -36,16 +38,16 @@ module.exports = program => (data, optional, customColors) => {
     if (program.clipboard) {
       require('./copy')(data)
     } else {
-      log(data)
+      await log(data)
       process.exit(0)
     }
   }
 }
 
-const log = data => {
+const log = async data => {
   if (typeof data === 'string') {
     if (!data.endsWith('\n')) data += '\n'
-    process.stdout.write(data)
+    await stdoutWrite(data)
   } else {
     console.log(data)
   }

package/metadata/claims.js

@@ -13,7 +13,7 @@ module.exports = {
   examples: [
     { args: 'Q2001', comment: 'fetch all claims for the entity Q2001' },
     { args: 'Q2001 P106', comment: 'or just the claims for the property P106' },
-    { args: 'Q2001 Url', comment: 'or just the claims from properties of type Url (other possible types: ExternalId, String, WikibaseItem, WikibaseProperty, Time, Monolingualtext, Quantity, CommonsMedia, GlobeCoordinate)' },
+    { args: 'Q2001 --type Url', comment: 'or just the claims from properties of type Url (other possible types: ExternalId, String, WikibaseItem, WikibaseProperty, Time, Monolingualtext, Quantity, CommonsMedia, GlobeCoordinate)' },
     { args: 'Q2001 library', comment: 'or just the claims from properties with labels matching "library"' },
     { args: 'Q2001 website', comment: 'or website, etc' },
     { args: 'Q2001 --lang de', comment: 'fetch all claims for the entity Q2001 with properties labels in German' }

package/metadata/props.js

@@ -16,6 +16,7 @@ module.exports = {
     { args: '--details', comment: 'output all properties, with their labels, types, descriptions, and aliases' },
     { args: 'image', comment: 'filter the properties to keep only those with labels matching "image"' },
     { args: '--type Url', comment: 'filter the properties to keep only those of type Url (other possible types: ExternalId, String, WikibaseItem, WikibaseProperty, Time, Monolingualtext, Quantity, CommonsMedia, GlobeCoordinate)' },
+    { args: '--type Url ref', comment: 'filter the properties to keep only those of type Url matching the pattern "ref"' },
     { args: '--lang sv', comment: 'output all the properties with their label in Swedish' },
     { args: '--no-cache', comment: 'ignore properties cache: fetch properties from the SPARQL endpoint, even if already cached' },
     { args: '--reset', comment: 'delete all the cached properties files to get fresh versions on the next execution' }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikibase-cli",
-  "version": "15.15.6",
+  "version": "15.16.3",
   "description": "A command-line interface to Wikibase",
   "main": "index.js",
   "bin": {
@@ -13,7 +13,7 @@
     "lint-staged": "./scripts/lint_staged",
     "prepublishOnly": "npm run lint && npm test",
     "postpublish": "npm run docker:publish && git push --tags",
-    "test": "mocha --exit --timeout 20000",
+    "test": "mocha --exit --timeout 20000 $MOCHA_OPTIONS",
     "update-toc": "./scripts/update_toc"
   },
   "repository": {
@@ -49,7 +49,7 @@
     "read": "^1.0.7",
     "split": "^1.0.1",
     "through": "^2.3.8",
-    "wikibase-edit": "^4.14.2",
+    "wikibase-edit": "^4.16.0",
     "wikibase-sdk": "^7.14.1",
     "wikidata-lang": "^2.0.11"
   },