@cloud-ru/ft-deps-validator 1.1.1

package/dist/cjs/utils/initializeState.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeState = initializeState;
+const path_1 = __importDefault(require("path"));
+const getMonorepoPrefix_1 = require("./getMonorepoPrefix");
+function initializeState({ cwd, folders, prefix }) {
+    const internalPackages = {};
+    const initialState = {
+        wrongVersions: [],
+        internalAsDev: [],
+        unusedDeps: [],
+        missing: [],
+    };
+    const monorepoName = prefix || (0, getMonorepoPrefix_1.getMonorepoPrefix)({ cwd, folders });
+    if (!monorepoName) {
+        throw new Error('[ERROR] Prefix was not specified and was not found');
+    }
+    const monorepoPackageRegexp = new RegExp(`${monorepoName}\\/`);
+    for (const folder of folders) {
+        // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+        const pkg = require(path_1.default.resolve(folder, 'package.json'));
+        internalPackages[pkg.name] = pkg.version;
+    }
+    for (const folder of folders) {
+        // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+        const pkg = require(path_1.default.resolve(folder, 'package.json'));
+        const usedInternal = Object.keys(pkg.dependencies || {}).filter(x => monorepoPackageRegexp.test(x));
+        usedInternal.forEach(dep => {
+            if (pkg.dependencies[dep] !== internalPackages[dep]) {
+                initialState.wrongVersions.push(`Error in ${pkg.name}: ${dep} has ${pkg.dependencies[dep]}, but correct version is ${internalPackages[dep]}`);
+            }
+        });
+        const usedInternalDev = Object.keys(pkg.devDependencies || {}).filter(x => monorepoPackageRegexp.test(x));
+        usedInternalDev.forEach(dep => initialState.internalAsDev.push(`Error in ${pkg.name}: ${dep}`));
+    }
+    return initialState;
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/esm/index.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import depCheck from 'depcheck';
+import { globSync } from 'glob';
+import { logDebug, logError, logInfo } from './utils/console';
+import { getCliArguments } from './utils/getCliArguments';
+import { getConfigFile } from './utils/getConfigFile';
+import { initializeState } from './utils/initializeState';
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const args = getCliArguments();
+        const configFile = getConfigFile(args.cwd);
+        const config = configFile ? Object.assign(args, configFile) : args;
+        const options = {
+            ignoreBinPackage: false,
+            skipMissing: false,
+            ignorePatterns: config.ignorePatterns.map(pattern => pattern.toString()),
+            ignoreMatches: config.ignoreMatches.map(match => match.toString()),
+        };
+        const folders = globSync(config.rootPackagesFolderPattern, {
+            ignore: config.ignoredPackagesFolderFiles.map(path => path.toString()),
+        });
+        const state = initializeState({
+            cwd: args.cwd,
+            folders,
+            prefix: config.prefix,
+        });
+        for (const folder of folders) {
+            const { dependencies, missing: missingDepsPerPackage } = yield depCheck(folder, options);
+            state.unusedDeps.push(...dependencies.map(x => `${folder}: ${x}`));
+            if (Object.keys(missingDepsPerPackage).length) {
+                state.missing.push(missingDepsPerPackage);
+            }
+        }
+        if (Object.values(state).every(result => result.length < 1)) {
+            logInfo('Dependencies have been checked. Everything is ok.');
+            process.exit(0);
+            return;
+        }
+        if (state.wrongVersions.length) {
+            logError('You have to fix wrong version of internal packages:');
+            state.wrongVersions.forEach(logDebug);
+        }
+        if (state.internalAsDev.length) {
+            logError('You have to fix wrong usage of internal packages in dev dependencies (either delete them or move to dependencies):');
+            state.internalAsDev.forEach(logDebug);
+        }
+        if (state.unusedDeps.length) {
+            logError('You have to fix following unused dependencies:');
+            state.unusedDeps.forEach(logDebug);
+        }
+        if (state.missing.length) {
+            logError('You have to fix following missed dependencies:');
+            state.missing.forEach(x => logDebug(JSON.stringify(x, null, 2)));
+        }
+        process.exit(1);
+    }
+    catch (err) {
+        console.error(err);
+        process.exit(1);
+    }
+}))();

package/dist/esm/types/cliArguments.d.ts

@@ -0,0 +1,4 @@
+import { Config } from './config';
+export type CliArguments = Config & {
+    cwd: string;
+};

package/dist/esm/types/cliArguments.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/config.d.ts

@@ -0,0 +1,12 @@
+export type Config = {
+    /**  Directories names that should be ignored */
+    ignorePatterns?: string[];
+    /**  Names of packages that should be ignored */
+    ignoreMatches?: string[];
+    /** Monorepo prefix (if skipped will try to find automatically) */
+    prefix?: string;
+    /** One or more paths that should be ignored in packages folder */
+    ignoredPackagesFolderFiles?: string[];
+    /** Folder containing packages (glob pattern, e.g., "packages/*" or "apps/*") */
+    rootPackagesFolderPattern?: string;
+};

package/dist/esm/types/config.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/state.d.ts

@@ -0,0 +1,6 @@
+export type State = {
+    wrongVersions: string[];
+    internalAsDev: string[];
+    unusedDeps: string[];
+    missing: Array<Record<string, string[]>>;
+};

package/dist/esm/types/state.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/utils/console.d.ts

@@ -0,0 +1,5 @@
+export declare const logError: (message: string) => void;
+export declare const logInfo: (message: string) => void;
+export declare const logHelp: (message: string) => void;
+export declare const logSilly: (message: string) => void;
+export declare const logDebug: (message: string) => void;

package/dist/esm/utils/console.js

@@ -0,0 +1,23 @@
+import colors from 'colors/safe';
+const themes = {
+    silly: 'rainbow',
+    input: 'grey',
+    verbose: 'cyan',
+    prompt: 'grey',
+    info: 'green',
+    data: 'grey',
+    help: 'cyan',
+    warn: 'yellow',
+    debug: 'blue',
+    error: 'red',
+};
+colors.setTheme(themes);
+const log = (message, theme = 'warn') => {
+    // eslint-disable-next-line no-console
+    console.log(colors[themes[theme]](`${message}\n`));
+};
+export const logError = (message) => log(message, 'error');
+export const logInfo = (message) => log(message, 'info');
+export const logHelp = (message) => log(message, 'help');
+export const logSilly = (message) => log(message, 'silly');
+export const logDebug = (message) => log(message, 'debug');

package/dist/esm/utils/getCliArguments.d.ts

@@ -0,0 +1,10 @@
+export declare function getCliArguments(): {
+    cwd: string;
+    rootPackagesFolderPattern: string;
+    ignoredPackagesFolderFiles: string[];
+    prefix: string | undefined;
+    ignorePatterns: string[] | (string | number)[];
+    ignoreMatches: string[] | (string | number)[];
+    _: (string | number)[];
+    $0: string;
+};

package/dist/esm/utils/getCliArguments.js

@@ -0,0 +1,57 @@
+import path from 'path';
+import yargs from 'yargs';
+export function getCliArguments() {
+    const parsed = yargs(process.argv.slice(2))
+        .option('cwd', {
+        alias: 'd',
+        type: 'string',
+        default: process.cwd(),
+        description: 'working directory (default: current working directory, cwd)',
+    })
+        .option('prefix', {
+        type: 'string',
+        description: 'monorepo prefix (if skipped will try to find automatically)',
+    })
+        .option('rootPackagesFolderPattern', {
+        alias: 'p',
+        type: 'string',
+        default: 'packages/*',
+        description: 'folder containing packages (glob pattern, e.g., "packages/*" or "apps/*")',
+    })
+        .option('ignoredPackagesFolderFiles', {
+        type: 'array',
+        default: ['packages/tsconfig.cjs.json', 'packages/tsconfig.esm.json'],
+        description: 'specify one or more paths that should be ignored in packages folder',
+    })
+        .option('ignorePatterns', {
+        type: 'array',
+        default: ['stories', 'dist', '__tests__', '__e2e__'],
+        description: 'specify one or more directories names that should be ignored',
+    })
+        .option('ignoreMatches', {
+        type: 'array',
+        default: [
+            'react',
+            'react-dom',
+            'react-docgen-typescript',
+            '@snack-uikit/figma-tokens',
+            '@sbercloud/figma-tokens-cloud-platform',
+            '@sbercloud/figma-tokens-mlspace',
+            '@sbercloud/figma-tokens-admin',
+            '@sbercloud/figma-tokens-web',
+            '@sbercloud/figma-tokens-giga-id',
+        ],
+        description: 'specify one or more packages that should be ignored',
+    })
+        .locale('en')
+        .help()
+        .alias('h', 'help')
+        .alias('v', 'version')
+        .parseSync();
+    const cwd = path.resolve(parsed.cwd);
+    const rootPackagesFolderPattern = path.resolve(cwd, parsed.rootPackagesFolderPattern);
+    const ignoredPackagesFolderFiles = parsed.ignoredPackagesFolderFiles.map(file => path.resolve(cwd, file.toString()));
+    return Object.assign(Object.assign({}, parsed), { cwd,
+        rootPackagesFolderPattern,
+        ignoredPackagesFolderFiles });
+}

package/dist/esm/utils/getConfigFile.d.ts

@@ -0,0 +1,3 @@
+import { CliArguments } from '../types/cliArguments';
+import { Config } from '../types/config';
+export declare function getConfigFile(cwd: CliArguments['cwd']): Config | null;

package/dist/esm/utils/getConfigFile.js

@@ -0,0 +1,17 @@
+import fs from 'fs';
+import path from 'path';
+const CONFIG_FILE_NAME = 'deps-validator.config.json';
+export function getConfigFile(cwd) {
+    const configPath = path.resolve(cwd, CONFIG_FILE_NAME);
+    if (!fs.existsSync(configPath)) {
+        return null;
+    }
+    try {
+        const configContent = fs.readFileSync(configPath, 'utf-8');
+        const config = JSON.parse(configContent);
+        return config;
+    }
+    catch (_a) {
+        return null;
+    }
+}

package/dist/esm/utils/getMonorepoPrefix.d.ts

@@ -0,0 +1,6 @@
+type Options = {
+    cwd: string;
+    folders: string[];
+};
+export declare function getMonorepoPrefix({ cwd, folders }: Options): string | null;
+export {};

package/dist/esm/utils/getMonorepoPrefix.js

@@ -0,0 +1,27 @@
+import path from 'path';
+export function getMonorepoPrefix({ cwd, folders }) {
+    var _a;
+    try {
+        // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+        const rootPkg = require(path.resolve(cwd, 'package.json'));
+        return rootPkg.name || null;
+    }
+    catch (_b) {
+        if (folders.length < 1) {
+            return null;
+        }
+        try {
+            // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+            const firstPkg = require(path.resolve(folders[0], 'package.json'));
+            // Extract monorepo scope from package name (e.g., "@cloud-ru" from "@cloud-ru/ft-deps-validator")
+            const match = (_a = firstPkg.name) === null || _a === void 0 ? void 0 : _a.match(/^(@[^/]+)/);
+            if (match) {
+                return match[1];
+            }
+            return null;
+        }
+        catch (_c) {
+            return null;
+        }
+    }
+}

package/dist/esm/utils/initializeState.d.ts

@@ -0,0 +1,8 @@
+import { State } from '../types/state';
+type Options = {
+    cwd: string;
+    folders: string[];
+    prefix?: string;
+};
+export declare function initializeState({ cwd, folders, prefix }: Options): State;
+export {};

package/dist/esm/utils/initializeState.js

@@ -0,0 +1,34 @@
+import path from 'path';
+import { getMonorepoPrefix } from './getMonorepoPrefix';
+export function initializeState({ cwd, folders, prefix }) {
+    const internalPackages = {};
+    const initialState = {
+        wrongVersions: [],
+        internalAsDev: [],
+        unusedDeps: [],
+        missing: [],
+    };
+    const monorepoName = prefix || getMonorepoPrefix({ cwd, folders });
+    if (!monorepoName) {
+        throw new Error('[ERROR] Prefix was not specified and was not found');
+    }
+    const monorepoPackageRegexp = new RegExp(`${monorepoName}\\/`);
+    for (const folder of folders) {
+        // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+        const pkg = require(path.resolve(folder, 'package.json'));
+        internalPackages[pkg.name] = pkg.version;
+    }
+    for (const folder of folders) {
+        // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+        const pkg = require(path.resolve(folder, 'package.json'));
+        const usedInternal = Object.keys(pkg.dependencies || {}).filter(x => monorepoPackageRegexp.test(x));
+        usedInternal.forEach(dep => {
+            if (pkg.dependencies[dep] !== internalPackages[dep]) {
+                initialState.wrongVersions.push(`Error in ${pkg.name}: ${dep} has ${pkg.dependencies[dep]}, but correct version is ${internalPackages[dep]}`);
+            }
+        });
+        const usedInternalDev = Object.keys(pkg.devDependencies || {}).filter(x => monorepoPackageRegexp.test(x));
+        usedInternalDev.forEach(dep => initialState.internalAsDev.push(`Error in ${pkg.name}: ${dep}`));
+    }
+    return initialState;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@cloud-ru/ft-deps-validator",
+  "version": "1.1.1",
+  "description": "Validator for unused, missing or wrong version dependencies in monorepo's packages",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "dependency",
+    "internal"
+  ],
+  "author": "Ilya Belyavskiy <iabelyavskiy@cloud.ru>",
+  "license": "Apache-2.0",
+  "bin": {
+    "deps-validator": "./dist/cjs/index.js"
+  },
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "files": [
+    "dist/esm",
+    "dist/cjs",
+    "src",
+    "./CHANGELOG.md",
+    "LICENSE"
+  ],
+  "homepage": "https://github.com/cloud-ru-tech/frontend-tools/tree/master/packages/deps-validator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cloud-ru-tech/frontend-tools.git",
+    "directory": "packages/deps-validator"
+  },
+  "dependencies": {
+    "colors": "1.4.0",
+    "depcheck": "1.4.7",
+    "glob": "10.5.0",
+    "yargs": "18.0.0"
+  },
+  "gitHead": "c8e488ecae08fbcda9738fc27674415b707038ec"
+}

package/src/index.ts

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+
+import depCheck from 'depcheck';
+import { globSync } from 'glob';
+
+import { logDebug, logError, logInfo } from './utils/console';
+import { getCliArguments } from './utils/getCliArguments';
+import { getConfigFile } from './utils/getConfigFile';
+import { initializeState } from './utils/initializeState';
+
+(async () => {
+  try {
+    const args = getCliArguments();
+    const configFile = getConfigFile(args.cwd);
+
+    const config = configFile ? Object.assign(args, configFile) : args;
+
+    const options = {
+      ignoreBinPackage: false,
+      skipMissing: false,
+      ignorePatterns: config.ignorePatterns.map(pattern => pattern.toString()),
+      ignoreMatches: config.ignoreMatches.map(match => match.toString()),
+    };
+
+    const folders = globSync(config.rootPackagesFolderPattern, {
+      ignore: config.ignoredPackagesFolderFiles.map(path => path.toString()),
+    });
+    const state = initializeState({
+      cwd: args.cwd,
+      folders,
+      prefix: config.prefix,
+    });
+
+    for (const folder of folders) {
+      const { dependencies, missing: missingDepsPerPackage } = await depCheck(folder, options);
+
+      state.unusedDeps.push(...dependencies.map(x => `${folder}: ${x}`));
+
+      if (Object.keys(missingDepsPerPackage).length) {
+        state.missing.push(missingDepsPerPackage);
+      }
+    }
+
+    if (Object.values(state).every(result => result.length < 1)) {
+      logInfo('Dependencies have been checked. Everything is ok.');
+      process.exit(0);
+      return;
+    }
+
+    if (state.wrongVersions.length) {
+      logError('You have to fix wrong version of internal packages:');
+      state.wrongVersions.forEach(logDebug);
+    }
+
+    if (state.internalAsDev.length) {
+      logError(
+        'You have to fix wrong usage of internal packages in dev dependencies (either delete them or move to dependencies):',
+      );
+      state.internalAsDev.forEach(logDebug);
+    }
+
+    if (state.unusedDeps.length) {
+      logError('You have to fix following unused dependencies:');
+      state.unusedDeps.forEach(logDebug);
+    }
+
+    if (state.missing.length) {
+      logError('You have to fix following missed dependencies:');
+      state.missing.forEach(x => logDebug(JSON.stringify(x, null, 2)));
+    }
+
+    process.exit(1);
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+})();

package/src/types/cliArguments.ts

@@ -0,0 +1,5 @@
+import { Config } from './config';
+
+export type CliArguments = Config & {
+  cwd: string;
+};

package/src/types/config.ts

@@ -0,0 +1,12 @@
+export type Config = {
+  /**  Directories names that should be ignored */
+  ignorePatterns?: string[];
+  /**  Names of packages that should be ignored */
+  ignoreMatches?: string[];
+  /** Monorepo prefix (if skipped will try to find automatically) */
+  prefix?: string;
+  /** One or more paths that should be ignored in packages folder */
+  ignoredPackagesFolderFiles?: string[];
+  /** Folder containing packages (glob pattern, e.g., "packages/*" or "apps/*") */
+  rootPackagesFolderPattern?: string;
+};

package/src/types/state.ts

@@ -0,0 +1,6 @@
+export type State = {
+  wrongVersions: string[];
+  internalAsDev: string[];
+  unusedDeps: string[];
+  missing: Array<Record<string, string[]>>;
+};

package/src/utils/console.ts

@@ -0,0 +1,27 @@
+import colors from 'colors/safe';
+
+const themes = {
+  silly: 'rainbow',
+  input: 'grey',
+  verbose: 'cyan',
+  prompt: 'grey',
+  info: 'green',
+  data: 'grey',
+  help: 'cyan',
+  warn: 'yellow',
+  debug: 'blue',
+  error: 'red',
+} as const;
+
+colors.setTheme(themes);
+
+const log = (message: string, theme: keyof typeof themes = 'warn'): void => {
+  // eslint-disable-next-line no-console
+  console.log(colors[themes[theme]](`${message}\n`));
+};
+
+export const logError = (message: string) => log(message, 'error');
+export const logInfo = (message: string) => log(message, 'info');
+export const logHelp = (message: string) => log(message, 'help');
+export const logSilly = (message: string) => log(message, 'silly');
+export const logDebug = (message: string) => log(message, 'debug');

package/src/utils/getCliArguments.ts

@@ -0,0 +1,66 @@
+import path from 'path';
+
+import yargs from 'yargs';
+
+export function getCliArguments() {
+  const parsed = yargs(process.argv.slice(2))
+    .option('cwd', {
+      alias: 'd',
+      type: 'string',
+      default: process.cwd(),
+      description: 'working directory (default: current working directory, cwd)',
+    })
+    .option('prefix', {
+      type: 'string',
+      description: 'monorepo prefix (if skipped will try to find automatically)',
+    })
+    .option('rootPackagesFolderPattern', {
+      alias: 'p',
+      type: 'string',
+      default: 'packages/*',
+      description: 'folder containing packages (glob pattern, e.g., "packages/*" or "apps/*")',
+    })
+    .option('ignoredPackagesFolderFiles', {
+      type: 'array',
+      default: ['packages/tsconfig.cjs.json', 'packages/tsconfig.esm.json'],
+      description: 'specify one or more paths that should be ignored in packages folder',
+    })
+    .option('ignorePatterns', {
+      type: 'array',
+      default: ['stories', 'dist', '__tests__', '__e2e__'],
+      description: 'specify one or more directories names that should be ignored',
+    })
+    .option('ignoreMatches', {
+      type: 'array',
+      default: [
+        'react',
+        'react-dom',
+        'react-docgen-typescript',
+        '@snack-uikit/figma-tokens',
+        '@sbercloud/figma-tokens-cloud-platform',
+        '@sbercloud/figma-tokens-mlspace',
+        '@sbercloud/figma-tokens-admin',
+        '@sbercloud/figma-tokens-web',
+        '@sbercloud/figma-tokens-giga-id',
+      ],
+      description: 'specify one or more packages that should be ignored',
+    })
+    .locale('en')
+    .help()
+    .alias('h', 'help')
+    .alias('v', 'version')
+    .parseSync();
+
+  const cwd = path.resolve(parsed.cwd);
+
+  const rootPackagesFolderPattern = path.resolve(cwd, parsed.rootPackagesFolderPattern);
+
+  const ignoredPackagesFolderFiles = parsed.ignoredPackagesFolderFiles.map(file => path.resolve(cwd, file.toString()));
+
+  return {
+    ...parsed,
+    cwd,
+    rootPackagesFolderPattern,
+    ignoredPackagesFolderFiles,
+  };
+}

package/src/utils/getConfigFile.ts

@@ -0,0 +1,23 @@
+import fs from 'fs';
+import path from 'path';
+
+import { CliArguments } from '../types/cliArguments';
+import { Config } from '../types/config';
+
+const CONFIG_FILE_NAME = 'deps-validator.config.json';
+
+export function getConfigFile(cwd: CliArguments['cwd']): Config | null {
+  const configPath = path.resolve(cwd, CONFIG_FILE_NAME);
+
+  if (!fs.existsSync(configPath)) {
+    return null;
+  }
+
+  try {
+    const configContent = fs.readFileSync(configPath, 'utf-8');
+    const config = JSON.parse(configContent) as Config;
+    return config;
+  } catch {
+    return null;
+  }
+}

package/src/utils/getMonorepoPrefix.ts

@@ -0,0 +1,32 @@
+import path from 'path';
+
+type Options = {
+  cwd: string;
+  folders: string[];
+};
+
+export function getMonorepoPrefix({ cwd, folders }: Options): string | null {
+  try {
+    // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+    const rootPkg = require(path.resolve(cwd, 'package.json'));
+    return rootPkg.name || null;
+  } catch {
+    if (folders.length < 1) {
+      return null;
+    }
+
+    try {
+      // eslint-disable-next-line import/no-dynamic-require, @typescript-eslint/no-var-requires
+      const firstPkg = require(path.resolve(folders[0], 'package.json'));
+
+      // Extract monorepo scope from package name (e.g., "@cloud-ru" from "@cloud-ru/ft-deps-validator")
+      const match = firstPkg.name?.match(/^(@[^/]+)/);
+      if (match) {
+        return match[1];
+      }
+      return null;
+    } catch {
+      return null;
+    }
+  }
+}