feat: add dump command for dumping a database table

nokome · nokome · commit bc6a4bc4fb13 · 2019-02-07T15:14:50.000+13:00
diff --git a/.travis.yml b/.travis.yml
@@ -19,6 +19,8 @@ script:
   - npx ts-node src/cli.ts update nixos-18.09
   - make cover
   - make docs
+  # Dump the packages to a TSV file for browsing (until we have a better way of browsing them)
+  - npx ts-node src/cli.ts dump packages --tsv > docs/packages.tsv
 
   # Generate Nix files
   # node2nix produce a lot of output on stderr which causes Travis to say
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -95,6 +95,8 @@ adds:
   - r-titrationcurves
 ```
 
+If you do not have Nixster installed it can be sometimes difficult to work out the right package name to use. Until we have a better solution, we currently dump a tab separated file of all packages to https://stencila.github.io/nixster/packages.tsv on each Travis build.
+
 #### Use Github editor
 
 Edit the `.yaml` file for the environment directly on Github using the `https://github.com/stencila/nixster/edit/master/envs/<ENIRONMENT-NAME>.yaml` URL. For example, for the `r-mega` environment, edit the `envs/r-mega.yaml` file with this [link](https://github.com/stencila/nixster/edit/master/envs/r-mega.yaml). Github should ask you if you want to fork the repository and create a new pull request for your edit. Follow the instructions above for adding/removing packages using a text editor.
diff --git a/src/cli.ts b/src/cli.ts
@@ -400,6 +400,34 @@ yargs
     output({ list, term, type }, argv, searchPrettify)
   })
 
+  .command('dump [table]', 'Search in database', (yargs: any) => {
+    yargs
+      .positional('table', {
+        describe: 'The database table to dump',
+        type: 'string',
+        default: 'packages'
+      })
+    // Usual output options, plus TSV
+    outputOptions(yargs)
+    yargs
+      .option('tsv', {
+        describe: 'Output as TSV (tab separated values)',
+        type: 'boolean'
+      })
+      .conflicts('tsv', 'format')
+      .conflicts('tsv', 'pretty')
+      .conflicts('tsv', 'yaml')
+      .conflicts('tsv', 'json')
+  }, async (argv: any) => {
+    const rows = await nix.dump(argv.table)
+    if (argv.format === 'tsv' || argv.tsv) {
+      console.log('name\ttype\tversion\tdescription')
+      for (let row of rows) {
+        console.log(`${row.name}\t${row.type}\t${row.version}\t${row.description}`)
+      }
+    } else output(rows, argv)
+  })
+
   .command('serve', 'Serve', (yargs: any) => {
     yargs
       .option('port', {
diff --git a/src/nix.ts b/src/nix.ts
@@ -240,6 +240,28 @@ export async function search (term: string, type: string = '', limit: number = 1
   return stmt.all(limit)
 }
 
+/**
+ * Dump one of the tables in the Nixster database
+ *
+ * @param table The table to dump
+ */
+export async function dump (table: string): Promise<Array<any>> {
+  let stmt
+  if (table === 'packages') {
+    stmt = db.prepare(`
+      SELECT name, type, max(version) AS version, max(channel) AS channel, max(description) AS description
+      FROM (
+        SELECT name, type, version, channel, description
+        FROM packages
+      )
+      GROUP BY name, type
+    `)
+  } else {
+    throw new Error(`Dumping table "${table}" is not supported`)
+  }
+  return stmt.all()
+}
+
 /**
  * Get the location of an environment within the Nix store
  *
