# `<%= projectName %>`
> <%= description %>

[![Swagger Validity][swagger-validity-image]][swagger-validity-url] <% if (privateRepo) { %> [![Build Status][jenkins-image]][jenkins-url] [![Sonar coverage][sonar-coverage-img]][sonar-coverage-url] [![Quality Gate][sonar-gate-img]][sonar-gate-url] [![Complexity][sonar-complexity-img]][sonar-complexity-url]
<% } else { %>
[![Build Status][travis-image]][travis-url] [![Sonar coverage][sonar-coverage-img]][sonar-coverage-url] [![Quality Gate][sonar-gate-img]][sonar-gate-url] [![Complexity][sonar-complexity-img]][sonar-complexity-url] <br>[![NSP Status][nsp-img]][nsp-url] [![Dependency Status][daviddm-image]][daviddm-url] [![devDependencies Status][daviddm-dev-image]][daviddm-dev-url]<br>[![NPM version][npm-image]][npm-url] [![Readme Score][readme-score-img]][readme-score-url] [![PRs Welcome][makeapullrequest-image]][makeapullrequest-url] [![FOSSA Status][fossa-image]][fossa-url] <% if (includeCoveralls) { %> [![Coverage percentage][coveralls-image]][coveralls-url]<% } -%>
<% } -%>

> ##### :heavy_minus_sign::x::heavy_minus_sign: _Delete this section before you push to your Git repository._ :heavy_minus_sign::x::heavy_minus_sign:
> #### For your _action_ :running:.
>
> There are a few tasks you'll have to complete manually in order to benefit
> from your new project's DevSecOps features.
>
> 1. #### Node Security Program (`nsp`) badge activation.
> **`<%= projectName %>`** has been set up to check for known vulnerabilities with `nsp`. If you want to display `nsp's` vulnerabilities status on your README page, however, you need to [set up a Node Security Program account][nsp-sign-up-url] to activate your NSP badge.
> Once you've activated an account, update the HREFs at the bottom of this README:<br><br>
> ```text
> [nsp-image]: https://nodesecurity.io/orgs/<%= scmAccount %>/projects/REPLACE-THIS-WITH-YOUR-NSP-UUID/badge
> [nsp-url]: https://nodesecurity.io/orgs/<%= scmAccount %>/projects/REPLACE-THIS-WITH-YOUR-NSP-UUID
> ```
> 2. #### Swagger validity badge activation
> If you want to display Swagger status, update these HREFs at the bottom of README.md:<br><br>
> ```text
> \\\[swagger-validity-image\\\]: https://img.shields.io/swagger/valid/2.0/PROTOCOL/HOSTNAME/PATHNAME/openapi.json.svg
> \\\[swagger-validity-url\\\]: http://online.swagger.io/validator/debug?url=PROTOCOL://HOSTNAME/PATHNAME/openapi.json
> ```
> 3. #### CI/CD services activation
>     * **Jenkins**: [Provision a Verizon service account in ADOM](https://atyourservice.verizon.com/ays?id=ays_kb_article&sys_id=327d5ccfdb886200025e59ffdf961927) to trigger Jenkins workflows (if you do not have an active Service Account already).
>     * **SonarQube**: [On-board your API Proxy with OneSonarQube](https://devops.verizon.com/Helpdesk/SonarOnboarding.aspx) to trigger quality gateway analysis.
>
> ##### Thank you for using `generator-apiproxy` :smile:!
> ##### :heavy_minus_sign::x::heavy_minus_sign: _Delete this section before you push to your Git repository._ :heavy_minus_sign::x::heavy_minus_sign:

## Table of contents
<!-- toc -->

<!-- tocstop -->

<% if (!content) { -%>
## Installation

Open a Terminal and run this command:

```sh

$ npm install --save <%= projectName %>

```

## Usage

```js

const <%= safeProjectName %> = require('<%= projectName %>');

<%= safeProjectName %>('Rainbow');

```
<% } else { -%>
<%= content %>
<% } -%>

## Quality gates, reports, and documentation

This repository demonstrates best practices for an API Proxy that uses custom Javascript API policies to adapt a "flat", proprietary contact info service into the expected Cordova Contacts API.

Therefore, we need to enforce Swagger quality; Javascript quality; and Javascript unit tests and code coverage.

### Swagger validation and badge
> :trophy: `<%= projectName %>` validates Swagger docs with [`swagger-cli`][swagger-cli-url].

[`swagger-cli`][swagger-cli-url] validation runs before every test execution:

```bash
# These two npm-scripts run lint automatically:
$ npm run pretest

$ npm test

# Lint Javascript callouts and Swagger *.yml or *.json docs:
$ npm run lint

# You can also validate your Swagger docs independently with:
$ npm run swagger:lint

```

[`swagger-api/validator-badge`](https://github.com/swagger-api/validator-badge)s display whether there are syntactic issues with you Swagger/OpenAPI 2.0 document.

### Javascript callout source code analysis
> :closed_lock_with_key: :bath: :ocean: `<%= projectName %>` lints source code; checks for vulnerabilities; assesses dependency drift; and executes quality gates with `BitHound`, `eslint`, `nsp`, and `SonarQube`/`sonarcloud`.
>
> The results are displayed real-time with README badges.



```bash
# Code quality analysis runs before every test execution:
$ npm test

# Validate Swagger and analyze Javascript callouts:
$ npm run lint

# Only run ESLint for a CLI summary:
$ npm run eslint:stylish

# Generate an HTML report with links to errors and warnings:
$ npm run eslint:html
```

### Javascript callout test execution and code coverage
> :100: `<%= projectName %>` uses `jest` for BDD spec execution and code coverage analysis.
>
> The results are displayed real-time with README badges.

Generate detailed code coverage reports at `coverage/lcov-report/index.html` and `lcov.info` and `clover.xml` files  (which you can send to CI test coverage services like <% if (includeCoveralls) { %> Coveralls and <% } -%> [OneSonarQube][one-sonar-url] or [SonarCloud][sonarcloud-url]):

```bash

$ npm test

```

### API documentation and complexity reports
> :page_facing_up: `<%= projectName %>` automatically generates API docs with
> * [`jsdoc-to-markdown`][jsdoc2md-url],
> * [`complexity-report`][complexity-report-url]s, and Git-friendly
> * [`swagger-markdown`][swagger-markdown-url]
>
> You can view the [complexity report][complexity-report-url],
> [Javascript callout API docs][js-callout-docs-url], and
> [Swagger API docs][swagger-api-docs-url] in the `docs/` directory.

To generate API docs, Swagger docs, and Complexity reports in the `lib` directory, run:

```bash
# Generate all docs
$ npm run docs

# Only create static Swagger API docs:
$ npm run docs:swagger

# Only generate Javascript callout API docs:
$ npm run docs:api

# Only generate complexity reports:
$ npm run docs:complexity
```

## Semantic version and CHANGELOG

The latest version of `<%= projectName %>` is `v<%= version %>`. View the [CHANGELOG][changelog-url] for details.

## Contributing to `<%= projectName %>`

:family: We welcome contributors and pull requests. Check out the guidelines for [contributing to `<%= projectName %>`][contributing-url] and our [Contributor Covenant Code of Conduct][code-of-conduct-url].

Contributions are stories with a beginning, a middle, and an end, all told through issues, comments, and pull requests.

 * [Peruse open issues][issues-url] or
 * [Open a new pull request (PR)][pr-url]

## License

<%= license %> © [<%= author.name %>](<%= author.url %>)


[changelog-url]: ./CHANGELOG.md
[code-of-conduct-url]: .github/CODE_OF_CONDUCT.md
[complexity-report-url]: ./docs/COMPLEXITY.md
[contributing-url]: .github/CONTRIBUTING.md
[daviddm-image]: https://david-dm.org/<%= scmAccount %>/<%= projectName %>.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/<%= scmAccount %>/<%= projectName %>
[js-callout-docs-url]: ./docs/JSCAPIS.md
[jsdoc-url]: http://usejsdoc.org/
[jsdoc2md-url]: https://github.com/jsdoc2md/jsdoc-to-markdown
[npm-image]: https://badge.fury.io/js/<%= projectName %>.svg
[npm-url]: https://npmjs.org/package/<%= projectName %>
[nsp-image]: https://nodesecurity.io/orgs/<%= scmAccount %>/projects/REPLACE-THIS-WITH-YOUR-NSP-UUID/badge
[nsp-sign-up-url]: https://nodesecurity.io/signup
[nsp-url]: https://nodesecurity.io/orgs/<%= scmAccount %>/projects/REPLACE-THIS-WITH-YOUR-NSP-UUID
[one-sonar-url]: http://onesonar.verizon.com/
[sonarcloud-url]: https://sonarcloud.io
[swagger-api-docs-url]: ./docs/SWAGGER.md
[swagger-cli-url]: https://github.com/BigstickCarpet/swagger-cli
[swagger-io-url]: http://swagger.io
[swagger-logo-20-image]: .assets/media/img/swagger-logo-20.png
[swagger-markdown-url]: https://github.com/syroegkin/swagger-markdown
[swagger-validity-image]: https://img.shields.io/swagger/valid/2.0/PROTOCOL/HOSTNAME/PATHNAME/openapi.json.svg
[swagger-validity-url]: http://online.swagger.io/validator/debug?url=http://HOSTNAME/PATHNAME/openapi.json
[travis-image]: https://travis-ci.org/<%= scmAccount %>/<%= projectName %>.svg?branch=master
[travis-url]: https://travis-ci.org/<%= scmAccount %>/<%= projectName %>
<% if (includeCoveralls) { -%>
[coveralls-image]: https://coveralls.io/repos/<%= scmAccount %>/<%= projectName %>/badge.svg
[coveralls-url]: https://coveralls.io/r/<%= scmAccount %>/<%= projectName %>
<% } -%>