@redocly/cli 0.0.0-snapshot.1737554067

package/lib/utils/update-version-notifier.js

@@ -0,0 +1,102 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheLatestVersion = exports.notifyUpdateCliVersion = exports.name = exports.version = void 0;
+const os_1 = require("os");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const semver_1 = require("semver");
+const fetch_with_timeout_1 = require("./fetch-with-timeout");
+const colorette_1 = require("colorette");
+const miscellaneous_1 = require("./miscellaneous");
+_a = require('../../package.json'), exports.version = _a.version, exports.name = _a.name;
+const VERSION_CACHE_FILE = 'redocly-cli-version';
+const SPACE_TO_BORDER = 4;
+const INTERVAL_TO_CHECK = 1000 * 60 * 60 * 12;
+const SHOULD_NOT_NOTIFY = process.env.NODE_ENV === 'test' ||
+    process.env.CI ||
+    !!process.env.LAMBDA_TASK_ROOT ||
+    process.env.REDOCLY_SUPPRESS_UPDATE_NOTICE === 'true';
+const notifyUpdateCliVersion = () => {
+    if (SHOULD_NOT_NOTIFY) {
+        return;
+    }
+    try {
+        const latestVersion = (0, fs_1.readFileSync)((0, path_1.join)((0, os_1.tmpdir)(), VERSION_CACHE_FILE)).toString();
+        if (isNewVersionAvailable(exports.version, latestVersion)) {
+            renderUpdateBanner(exports.version, latestVersion);
+        }
+    }
+    catch (e) {
+        return;
+    }
+};
+exports.notifyUpdateCliVersion = notifyUpdateCliVersion;
+const isNewVersionAvailable = (current, latest) => (0, semver_1.compare)(current, latest) < 0;
+const getLatestVersion = async (packageName) => {
+    const latestUrl = `http://registry.npmjs.org/${packageName}/latest`;
+    try {
+        const response = await (0, fetch_with_timeout_1.default)(latestUrl, { timeout: fetch_with_timeout_1.DEFAULT_FETCH_TIMEOUT });
+        const info = await response.json();
+        return info.version;
+    }
+    catch {
+        // Do nothing
+        return;
+    }
+};
+const cacheLatestVersion = () => {
+    if (!isNeedToBeCached() || SHOULD_NOT_NOTIFY) {
+        return;
+    }
+    getLatestVersion(exports.name)
+        .then((version) => {
+        if (version) {
+            const lastCheckFile = (0, path_1.join)((0, os_1.tmpdir)(), VERSION_CACHE_FILE);
+            (0, fs_1.writeFileSync)(lastCheckFile, version);
+        }
+    })
+        .catch(() => { });
+};
+exports.cacheLatestVersion = cacheLatestVersion;
+const renderUpdateBanner = (current, latest) => {
+    const messageLines = [
+        `A new version of ${(0, colorette_1.cyan)('Redocly CLI')} (${(0, colorette_1.green)(latest)}) is available.`,
+        `Update now: \`${(0, colorette_1.cyan)('npm i -g @redocly/cli@latest')}\`.`,
+        `Changelog: https://redocly.com/docs/cli/changelog/`,
+    ];
+    const maxLength = Math.max(...messageLines.map((line) => (0, miscellaneous_1.cleanColors)(line).length));
+    const border = (0, colorette_1.yellow)('═'.repeat(maxLength + SPACE_TO_BORDER));
+    const extraSpaces = ' '.repeat(SPACE_TO_BORDER);
+    const banner = [
+        '',
+        extraSpaces + (0, colorette_1.yellow)('╔' + border + '╗'),
+        extraSpaces + (0, colorette_1.yellow)('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║'),
+        messageLines.map(getLineWithPadding(maxLength, extraSpaces)).join('\n'),
+        extraSpaces + (0, colorette_1.yellow)('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║'),
+        extraSpaces + (0, colorette_1.yellow)('╚' + border + '╝'),
+        '',
+        '',
+    ].join('\n');
+    process.stderr.write(banner);
+};
+const getLineWithPadding = (maxLength, extraSpaces) => (line) => {
+    const padding = ' '.repeat(maxLength - (0, miscellaneous_1.cleanColors)(line).length);
+    return `${extraSpaces}${(0, colorette_1.yellow)('║')}  ${line}${padding}  ${(0, colorette_1.yellow)('║')}`;
+};
+const isNeedToBeCached = () => {
+    try {
+        // Last version from npm is stored in a file in the OS temp folder
+        const versionFile = (0, path_1.join)((0, os_1.tmpdir)(), VERSION_CACHE_FILE);
+        if (!(0, fs_1.existsSync)(versionFile)) {
+            return true;
+        }
+        const now = new Date().getTime();
+        const stats = (0, fs_1.statSync)(versionFile);
+        const lastCheck = stats.mtime.getTime();
+        return now - lastCheck >= INTERVAL_TO_CHECK;
+    }
+    catch (e) {
+        return false;
+    }
+};

package/lib/wrapper.d.ts

@@ -0,0 +1,11 @@
+import type { Arguments } from 'yargs';
+import type { Config } from '@redocly/openapi-core';
+import type { CollectFn } from '@redocly/openapi-core/lib/utils';
+import type { CommandOptions } from './types';
+export type CommandArgs<T extends CommandOptions> = {
+    argv: T;
+    config: Config;
+    version: string;
+    collectSpecData?: CollectFn;
+};
+export declare function commandWrapper<T extends CommandOptions>(commandHandler?: (wrapperArgs: CommandArgs<T>) => Promise<unknown>): (argv: Arguments<T>) => Promise<void>;

package/lib/wrapper.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commandWrapper = commandWrapper;
+const openapi_core_1 = require("@redocly/openapi-core");
+const utils_1 = require("@redocly/openapi-core/lib/utils");
+const update_version_notifier_1 = require("./utils/update-version-notifier");
+const miscellaneous_1 = require("./utils/miscellaneous");
+const lint_1 = require("./commands/lint");
+function commandWrapper(commandHandler) {
+    return async (argv) => {
+        let code = 2;
+        let hasConfig;
+        let telemetry;
+        let specVersion;
+        let specKeyword;
+        let specFullVersion;
+        const collectSpecData = (document) => {
+            specVersion = (0, openapi_core_1.detectSpec)(document);
+            if (!(0, utils_1.isPlainObject)(document))
+                return;
+            specKeyword = document?.openapi
+                ? 'openapi'
+                : document?.swagger
+                    ? 'swagger'
+                    : document?.asyncapi
+                        ? 'asyncapi'
+                        : document?.arazzo
+                            ? 'arazzo'
+                            : undefined;
+            if (specKeyword) {
+                specFullVersion = document[specKeyword];
+            }
+        };
+        try {
+            if (argv.config && !(0, openapi_core_1.doesYamlFileExist)(argv.config)) {
+                (0, miscellaneous_1.exitWithError)('Please provide a valid path to the configuration file.');
+            }
+            const config = (await (0, miscellaneous_1.loadConfigAndHandleErrors)({
+                configPath: argv.config,
+                customExtends: argv.extends,
+                region: argv.region,
+                files: argv.files,
+                processRawConfig: (0, lint_1.lintConfigCallback)(argv, update_version_notifier_1.version),
+            }));
+            telemetry = config.telemetry;
+            hasConfig = !config.styleguide.recommendedFallback;
+            code = 1;
+            if (typeof commandHandler === 'function') {
+                await commandHandler({ argv, config, version: update_version_notifier_1.version, collectSpecData });
+            }
+            code = 0;
+        }
+        catch (err) {
+            // Do nothing
+        }
+        finally {
+            if (process.env.REDOCLY_TELEMETRY !== 'off' && telemetry !== 'off') {
+                await (0, miscellaneous_1.sendTelemetry)(argv, code, hasConfig, specVersion, specKeyword, specFullVersion);
+            }
+            process.once('beforeExit', () => {
+                process.exit(code);
+            });
+        }
+    };
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@redocly/cli",
+  "version": "0.0.0-snapshot.1737554067",
+  "description": "",
+  "license": "MIT",
+  "bin": {
+    "openapi": "bin/cli.js",
+    "redocly": "bin/cli.js"
+  },
+  "engines": {
+    "node": ">=14.19.0",
+    "npm": ">=7.0.0"
+  },
+  "engineStrict": true,
+  "scripts": {
+    "compile": "tsc",
+    "copy-assets": "cp src/commands/preview-docs/preview-server/default.hbs lib/commands/preview-docs/preview-server/default.hbs && cp src/commands/preview-docs/preview-server/hot.js lib/commands/preview-docs/preview-server/hot.js && cp src/commands/preview-docs/preview-server/oauth2-redirect.html lib/commands/preview-docs/preview-server/oauth2-redirect.html && cp src/commands/build-docs/template.hbs lib/commands/build-docs/template.hbs ",
+    "prepack": "npm run copy-assets",
+    "prepublishOnly": "npm run copy-assets && cp ../../README.md ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Redocly/redocly-cli.git"
+  },
+  "homepage": "https://github.com/Redocly/redocly-cli",
+  "keywords": [
+    "linter",
+    "OpenAPI",
+    "Swagger",
+    "OpenAPI linter",
+    "Swagger linter",
+    "AsyncAPI linter",
+    "oas"
+  ],
+  "contributors": [
+    "Roman Hotsiy <roman@redocly.com> (https://redocly.com/)"
+  ],
+  "dependencies": {
+    "@redocly/openapi-core": "0.0.0-snapshot.1737554067",
+    "abort-controller": "^3.0.0",
+    "chokidar": "^3.5.1",
+    "colorette": "^1.2.0",
+    "core-js": "^3.32.1",
+    "form-data": "^4.0.0",
+    "get-port-please": "^3.0.1",
+    "glob": "^7.1.6",
+    "handlebars": "^4.7.6",
+    "mobx": "^6.0.4",
+    "node-fetch": "^2.6.1",
+    "pluralize": "^8.0.0",
+    "react": "^17.0.0 || ^18.2.0",
+    "react-dom": "^17.0.0 || ^18.2.0",
+    "redoc": "~2.2.0",
+    "semver": "^7.5.2",
+    "simple-websocket": "^9.0.0",
+    "styled-components": "^6.0.7",
+    "yargs": "17.0.1"
+  },
+  "devDependencies": {
+    "@types/configstore": "^5.0.1",
+    "@types/glob": "^8.1.0",
+    "@types/pluralize": "^0.0.29",
+    "@types/react": "^17.0.0 || ^18.2.21",
+    "@types/react-dom": "^17.0.0 || ^18.2.7",
+    "@types/semver": "^7.5.0",
+    "@types/yargs": "17.0.32",
+    "typescript": "5.5.3"
+  }
+}