Merge pull request #577 from clearlydefined/master

merge master into prod in prep for v1.1.0 release

Author: elrayle

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "avoid",
+  "printWidth": 120,
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "none"
+}

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}

.prettierrc.json

@@ -1,10 +1,8 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-  "jshint.options": {
-    "esnext": true
-  },
   "editor.folding": false,
   "editor.tabSize": 2,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.detectIndentation": false,
   "editor.formatOnSave": false,
   "editor.formatOnType": true,

.vscode/extensions.json

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

.vscode/settings.json

@@ -5,7 +5,7 @@ The ClearlyDefined project welcomes your suggestions and contributions! Before o
 
 ## Contribution Licensing
 
-Most of our code is distributed under the terms of the [MIT license](LICENSE), and when you contribute code that you wrote to our repositories, 
+Most of our code is distributed under the terms of the [MIT license](LICENSE), and when you contribute code that you wrote to our repositories,
 you agree that you are contributing under those same terms. In addition, by submitting your contributions you are indicating that
 you have the right to submit those contributions under those terms.
 

CODE_OF_CONDUCT.md

@@ -38,7 +38,7 @@ RUN gem install nokogiri:1.12.5 --no-document && \
 
 # REUSE
 RUN pip3 install setuptools
-RUN pip3 install reuse
+RUN pip3 install reuse==3.0.1
 
 RUN git config --global --add safe.directory '*'
 

CONTRIBUTING.md

@@ -44,7 +44,7 @@ RUN gem install nokogiri:1.12.5 --no-document && \
 
 # REUSE
 RUN pip3 install setuptools
-RUN pip3 install reuse
+RUN pip3 install reuse==3.0.1
 
 # FOSSology
 # WORKDIR /opt

DevDockerfile

@@ -81,16 +81,20 @@ Process the source, if any:
 The crawler's output is stored for use by the rest of the ClearlyDefined infrastructure -- it is not intended to be used directly by humans. Note that each tool's output is stored separately and the results of processing the component and the component source are also separated.
 
 ### <a id="more-on-type"></a>More on `type`
+
 The `type` in the request object typically corresponds to an internal processor in CD.
-1. `component` is the most generic type.  Internally, it is converted to a `package` or `source` request by the component processor.
-2. `package` request is processed by the package processor and is further converted to a request with a specific type (`crate`, `deb`, `gem`, `go`, `maven`, `npm`, `nuget`, `composer`, `pod`, `pypi`).  For a `package` typed request, if the mentioned specific binary package type is known, the specific type (e.g. `npm`) can be used (instead of `package`) in the harvest request and skip the conversion step.  For example,
+
+1. `component` is the most generic type. Internally, it is converted to a `package` or `source` request by the component processor.
+2. `package` request is processed by the package processor and is further converted to a request with a specific type (`crate`, `deb`, `gem`, `go`, `maven`, `npm`, `nuget`, `composer`, `pod`, `pypi`). For a `package` typed request, if the mentioned specific binary package type is known, the specific type (e.g. `npm`) can be used (instead of `package`) in the harvest request and skip the conversion step. For example,
+
 ```json
 {
   "type": "npm",
   "url": "cd:/npm/npmjs/-/redie/0.3.0"
 }
 ```
-3. `source` requests are processed by the source processor, which subsequently dispatches a `clearlydefined` typed request for the supported source types and other requests (one for each scanning tool).  These are the more advanced scenarios where the request type and the coordinate type differ.
+
+3. `source` requests are processed by the source processor, which subsequently dispatches a `clearlydefined` typed request for the supported source types and other requests (one for each scanning tool). These are the more advanced scenarios where the request type and the coordinate type differ.
 
 # Configuration
 
@@ -238,7 +242,8 @@ Make sure you started the container with the 5000 port forwarded for this to wor
       -X POST \
       http://crawler:5000/requests
 
-  On windows:
+On Windows:
+
     curl -d "{\"type\":\"npm\", \"url\":\"cd:/npm/npmjs/-/redie/0.3.0\"}" -H "Content-Type: application/json" -H "X-token: secret" -X POST http://localhost:5000/requests
 
 Expose dashboard port: