ts-node-client 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/.editorconfig +10 -0
  2. package/.gitattributes +4 -0
  3. package/.pnp.cjs +14233 -0
  4. package/.pnp.loader.mjs +2042 -0
  5. package/.yarnrc.yml +1 -0
  6. package/CHANGELOG.md +37 -22
  7. package/README.md +188 -183
  8. package/bin/ts-node-client.js +196 -196
  9. package/lib/npm-scanner.js +327 -304
  10. package/package.json +56 -57
package/.yarnrc.yml ADDED
@@ -0,0 +1 @@
1
+ yarnPath: .yarn/releases/yarn-3.5.0.cjs
package/CHANGELOG.md CHANGED
@@ -1,22 +1,37 @@
1
- # ts-node-client
2
-
3
- ## Changelog
4
-
5
- All notable changes to this project will be documented in this file.
6
-
7
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
8
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9
-
10
-
11
- ## 3.0.0 - 2023-02-08
12
-
13
- ### Changed
14
- * `npm.ls` cli -> `package-lock.json` or `package.json` or `yarn.lock` parse
15
- * npm removed
16
- * updated dependencies
17
-
18
-
19
- ## 2.1.3 - 2022-12-26
20
-
21
- ### Changed
22
- * Migrate versions of dependencies
1
+ # ts-node-client
2
+
3
+ ## Changelog
4
+
5
+ All notable changes to this project will be documented in this file.
6
+
7
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
8
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9
+
10
+
11
+ ## 3.1.0 - 2023-04-20
12
+
13
+ ### Added
14
+ * support for yarn v2+ lock files
15
+
16
+ ### Changed
17
+ * project migrated to yarn 3.5
18
+
19
+
20
+ ## 3.0.1 - 2023-02-08
21
+
22
+ ### Changed
23
+ * docs updated
24
+
25
+
26
+ ## 3.0.0 - 2023-02-08
27
+
28
+ ### Changed
29
+ * `npm.ls` cli -> `package-lock.json` or `package.json` or `yarn.lock` parse
30
+ * npm removed
31
+ * updated dependencies
32
+
33
+
34
+ ## 2.1.3 - 2022-12-26
35
+
36
+ ### Changed
37
+ * Migrate versions of dependencies
package/README.md CHANGED
@@ -1,183 +1,188 @@
1
- # TrustSource ts-node-client
2
-
3
- [![Version](https://img.shields.io/npm/v/ts-node-client.svg)](http://npm.im/ts-node-client)
4
- [![Downloads](https://img.shields.io/npm/dm/ts-node-client.svg)](http://npm-stat.com/charts.html?package=ts-node-client)
5
- [![Downloads](https://img.shields.io/npm/dt/ts-node-client.svg)](http://npm-stat.com/charts.html?package=ts-node-client)
6
- [![Apache-2.0 License](https://img.shields.io/npm/l/ts-node-client?style=flat-square)](http://opensource.org/licenses/Apache-2.0)
7
-
8
- [![npm package](https://nodei.co/npm/ts-node-client.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/ts-node-client/)
9
-
10
- > TrustSource node client - node module to transfer dependency information to TrustSource server.
11
-
12
- ## Release 3.0.0
13
- Package now is not including `npm`. This was done due to missing programmatic API in npm >= 8.0.0 and in order to skip deprecated dependencies
14
-
15
- This change affects structure of scans, but improve tool.
16
-
17
-
18
- ## Requirements
19
- * node >= 8.9.0
20
- * npm < 8.0.0 use **ts-node-client@1.***
21
- * npm >= 8.0.0 use **ts-node-client@2.***
22
-
23
- ## Installation
24
- Run: `npm install --save-dev ts-node-client` or `yarn add --dev ts-node-client`
25
-
26
- You can add `install_and_scan` script to the package.json file to install and transfer dependency information using one command `npm run install_and_scan`:
27
-
28
- ```
29
- "scripts": {
30
- "install_and_scan": "npm install && ts-node-client -k apiKey -p Project"
31
- },
32
- ```
33
-
34
- To store your credentials for automated transfer you may create `.tsrc.json` in your project directory or in your home directory to set credentials globally (not recommended!)
35
-
36
- `.tsrc.json` example:
37
-
38
- ```
39
- {
40
- "apiKey": "apiKey",
41
- "url": "https://app.trustsource.io",
42
- "project": "Project Description"
43
- }
44
-
45
- ```
46
-
47
- Usage
48
- =====
49
-
50
- You also may initiate transfer to TrustSource server manually by executing following command via terminal:
51
-
52
- ```
53
- node_modules/.bin/ts-node-client
54
- node_modules/.bin/ts-node-client -k apiKey -p Project --breakOnWarnings false --breakOnViolations true
55
- node_modules/.bin/ts-node-client -c config.json
56
- ```
57
- ```
58
- npm / node module to transfer dependency information to TrustSource server.
59
-
60
- Options:
61
- --apiKey, -k apiKey [default: null]
62
- --project, -p Project name [default: null]
63
- --branch, -b Scan branch [default: null]
64
- --tag, -t Scan tag [default: null]
65
- --binaryLinks Binary links separated by comma [default: null]
66
- --url url [default: null]
67
- --config, -c Config path [default: null]
68
- --proxy Proxy url like 'https://user:password@host:port' [default: null]
69
- --version Prints a version [default: null]
70
- --saveAs, -o Save as file (file name prefix) [default: null]
71
- --saveAsFormat, -f Save as format (scan / cydx / spdx) [default: null]
72
- --debug [default: null]
73
- --simulate [default: null]
74
- --includeDevDependencies [default: null]
75
- --meteor [default: null]
76
- --breakOnWarnings [default: null]
77
- --breakOnViolations [default: null]
78
- --help Prints a usage statement [boolean]
79
-
80
- ```
81
- PLEASE NOTE: if you want to pass param into function
82
- you should add value, for example:
83
-
84
- `--breakOnViolations true` or `--saveAs sbom`
85
-
86
- ## Software bill of materials
87
-
88
- [View SBOM <img alt="TrustSource" src="https://app.trustsource.io/logo.png" width="70"/>](https://app.trustsource.io/api/v1/public-BoM/ae0832c6-5a55-4aa8-8c45-75528d0833fb)
89
-
90
- ## Known problems
91
-
92
- #### Error: The programmatic API was removed in npm v8.0.0
93
- You should upgrade to 2.* versions of ts-node-client
94
-
95
- ## Changelog available inside `CHANGELOG.md`
96
-
97
- ## [DEPRECATED] Changelog
98
-
99
- #### 3.0.*
100
- - `npm.ls` cli -> `package-lock.json` parse
101
- - npm removed
102
- - updated dependencies
103
-
104
- #### 2.1.*
105
- - Migrate 1.6.* - 1.8.* changes to version 2.1
106
- - Bump dependencies
107
-
108
- #### 2.0.*
109
- - Support new scan tool and fix problem with programmatic API for >= npm@8.0.0
110
- - Stop usage of [`global-npm`](https://github.com/dracupid/global-npm) until we find new resolution
111
- - Get back `npm` as local dependency
112
-
113
- #### 1.8.*
114
- - SBOM
115
- - **--saveAs** and **--saveAsFormat**
116
- - Bump minimist from 1.2.5 to 1.2.6
117
- - Bump urijs from 1.19.10 to 1.19.11
118
- - replace packageurl-js with simple local function
119
- - improve docs
120
-
121
- #### 1.7.*
122
- - request -> axios
123
- - fix dependencies
124
- - doc fixes
125
-
126
- #### 1.6.*
127
- - **--breakOnWarnings** and **--breakOnViolations**
128
- - Bump devDependencies
129
-
130
- #### 1.5.*
131
- - Describe `Error: The programmatic API was removed in npm v8.0.0`
132
- - Bump devDependencies
133
- - Introduce sonarjs
134
-
135
- #### 1.4.*
136
- - Bump glob-parent from 5.1.1 to 5.1.2
137
- - Bump path-parse from 1.0.6 to 1.0.7
138
- - Bump lodash from 4.17.19 to 4.17.21
139
- - Bump y18n from 4.0.0 to 4.0.1
140
- - Added:
141
- - option **--includeDevDependencies**. It is allow to scan dev dependencies
142
-
143
- #### 1.3.*
144
- - Use [`global-npm`](https://github.com/dracupid/global-npm) (meaning `npm` is no longer a dependency of `ts-node-client`)
145
-
146
- #### 1.2.*
147
- - Added:
148
- - option **--brakeOnViolations**. It is fail build in case any violations after scan transferred.
149
- - option **--brakeOnWarnings**. It is fail build in case any warning after scan transferred.
150
-
151
- #### 1.1.*
152
- - userName is not required param for scans
153
- - Support usage of scan meta param binaryLinks inside Options definition
154
-
155
- #### 1.0.*
156
- - Node JS and dependencies updates "node": ">= 8.12.0"
157
-
158
- #### 0.3.*
159
- - Improve variable usage and tasks migration
160
- - Support usage of scan meta params: branch and tag inside Options definition
161
- - Skip npmDependency without names
162
- - Update travis config
163
- - Update dependency to resolve vulnerabilities
164
-
165
- #### 0.2.*
166
- - Added proxy support and config
167
- - Update travis config
168
- - Updated README.md with `app.trustsource.io`
169
- - Updated default url to `app.trustsource.io`
170
- - Added windows support
171
- - Fixed json
172
- - **Removed:**
173
- - options: **--credentials** and **--credentialsFile** instead you should use **--config**.
174
- - option **--baseUrl** instead you should use **--url**.
175
- - Added:
176
- - option **--config**. It is similar to credentials, but it will contain any config information.
177
- - option **--url**. It is similar to baseUrl.
178
- - option **--apiKey** and **--userName** so it will be unnecessary to create `.tsrc.json` file.
179
- - options **--version** and **--help**.
180
- - options shortcut.
181
-
182
- ## License
183
- [Apache-2.0](https://github.com/TrustSource/ts-node-client/blob/master/LICENSE)
1
+ # TrustSource ts-node-client
2
+
3
+ [![Version](https://img.shields.io/npm/v/ts-node-client.svg)](http://npm.im/ts-node-client)
4
+ [![Downloads](https://img.shields.io/npm/dm/ts-node-client.svg)](http://npm-stat.com/charts.html?package=ts-node-client)
5
+ [![Downloads](https://img.shields.io/npm/dt/ts-node-client.svg)](http://npm-stat.com/charts.html?package=ts-node-client)
6
+ [![Apache-2.0 License](https://img.shields.io/npm/l/ts-node-client?style=flat-square)](http://opensource.org/licenses/Apache-2.0)
7
+
8
+ [![npm package](https://nodei.co/npm/ts-node-client.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/ts-node-client/)
9
+
10
+ > TrustSource node client - node module to transfer dependency information to TrustSource server.
11
+
12
+ ## Release 3.1.0
13
+ Package now support yarn v.2+
14
+
15
+ ## Release 3.0.0
16
+ Package now is not including `npm` anymore. The addition has been done due to missing programmatic API in npm >= 8.0.0 and in order to skip deprecated dependencies
17
+
18
+ This change affects the structure of scans slightly, but it heavily improves the scanner.
19
+
20
+ ## Requirements
21
+ * node >= 12.0.0 use **ts-node-client@3.1.+***
22
+
23
+ ## Older versions
24
+ * node >= 8.9.0
25
+ * npm < 8.0.0 use **ts-node-client@1.***
26
+ * npm >= 8.0.0 use **ts-node-client@2.***
27
+
28
+ ## Installation
29
+ Run: `npm install --save-dev ts-node-client` or `yarn add --dev ts-node-client`
30
+
31
+ You can add `install_and_scan` script to the package.json file to install and transfer dependency information using one command `npm run install_and_scan`:
32
+
33
+ ```
34
+ "scripts": {
35
+ "install_and_scan": "npm install && ts-node-client -k apiKey -p Project"
36
+ },
37
+ ```
38
+
39
+ To store your credentials for automated transfer you may create `.tsrc.json` in your project directory or in your home directory to set credentials globally (not recommended!)
40
+
41
+ `.tsrc.json` example:
42
+
43
+ ```
44
+ {
45
+ "apiKey": "apiKey",
46
+ "url": "https://app.trustsource.io",
47
+ "project": "Project Description"
48
+ }
49
+
50
+ ```
51
+
52
+ Usage
53
+ =====
54
+
55
+ You also may initiate transfer to TrustSource server manually by executing following command via terminal:
56
+
57
+ ```
58
+ node_modules/.bin/ts-node-client
59
+ node_modules/.bin/ts-node-client -k apiKey -p Project --breakOnWarnings false --breakOnViolations true
60
+ node_modules/.bin/ts-node-client -c config.json
61
+ ```
62
+ ```
63
+ npm / node module to transfer dependency information to TrustSource server.
64
+
65
+ Options:
66
+ --apiKey, -k apiKey [default: null]
67
+ --project, -p Project name [default: null]
68
+ --branch, -b Scan branch [default: null]
69
+ --tag, -t Scan tag [default: null]
70
+ --binaryLinks Binary links separated by comma [default: null]
71
+ --url url [default: null]
72
+ --config, -c Config path [default: null]
73
+ --proxy Proxy url like 'https://user:password@host:port' [default: null]
74
+ --version Prints a version [default: null]
75
+ --saveAs, -o Save as file (file name prefix) [default: null]
76
+ --saveAsFormat, -f Save as format (scan / cydx / spdx) [default: null]
77
+ --debug [default: null]
78
+ --simulate [default: null]
79
+ --includeDevDependencies [default: null]
80
+ --meteor [default: null]
81
+ --breakOnWarnings [default: null]
82
+ --breakOnViolations [default: null]
83
+ --help Prints a usage statement [boolean]
84
+
85
+ ```
86
+ PLEASE NOTE: if you want to pass param into function
87
+ you should add value, for example:
88
+
89
+ `--breakOnViolations true` or `--saveAs sbom`
90
+
91
+ ## Software bill of materials
92
+
93
+ [View SBOM <img alt="TrustSource" src="https://app.trustsource.io/logo.png" width="70"/>](https://app.trustsource.io/api/v1/public-BoM/ae0832c6-5a55-4aa8-8c45-75528d0833fb)
94
+
95
+ ## Known problems
96
+
97
+ #### Error: The programmatic API was removed in npm v8.0.0
98
+ You should upgrade to 2.* versions of ts-node-client
99
+
100
+ ## Changelog available inside `CHANGELOG.md`
101
+
102
+ ## [DEPRECATED] Changelog
103
+
104
+ #### 3.0.*
105
+ - `npm.ls` cli -> `package-lock.json` parse
106
+ - npm removed
107
+ - updated dependencies
108
+
109
+ #### 2.1.*
110
+ - Migrate 1.6.* - 1.8.* changes to version 2.1
111
+ - Bump dependencies
112
+
113
+ #### 2.0.*
114
+ - Support new scan tool and fix problem with programmatic API for >= npm@8.0.0
115
+ - Stop usage of [`global-npm`](https://github.com/dracupid/global-npm) until we find new resolution
116
+ - Get back `npm` as local dependency
117
+
118
+ #### 1.8.*
119
+ - SBOM
120
+ - **--saveAs** and **--saveAsFormat**
121
+ - Bump minimist from 1.2.5 to 1.2.6
122
+ - Bump urijs from 1.19.10 to 1.19.11
123
+ - replace packageurl-js with simple local function
124
+ - improve docs
125
+
126
+ #### 1.7.*
127
+ - request -> axios
128
+ - fix dependencies
129
+ - doc fixes
130
+
131
+ #### 1.6.*
132
+ - **--breakOnWarnings** and **--breakOnViolations**
133
+ - Bump devDependencies
134
+
135
+ #### 1.5.*
136
+ - Describe `Error: The programmatic API was removed in npm v8.0.0`
137
+ - Bump devDependencies
138
+ - Introduce sonarjs
139
+
140
+ #### 1.4.*
141
+ - Bump glob-parent from 5.1.1 to 5.1.2
142
+ - Bump path-parse from 1.0.6 to 1.0.7
143
+ - Bump lodash from 4.17.19 to 4.17.21
144
+ - Bump y18n from 4.0.0 to 4.0.1
145
+ - Added:
146
+ - option **--includeDevDependencies**. It is allow to scan dev dependencies
147
+
148
+ #### 1.3.*
149
+ - Use [`global-npm`](https://github.com/dracupid/global-npm) (meaning `npm` is no longer a dependency of `ts-node-client`)
150
+
151
+ #### 1.2.*
152
+ - Added:
153
+ - option **--brakeOnViolations**. It is fail build in case any violations after scan transferred.
154
+ - option **--brakeOnWarnings**. It is fail build in case any warning after scan transferred.
155
+
156
+ #### 1.1.*
157
+ - userName is not required param for scans
158
+ - Support usage of scan meta param binaryLinks inside Options definition
159
+
160
+ #### 1.0.*
161
+ - Node JS and dependencies updates "node": ">= 8.12.0"
162
+
163
+ #### 0.3.*
164
+ - Improve variable usage and tasks migration
165
+ - Support usage of scan meta params: branch and tag inside Options definition
166
+ - Skip npmDependency without names
167
+ - Update travis config
168
+ - Update dependency to resolve vulnerabilities
169
+
170
+ #### 0.2.*
171
+ - Added proxy support and config
172
+ - Update travis config
173
+ - Updated README.md with `app.trustsource.io`
174
+ - Updated default url to `app.trustsource.io`
175
+ - Added windows support
176
+ - Fixed json
177
+ - **Removed:**
178
+ - options: **--credentials** and **--credentialsFile** instead you should use **--config**.
179
+ - option **--baseUrl** instead you should use **--url**.
180
+ - Added:
181
+ - option **--config**. It is similar to credentials, but it will contain any config information.
182
+ - option **--url**. It is similar to baseUrl.
183
+ - option **--apiKey** and **--userName** so it will be unnecessary to create `.tsrc.json` file.
184
+ - options **--version** and **--help**.
185
+ - options shortcut.
186
+
187
+ ## License
188
+ [Apache-2.0](https://github.com/TrustSource/ts-node-client/blob/master/LICENSE)