Skip to content

Commit bd8ec59

Browse files
committed
Format clean up
1 parent ae1a578 commit bd8ec59

File tree

58 files changed

+2649
-2260
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+2649
-2260
lines changed

docs/.vuepress/config-client/sidebar.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,10 @@ export default {
300300
path: '/els-for-runtimes-and-libraries/lodash/',
301301
icon: '/images/lodash-logo.webp',
302302
},
303+
{
304+
path: '/els-for-runtimes-and-libraries/marked/',
305+
icon: '/images/marked-logo.webp',
306+
},
303307
{
304308
path: '/els-for-runtimes-and-libraries/micromatch/',
305309
icon: '/images/placeholder-logo.webp',
@@ -308,10 +312,6 @@ export default {
308312
path: '/els-for-runtimes-and-libraries/minimatch/',
309313
icon: '/images/javascript.webp',
310314
},
311-
{
312-
path: '/els-for-runtimes-and-libraries/marked/',
313-
icon: '/images/marked-logo.webp',
314-
},
315315
{
316316
path: '/els-for-runtimes-and-libraries/mongodb-driver/',
317317
icon: '/images/mongodb-logo.webp',
@@ -320,10 +320,6 @@ export default {
320320
path: '/els-for-runtimes-and-libraries/mongoose/',
321321
icon: '/images/mongoose-logo.webp',
322322
},
323-
{
324-
path: '/els-for-runtimes-and-libraries/nth-check/',
325-
icon: '/images/nth-check-logo.webp',
326-
},
327323
{
328324
path: '/els-for-runtimes-and-libraries/multer/',
329325
icon: '/images/multer-logo.webp',
@@ -344,6 +340,10 @@ export default {
344340
path: '/els-for-runtimes-and-libraries/nodejs/',
345341
icon: '/images/nodejs.webp',
346342
},
343+
{
344+
path: '/els-for-runtimes-and-libraries/nth-check/',
345+
icon: '/images/nth-check-logo.webp',
346+
},
347347
{
348348
path: '/els-for-runtimes-and-libraries/pdfjs-dist/',
349349
icon: '/images/pdfjs-dist-logo.webp',

docs/els-for-runtimes-and-libraries/angular/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -817,7 +817,7 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
817817

818818
* **Option 1: TuxCare Patcher (Automated). Recommended for projects with multiple TuxCare dependencies.**
819819

820-
The TuxCare Patcher automatically detects all TuxCare packages in your `package.json` and updates them to the latest available versions.
820+
The TuxCare Patcher automatically detects all TuxCare dependencies in your `package.json` and updates them to the latest available versions.
821821

822822
<CodeWithCopy>
823823

@@ -829,7 +829,7 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
829829

830830
* **Option 2: Manual Update via CLI (Single Dependency)**
831831

832-
For projects with a single TuxCare dependency, you can use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
832+
If you want to update one TuxCare dependency, you can use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
833833

834834
<CodeWithCopy>
835835

@@ -841,7 +841,7 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
841841

842842
* **Option 3: Manual Update via package.json (Multiple Dependencies)**
843843

844-
For projects with multiple TuxCare dependencies, manually update the version string(s) in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
844+
If you want to update several TuxCare dependencies, manually update the version strings in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
845845

846846
<CodeWithCopy>
847847

docs/els-for-runtimes-and-libraries/angularjs/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,6 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
5353

5454
Install the Patcher globally and run the following commands. The TuxCare Patcher automatically detects the AngularJS version in your `package.json` and updates your `dependencies` and `overrides` to use the corresponding TuxCare `@els-js/*` packages.
5555

56-
If you already have dependencies listed in your `package.json`, for example:
57-
58-
```text
59-
"dependencies": {
60-
"angular": "^1.8.3"
61-
}
62-
```
63-
6456
<CodeWithCopy>
6557

6658
```text
@@ -70,7 +62,15 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
7062
7163
</CodeWithCopy>
7264
73-
The patcher will automatically update your `package.json` to:
65+
The patcher will update your `package.json`, for example, from:
66+
67+
```text
68+
"dependencies": {
69+
"angular": "^1.8.3"
70+
}
71+
```
72+
73+
to:
7474
7575
```text
7676
"dependencies": {
@@ -199,13 +199,9 @@ TuxCare provides VEX for AngularJS ELS versions: [security.tuxcare.com/vex/cyclo
199199

200200
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.4`), you can use one of the following methods:
201201

202-
* **Option 1: TuxCare Patcher (Automated)**
203-
204-
:::tip
205-
This method is recommended for projects with multiple TuxCare dependencies.
206-
:::
202+
* **Option 1: TuxCare Patcher (Automated). Recommended for projects with multiple TuxCare dependencies.**
207203

208-
The TuxCare Patcher automatically detects all TuxCare packages in your `package.json` and updates them to the latest available versions.
204+
The TuxCare Patcher automatically detects all TuxCare dependencies in your `package.json` and updates them to the latest available versions.
209205

210206
<CodeWithCopy>
211207

@@ -217,7 +213,7 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
217213

218214
* **Option 2: Manual Update via CLI (Single Dependency)**
219215

220-
For projects with a single TuxCare dependency, you can use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
216+
If you want to update a single TuxCare dependency, use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
221217

222218
<CodeWithCopy>
223219

@@ -229,7 +225,7 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
229225

230226
* **Option 3: Manual Update via package.json (Multiple Dependencies)**
231227

232-
For projects with multiple TuxCare dependencies, manually update the version string(s) in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
228+
If you want to update several TuxCare dependencies, manually update the version strings in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
233229

234230
<CodeWithCopy>
235231

docs/els-for-runtimes-and-libraries/ansi-html/README.md

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -49,51 +49,51 @@ TuxCare provides ELS for ansi-html as an NPM package, hosted on a secure interna
4949

5050
4. Update your `package.json` file to replace your ansi-html dependencies with the TuxCare packages. You can do this in two ways:
5151

52-
* **Option 1: TuxCare Patcher (Automated)**
52+
* **Option 1: TuxCare Patcher (Automated)**
5353

54-
If you already have dependencies listed in your `package.json`, for example:
54+
Install the Patcher globally and run it. The TuxCare Patcher automatically detects the ansi-html version in your `package.json` and updates your `dependencies` and `overrides` to use the corresponding TuxCare `@els-js/*` packages.
5555

56-
```text
57-
"dependencies": {
58-
"ansi-html": "^0.0.7"
59-
}
60-
```
56+
<CodeWithCopy>
6157

62-
Install the Patcher globally, then run the patcher command:
58+
```text
59+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
60+
tuxcare-patch-js
61+
```
6362
64-
<CodeWithCopy>
63+
</CodeWithCopy>
6564
66-
```text
67-
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
68-
tuxcare-patch-js
69-
```
65+
The patcher will update your `package.json`, for example, from:
7066
71-
</CodeWithCopy>
67+
```text
68+
"dependencies": {
69+
"ansi-html": "^0.0.7"
70+
}
71+
```
7272
73-
The patcher will automatically update your `package.json` to:
73+
to:
7474
75-
```text
76-
"dependencies": {
77-
"ansi-html": "npm:@els-js/[email protected]"
78-
},
79-
"overrides": {
80-
81-
}
82-
```
75+
```text
76+
"dependencies": {
77+
"ansi-html": "npm:@els-js/[email protected]"
78+
},
79+
"overrides": {
80+
81+
}
82+
```
8383
84-
* **Option 2: Manual Update**
84+
* **Option 2: Manual Update**
8585
86-
Manually update your `package.json` file to use the TuxCare package:
86+
Manually update your `package.json` file by replacing your ansi-html dependencies with the TuxCare packages. This method gives you full control over which packages to update.
8787
88-
<CodeWithCopy>
88+
<CodeWithCopy>
8989
90-
```text
91-
"dependencies": {
92-
"ansi-html": "npm:@els-js/[email protected]"
93-
}
94-
```
90+
```text
91+
"dependencies": {
92+
"ansi-html": "npm:@els-js/[email protected]"
93+
}
94+
```
9595
96-
</CodeWithCopy>
96+
</CodeWithCopy>
9797
9898
5. You need to remove the `node_modules` directory and the `package-lock.json` file, and also clear the `npm cache` before installing the patched packages. Use the following commands:
9999
@@ -133,9 +133,11 @@ TuxCare provides VEX for ansi-html ELS versions: [security.tuxcare.com/vex/cyclo
133133

134134
## How to Upgrade to a Newer Version of TuxCare Packages
135135

136-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.2`), there are several options:
136+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), you can use one of the following methods:
137137

138-
* **Option 1**. Run TuxCare Patcher to update all TuxCare packages in your `package.json`:
138+
* **Option 1: TuxCare Patcher (Automated). Recommended for projects with multiple TuxCare dependencies.**
139+
140+
The TuxCare Patcher automatically detects all TuxCare dependencies in your `package.json` and updates them to the latest available versions.
139141

140142
<CodeWithCopy>
141143

@@ -145,7 +147,9 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
145147

146148
</CodeWithCopy>
147149

148-
* **Option 2**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
150+
* **Option 2: Manual Update via CLI (Single Dependency)**
151+
152+
If you want to update a single TuxCare dependency, use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
149153

150154
<CodeWithCopy>
151155

@@ -155,7 +159,9 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
155159

156160
</CodeWithCopy>
157161

158-
* **Option 3**. Manually update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
162+
* **Option 3: Manual Update via package.json (Multiple Dependencies)**
163+
164+
If you want to update several TuxCare dependencies, manually update the version strings in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
159165

160166
<CodeWithCopy>
161167

docs/els-for-runtimes-and-libraries/base64url/README.md

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -49,51 +49,51 @@ TuxCare provides ELS for base64url as an NPM package, hosted on a secure interna
4949

5050
4. Update your `package.json` file to replace your base64url dependencies with the TuxCare packages. You can do this in two ways:
5151

52-
* **Option 1: TuxCare Patcher (Automated)**
52+
* **Option 1: TuxCare Patcher (Automated)**
5353

54-
If you already have dependencies listed in your `package.json`, for example:
54+
Install the Patcher globally and run it. The TuxCare Patcher automatically detects the base64url version in your `package.json` and updates your `dependencies` and `overrides` to use the corresponding TuxCare `@els-js/*` packages.
5555

56-
```text
57-
"dependencies": {
58-
"base64url": "^0.0.6"
59-
}
60-
```
56+
<CodeWithCopy>
6157

62-
Install the Patcher globally, then run the patcher command:
58+
```text
59+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
60+
tuxcare-patch-js
61+
```
6362
64-
<CodeWithCopy>
63+
</CodeWithCopy>
6564
66-
```text
67-
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
68-
tuxcare-patch-js
69-
```
65+
The patcher will update your `package.json`, for example, from:
7066
71-
</CodeWithCopy>
67+
```text
68+
"dependencies": {
69+
"base64url": "^0.0.6"
70+
}
71+
```
7272
73-
The patcher will automatically update your `package.json` to:
73+
to:
7474
75-
```text
76-
"dependencies": {
77-
"base64url": "npm:@els-js/[email protected]"
78-
},
79-
"overrides": {
80-
81-
}
82-
```
75+
```text
76+
"dependencies": {
77+
"base64url": "npm:@els-js/[email protected]"
78+
},
79+
"overrides": {
80+
81+
}
82+
```
8383
84-
* **Option 2: Manual Update**
84+
* **Option 2: Manual Update**
8585
86-
Manually update your `package.json` file to use the TuxCare package:
86+
Manually update your `package.json` file by replacing your base64url dependencies with the TuxCare packages. This method gives you full control over which packages to update.
8787
88-
<CodeWithCopy>
88+
<CodeWithCopy>
8989
90-
```text
91-
"dependencies": {
92-
"base64url": "npm:@els-js/[email protected]"
93-
}
94-
```
90+
```text
91+
"dependencies": {
92+
"base64url": "npm:@els-js/[email protected]"
93+
}
94+
```
9595
96-
</CodeWithCopy>
96+
</CodeWithCopy>
9797
9898
5. You need to remove the `node_modules` directory and the `package-lock.json` file, and also clear the `npm cache` before installing the patched packages. Use the following commands:
9999
@@ -133,9 +133,11 @@ TuxCare provides VEX for base64url ELS versions: [security.tuxcare.com/vex/cyclo
133133

134134
## How to Upgrade to a Newer Version of TuxCare Packages
135135

136-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.2`), there are several options:
136+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), you can use one of the following methods:
137137

138-
* **Option 1**. Run TuxCare Patcher to update all TuxCare packages in your `package.json`:
138+
* **Option 1: TuxCare Patcher (Automated). Recommended for projects with multiple TuxCare dependencies.**
139+
140+
The TuxCare Patcher automatically detects all TuxCare dependencies in your `package.json` and updates them to the latest available versions.
139141

140142
<CodeWithCopy>
141143

@@ -145,7 +147,9 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
145147

146148
</CodeWithCopy>
147149

148-
* **Option 2**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
150+
* **Option 2: Manual Update via CLI (Single Dependency)**
151+
152+
If you want to update a single TuxCare dependency, use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
149153

150154
<CodeWithCopy>
151155

@@ -155,11 +159,14 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
155159

156160
</CodeWithCopy>
157161

158-
* **Option 3**. Manually update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
162+
* **Option 3: Manual Update via package.json (Multiple Dependencies)**
163+
164+
If you want to update several TuxCare dependencies, manually update the version strings in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
159165

160166
<CodeWithCopy>
161167

162168
```text
169+
rm -rf node_modules package-lock.json && npm cache clean --force
163170
npm install
164171
```
165172

0 commit comments

Comments
 (0)