chore: set minimal required NPM version to 7 (#1267)

This commit is contained in:
Andrew Tatomyr
2023-09-21 16:46:15 +03:00
committed by GitHub
parent f4da2c9df8
commit cfe66a79a9
11 changed files with 22 additions and 10 deletions

View File

@@ -30,7 +30,7 @@ Before submitting a pull request, please make sure the following is done:
## Development Setup ## Development Setup
[Node.js](http://nodejs.org) at `v12.0.0+` is required. [Node.js](http://nodejs.org) at v14.19.0+ and NPM v7.0.0+ are required.
After forking the repo, run: After forking the repo, run:

View File

@@ -28,6 +28,8 @@ Then you can use it as `redocly [command] [options]`, for example:
redocly lint path-to-root-file.yaml redocly lint path-to-root-file.yaml
``` ```
Minimal required versions of Node.js and NPM are 14.19.0 and 7.0.0 respectively.
### Docker ### Docker
To give the Docker container access to the OpenAPI description files, you need to To give the Docker container access to the OpenAPI description files, you need to

View File

@@ -32,7 +32,7 @@ toc:
- Fixed an issue where the `--remove-unused-components` option removed used components that were referenced as child objects. - Fixed an issue where the `--remove-unused-components` option removed used components that were referenced as child objects.
- Updated Redocly config validation. - Updated Redocly config validation.
- Fixed the location pointer when reporting on the `no-path-trailing-slash` rule. - Fixed the location pointer when reporting on the `no-path-trailing-slash` rule.
- Updated minimum required version of Node.js to v14 and removed deprecated packages. - Updated minimum required version of Node.js to v14.19.0, NPM to v7.0.0, and removed deprecated packages.
- Updated @redocly/openapi-core to v1.1.0. - Updated @redocly/openapi-core to v1.1.0.
## 1.0.2 (2023-08-07) ## 1.0.2 (2023-08-07)

View File

@@ -13,7 +13,7 @@ When a command is run, the following data is collected:
* command exit code * command exit code
* values from `REDOCLY_ENVIRONMENT` * values from `REDOCLY_ENVIRONMENT`
* CLI version * CLI version
* NodeJS version * Node.js and NPM versions
Values such as file names, organization IDs, and URLs are removed, replaced by just "URL" or "file", etc. Values such as file names, organization IDs, and URLs are removed, replaced by just "URL" or "file", etc.

9
package-lock.json generated
View File

@@ -33,7 +33,8 @@
"webpack-cli": "^4.10.0" "webpack-cli": "^4.10.0"
}, },
"engines": { "engines": {
"node": ">=15.0.0" "node": ">=15.0.0",
"npm": ">=7.0.0"
} }
}, },
"node_modules/@ampproject/remapping": { "node_modules/@ampproject/remapping": {
@@ -14321,7 +14322,8 @@
"typescript": "^4.0.3" "typescript": "^4.0.3"
}, },
"engines": { "engines": {
"node": ">=14.0.0" "node": ">=14.19.0",
"npm": ">=7.0.0"
} }
}, },
"packages/cli/node_modules/@types/yargs": { "packages/cli/node_modules/@types/yargs": {
@@ -14359,7 +14361,8 @@
"typescript": "^4.0.5" "typescript": "^4.0.5"
}, },
"engines": { "engines": {
"node": ">=14.0.0" "node": ">=14.19.0",
"npm": ">=7.0.0"
} }
}, },
"packages/core/node_modules/@types/node": { "packages/core/node_modules/@types/node": {

View File

@@ -4,7 +4,8 @@
"description": "", "description": "",
"private": true, "private": true,
"engines": { "engines": {
"node": ">=15.0.0" "node": ">=15.0.0",
"npm": ">=7.0.0"
}, },
"engineStrict": true, "engineStrict": true,
"scripts": { "scripts": {

View File

@@ -24,7 +24,7 @@
- Fixed an issue where the `--remove-unused-components` option removed used components that were referenced as child objects. - Fixed an issue where the `--remove-unused-components` option removed used components that were referenced as child objects.
- Updated Redocly config validation. - Updated Redocly config validation.
- Fixed the location pointer when reporting on the `no-path-trailing-slash` rule. - Fixed the location pointer when reporting on the `no-path-trailing-slash` rule.
- Updated minimum required version of Node.js to v14 and removed deprecated packages. - Updated minimum required version of Node.js to v14.19.0, NPM to v7.0.0, and removed deprecated packages.
- Updated @redocly/openapi-core to v1.1.0. - Updated @redocly/openapi-core to v1.1.0.
## 1.0.2 ## 1.0.2

View File

@@ -8,7 +8,8 @@
"redocly": "bin/cli.js" "redocly": "bin/cli.js"
}, },
"engines": { "engines": {
"node": ">=14.0.0" "node": ">=14.19.0",
"npm": ">=7.0.0"
}, },
"engineStrict": true, "engineStrict": true,
"scripts": { "scripts": {

View File

@@ -6,6 +6,7 @@ import * as glob from 'glob';
import * as fs from 'fs'; import * as fs from 'fs';
import * as readline from 'readline'; import * as readline from 'readline';
import { Writable } from 'stream'; import { Writable } from 'stream';
import { execSync } from 'child_process';
import { import {
BundleOutputFormat, BundleOutputFormat,
StyleguideConfig, StyleguideConfig,
@@ -503,6 +504,7 @@ export async function sendTelemetry(
command, command,
arguments: cleanArgs(args), arguments: cleanArgs(args),
node_version: process.version, node_version: process.version,
npm_version: execSync('npm -v').toString().replace('\n', ''),
version, version,
exit_code, exit_code,
environment: process.env.REDOCLY_ENVIRONMENT, environment: process.env.REDOCLY_ENVIRONMENT,
@@ -531,6 +533,7 @@ export type Analytics = {
command: string | number; command: string | number;
arguments: Record<string, unknown>; arguments: Record<string, unknown>;
node_version: string; node_version: string;
npm_version: string;
version: string; version: string;
exit_code: ExitCode; exit_code: ExitCode;
environment?: string; environment?: string;

View File

@@ -4,7 +4,8 @@
"description": "", "description": "",
"main": "lib/index.js", "main": "lib/index.js",
"engines": { "engines": {
"node": ">=14.0.0" "node": ">=14.19.0",
"npm": ">=7.0.0"
}, },
"engineStrict": true, "engineStrict": true,
"license": "MIT", "license": "MIT",

View File

@@ -2,6 +2,7 @@ export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy
export { Oas3_1Types } from './types/oas3_1'; export { Oas3_1Types } from './types/oas3_1';
export { Oas3Types } from './types/oas3'; export { Oas3Types } from './types/oas3';
export { Oas2Types } from './types/oas2'; export { Oas2Types } from './types/oas2';
export { AsyncApi2Types } from './types/asyncapi';
export { ConfigTypes } from './types/redocly-yaml'; export { ConfigTypes } from './types/redocly-yaml';
export type { export type {
Oas3Definition, Oas3Definition,