Przeglądaj źródła

Adding LICENSE and README

bodicsek 4 lat temu
rodzic
commit
7d260eafcb
4 zmienionych plików z 67 dodań i 2 usunięć
  1. 21 0
      LICENSE
  2. 0 1
      OSCS.rest
  3. 45 0
      README.md
  4. 1 1
      package.json

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hypriot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 0 - 1
OSCS.rest

@@ -1 +0,0 @@
-GET https://oscs.us.oracle.com/oscs/pls/isplsapproved?software=gulp&version=4.0.0

+ 45 - 0
README.md

@@ -0,0 +1,45 @@
+# @os-tools/npm-dependency-tree
+
+This tool's main purpose is to scan an npm project's dependency tree for Oracle Open Source Compliance.  
+
+Hence if you run it with the single required parameter `--package` then the result is (only packages eligible for compliance are shown):
+```
+$ npm-dependency-tree --package ./package.json 
+
+name,version,root,parent,type,audit
+node-fetch,2.6.1,,,dependency,n/a
+yargs,16.2.0,,,dependency,n/a
+@types/node,14.14.41,,,devDependency,n/a
+@types/node-fetch,2.5.10,,,devDependency,n/a
+@types/yargs,16.0.1,,,devDependency,n/a
+ts-node,9.1.1,,,devDependency,n/a
+typescript,4.2.4,,,devDependency,n/a
+```
+
+If you want audit results then run:
+```
+$ npm-dependency-tree --package ./package.json --audit
+
+name,version,root,parent,type,audit
+@types/node-fetch,2.5.10,,,devDependency,not registered
+yargs,16.2.0,,,dependency,registered
+node-fetch,2.6.1,,,dependency,registered
+typescript,4.2.4,,,devDependency,not registered
+@types/yargs,16.0.1,,,devDependency,not registered
+ts-node,9.1.1,,,devDependency,registered
+@types/node,14.14.41,,,devDependency,not registered
+```
+
+To get a sense of all the features run:
+```
+$ npm-dependency-tree --help
+
+Options:
+  --version  Show version number                                       [boolean]
+  --package  The full or relative path to the package.json file
+                                                             [string] [required]
+  --format   Possible values are 'tree' and 'csv'      [string] [default: "csv"]
+  --filter   Possible values are 'none' and 'oracle'[string] [default: "oracle"]
+  --audit    Open Source Compliance Service audit     [boolean] [default: false]
+  --help     Show help                                                 [boolean]
+```

+ 1 - 1
package.json

@@ -13,7 +13,7 @@
     "prepublishOnly": "npm run build"
   },
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "node-fetch": "^2.6.1",
     "yargs": "^16.2.0"