# security-sonarqube

**Repository Path**: ScrumLeanMaster/Project-Sonar

## Basic Information

- **Project Name**: security-sonarqube
- **Description**: Sonar 是由微软 Edge 浏览器团队开源的 linting 工具和网站扫描工具，能够帮助站长检查网站潜藏的性能和安全问题，帮助开发者创建更快、更好和更安全的网站
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2018-03-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sonarwhal

<!-- markdownlint-disable MD013 MD033 -->

<p align="center">
    <img src="https://user-images.githubusercontent.com/1223565/34734522-e0dd1226-f520-11e7-8277-ec0e0a7199c1.png" alt="sonarwhal logo">
    <a href="https://travis-ci.org/sonarwhal/sonarwhal"><img src="https://travis-ci.org/sonarwhal/sonarwhal.svg?branch=master" alt="Travis CI Build Status"></a> <a href="https://ci.appveyor.com/project/NellieTheNarwhal/sonarwhal"><img src="https://ci.appveyor.com/api/projects/status/r2via8w2s1ras3ui?svg=true" alt="AppVeyor Build Status"></a> <a href="https://gitter.im/sonarwhal/Lobby"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a>
</p>

<!-- markdownlint-enable -->

## Quick start user guide

Once you have [`Node.js`](https://nodejs.org/en/download/current/)
v8.x on your machine, you can use `npx` or install `sonarwhal` globally
to use it.

### Using `npx`

Just run the following command:

```bash
npx sonarwhal https://example.com
```

This will start the wizard to create a `.sonarwhalrc` file, and then
analyze `https://example.com`.

**Windows users**: Currently [`npx` has an issue in this
platform](https://github.com/npm/npm/issues/17869).

### Installing `sonarwhal` globally

```bash
npm install -g --engine-strict sonarwhal
```

Create a `.sonarwhalrc` file by running this command and following the
instructions:

```bash
sonarwhal --init
```

Scan a website:

```bash
sonarwhal https://example.com
```

For more in depth information on how to get started, configurations,
and more, see the online [user guide](https://sonarwhal.com/docs/user-guide/),
or the [local version](./packages/sonarwhal/docs/user-guide/index.md)
for the most recent (and unstable) content.

## Contributing to sonarwhal

To know more about the internals of `sonarwhal`, the structure of the
project, how to create new rules, collectors, formatters, etc, take a
look at the online [contributor
guide](https://sonarwhal.com/docs/contributor-guide/) (or the [local
version](./packages/sonarwhal/docs/contributor-guide/index.md)).

## Code of Conduct

This project adheres to the JS Foundation’s [code of
conduct](https://js.foundation/community/code-of-conduct).
By participating in this project you agree to abide by its terms.

## License

The code is available under the [Apache 2.0 license](LICENSE.txt).