elasticsearch-js/scripts/generate-docs-examples.js

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

'use strict'

/**
 * To run this generator you must have the
 * `alternatives_report.spec.json` placed in the root of this project.
 * To get the `alternatives_report.spec.json` you must run the script
 * to parse the original `alternatives_report.json`, which is not yet public
 * and lives in github.com/elastic/clients-team/tree/master/scripts/docs-json-generator
 *
 * This script will remove the content of the `docs/doc_examples` folder and generate
 * all the files present in the `enabledFiles` list below.
 * You can run it with the following command:
 *
 * ```bash
 *   $ node scripts/generate-docs-examples.js
 * ```
 */

const { join } = require('path')
const { writeFileSync } = require('fs')
const rimraf = require('rimraf')
const standard = require('standard')
const dedent = require('dedent')

const docsExamplesDir = join('docs', 'doc_examples')

const enabledFiles = [
  'docs/delete.asciidoc',
  'docs/get.asciidoc',
  'docs/index_.asciidoc',
  'getting-started.asciidoc',
  'query-dsl/query-string-query.asciidoc',
  'query-dsl.asciidoc',
  'search/request-body.asciidoc',
  'setup/install/check-running.asciidoc',
  'mapping.asciidoc',
  'query-dsl/query_filter_context.asciidoc',
  'query-dsl/bool-query.asciidoc',
  'query-dsl/match-query.asciidoc',
  'indices/create-index.asciidoc',
  'docs/index_.asciidoc',
  'aggregations/bucket/terms-aggregation.asciidoc',
  'query-dsl/range-query.asciidoc',
  'search/search.asciidoc',
  'query-dsl/multi-match-query.asciidoc',
  'docs/bulk.asciidoc',
  'indices/delete-index.asciidoc',
  'indices/put-mapping.asciidoc',
  'query-dsl/match-all-query.asciidoc',
  'query-dsl/term-query.asciidoc',
  'docs/update.asciidoc',
  'docs/reindex.asciidoc',
  'indices/templates.asciidoc',
  'query-dsl/exists-query.asciidoc',
  'query-dsl/terms-query.asciidoc',
  'query-dsl/wildcard-query.asciidoc',
  'mapping/types/nested.asciidoc',
  'mapping/params/format.asciidoc',
  'docs/delete-by-query.asciidoc',
  'search/request/sort.asciidoc',
  'query-dsl/function-score-query.asciidoc',
  'query-dsl/nested-query.asciidoc',
  'query-dsl/regexp-query.asciidoc',
  'mapping/types/array.asciidoc',
  'mapping/types/date.asciidoc',
  'mapping/types/keyword.asciidoc',
  'mapping/params/fielddata.asciidoc',
  'cluster/health.asciidoc',
  'docs/bulk.asciidoc',
  'indices/aliases.asciidoc',
  'indices/update-settings.asciidoc',
  'search/request/from-size.asciidoc',
  'search/count.asciidoc',
  'setup/logging-config.asciidoc',
  'search/request/from-size.asciidoc',
  'query-dsl/match-phrase-query.asciidoc',
  'aggregations/metrics/valuecount-aggregation.asciidoc',
  'aggregations/bucket/datehistogram-aggregation.asciidoc',
  'aggregations/bucket/filter-aggregation.asciidoc',
  'mapping/types/numeric.asciidoc',
  'mapping/fields/id-field.asciidoc',
  'mapping/params/multi-fields.asciidoc',
  'api-conventions.asciidoc',
  'cat/indices.asciidoc',
  'docs/update-by-query.asciidoc',
  'indices/get-index.asciidoc',
  'indices/get-mapping.asciidoc',
  'search.asciidoc',
  'search/request/scroll.asciidoc',
  'search/suggesters.asciidoc'
]

function generate () {
  rimraf.sync(join(docsExamplesDir, '*'))
  const examples = require(join(__dirname, '..', 'alternatives_report.spec.json'))
  for (const example of examples) {
    if (example.lang !== 'console') continue
    if (!enabledFiles.includes(example.source_location.file)) continue

    const asciidoc = generateAsciidoc(example.parsed_source)
    writeFileSync(
      join(docsExamplesDir, `${example.digest}.asciidoc`),
      asciidoc,
      'utf8'
    )
  }
}

function generateAsciidoc (source) {
  let asciidoc = '// This file is autogenerated, DO NOT EDIT\n'
  asciidoc += '// Use `node scripts/generate-docs-examples.js` to generate the docs examples\n\n'
  let code = 'async function run (client) {\n// START\n'

  for (let i = 0; i < source.length; i++) {
    const { api, query, params, body } = source[i]
    const apiArguments = Object.assign({}, params, query, body ? { body } : body)
    const serializedApiArguments = Object.keys(apiArguments).length > 0
      ? JSON.stringify(apiArguments, null, 2)
      : ''
    code += `const response${getResponsePostfix(i)} = await client.${api.replace(/_([a-z])/g, g => g[1].toUpperCase())}(${serializedApiArguments})
console.log(response${getResponsePostfix(i)})
\n`
  }

  code += '// END\n}'
  const { results } = standard.lintTextSync(code, { fix: true })
  code = results[0].output
  code = code.slice(code.indexOf('// START\n') + 9, code.indexOf('\n\n// END'))

  asciidoc += `[source, js]
----
${dedent(code)}
----

`
  return asciidoc

  function getResponsePostfix (i) {
    if (source.length === 1) return ''
    return String(i)
  }
}

generate()