Skip to content

Commit

Permalink
fix(format): formatted files and adds updates config
Browse files Browse the repository at this point in the history
  • Loading branch information
invincibleJai committed Jan 7, 2019
1 parent bb437ab commit ca27c80
Show file tree
Hide file tree
Showing 24 changed files with 2,224 additions and 1,653 deletions.
4 changes: 4 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// prettier.config.js or .prettierrc.js
module.exports = {
singleQuote: true
};
27 changes: 27 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
// Place your settings in this file to overwrite default and user settings.
{
"[typescript]": {
"editor.formatOnSave": true
},
"[typescriptreact]": {
"editor.formatOnSave": true
},
"[javascript]": {
"editor.formatOnSave": true
},
"[json]": {
"editor.formatOnSave": true
},
"[scss]": {
"editor.formatOnSave": true
},
"[css]": {
"editor.formatOnSave": true
},
"[less]": {
"editor.formatOnSave": true
},
"[html]": {
"editor.formatOnSave": true
},
"[markdown]": {
"editor.formatOnSave": true
},
"files.exclude": {
"out": false // set this to true to hide the "out" folder with the compiled JS files
},
Expand Down
1 change: 1 addition & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.vscode/**
.vscode-test/**
.prettierrc.js
typings/**
out/test/**
test/**
Expand Down
74 changes: 37 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,46 @@
[![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/version/redhat.fabric8-analytics.svg)](https://marketplace.visualstudio.com/items?itemName=redhat.fabric8-analytics)

'Dependency Analytics Report' with Insights about your application dependencies:
* Flags a security vulnerability(CVE) and suggests a remedial version
* Shows Github popularity metrics along with latest version
* Suggests a project level license, check for conflicts between dependency licences
* AI based guidance for additional, alternative dependencies

- Flags a security vulnerability(CVE) and suggests a remedial version
- Shows Github popularity metrics along with latest version
- Suggests a project level license, check for conflicts between dependency licences
- AI based guidance for additional, alternative dependencies

## Supported Languages

'Dependency Analytics' extension supports projects using Maven, projects build on npm (Node ecosystem) and projects using Python.
'Dependency Analytics' extension supports projects using Maven, projects build on npm (Node ecosystem) and projects using Python.
Extending support for Go languages is currently under progress.

## Prerequisites

This extension assumes you have the following binaries on your `PATH`:

* `mvn` (for analyzing Java applications)
* `npm` (for analyzing Node applications)
* `python` (for analyzing Python applications)
- `mvn` (for analyzing Java applications)
- `npm` (for analyzing Node applications)
- `python` (for analyzing Python applications)

**Note:** By default, the `mvn/npm` command is executed directly in the terminal, which requires that `mvn/npm` is found in your system environment `PATH`. For Python applications [Interpreter Path](https://code.visualstudio.com/docs/python/environments#_manually-specify-an-interpreter) is required to be provided as below.
You can do this via preferences in VS Code:
File(Code on macOS) > Preferences > Settings to open your [Settings](https://code.visualstudio.com/docs/getstarted/settings), select Workspace (open settings.json) and add below.

**Note:** By default, the `mvn/npm` command is executed directly in the terminal, which requires that `mvn/npm` is found in your system environment `PATH`. For Python applications [Interpreter Path](https://code.visualstudio.com/docs/python/environments#_manually-specify-an-interpreter) is required to be provided as below.
You can do this via preferences in VS Code:
File(Code on macOS) > Preferences > Settings to open your [Settings](https://code.visualstudio.com/docs/getstarted/settings), select Workspace (open settings.json) and add below.

```
{
...
"maven.executable.path": "/path-to-maven-home/bin/mvn"
"npm.executable.path": "/path-to-npm-home/bin/npm"
...
"maven.executable.path": "/path-to-maven-home/bin/mvn",
"npm.executable.path": "/path-to-npm-home/bin/npm",
"python.pythonPath": "/path-to-python-home/bin/python"
...
}
```
...
}
```

> **NOTE** Dependency Analytics is an online service hosted and maintained by Red Hat. This open source software will access only your manifests and license file(s) to learn about application dependencies and licenses before giving you the report.
## Quick Start

- Install the extension.
- Opening or editing a manifest file (`pom.xml` / `package.json`/ `requirements.txt`) scans your application for security vulnerabilities.
- Right click on a manifest file (`pom.xml`/`package.json`/ `requirements.txt`) in the 'Vscode File explorer' or 'Vscode File editor' to display 'Dependency Analytics Report' for your application.

- Install the extension.
- Opening or editing a manifest file (`pom.xml` / `package.json`/ `requirements.txt`) scans your application for security vulnerabilities.
- Right click on a manifest file (`pom.xml`/`package.json`/ `requirements.txt`) in the 'Vscode File explorer' or 'Vscode File editor' to display 'Dependency Analytics Report' for your application.

## Features

Expand All @@ -52,34 +52,34 @@ This extension assumes you have the following binaries on your `PATH`:
![ screencast ](https://raw.githubusercontent.com/fabric8-analytics/fabric8-analytics-vscode-extension/master/images/compAnalysis.gif)

2. Right click on a manifest file(`pom.xml` / `package.json`/ `requirements.txt`) and choose 'Dependency Analytics Report ...' to display 'Dependency Analytics' report. This report covers deeper insights into your application dependencies:
* Flags a security vulnerability(CVE) and suggests a remedial version
* Shows Github popularity metrics along with latest version
* Suggests a project level license, check for conflicts between dependency licences
* AI based guidance for additional,alternative dependencies

- Flags a security vulnerability(CVE) and suggests a remedial version
- Shows Github popularity metrics along with latest version
- Suggests a project level license, check for conflicts between dependency licences
- AI based guidance for additional,alternative dependencies

![ screencast ](https://raw.githubusercontent.com/fabric8-analytics/fabric8-analytics-vscode-extension/master/images/stackanalysis.gif)

3. **For multi module maven application** Right click on root `pom.xml` in editor window and choose 'Dependency Analytics Report ...' to display 'Dependency Analytics' report for the entire application.

![ screencast ](https://raw.githubusercontent.com/fabric8-analytics/fabric8-analytics-vscode-extension/master/images/stackanalysis-multi.gif)

-------------------------------------------------------------------------------------------------------------------
---

**Note** It creates a folder `target` in workspace which is used for processing of manifest files, needed for generating stack report. So kindly add `target` in `.gitignore`.

Know more about Dependency Analytics Platform
==============================================
# Know more about Dependency Analytics Platform

The mission of this project is to significantly enhance developer experience:
providing Insights(security, licenses, AI based guidance) for applications and helping developers, Enterprises.

* [GitHub Organization](https://github.com/fabric8-analytics)
- [GitHub Organization](https://github.com/fabric8-analytics)

Feedback & Questions
====================
* File a bug in [GitHub Issues](https://github.com/fabric8-analytics/fabric8-analytics-vscode-extension/issues)
* Chat with us on [Mattermost](https://chat.openshift.io/developers/channels/fabric8-analytics)
# Feedback & Questions

License
=======
Apache 2.0, See [LICENSE](LICENSE) for more information.
- File a bug in [GitHub Issues](https://github.com/fabric8-analytics/fabric8-analytics-vscode-extension/issues)
- Chat with us on [Mattermost](https://chat.openshift.io/developers/channels/fabric8-analytics)

# License

Apache 2.0, See [LICENSE](LICENSE) for more information.
Binary file modified src/.DS_Store
Binary file not shown.
Loading

0 comments on commit ca27c80

Please sign in to comment.