@eclipse-glsp/cli 2.6.0-next.183 → 2.6.0-next.185

package/src/commands/update-next.ts

@@ -1,129 +0,0 @@
-/********************************************************************************
- * Copyright (c) 2024 EclipseSource and others.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0.
- *
- * This Source Code may also be made available under the following Secondary
- * Licenses when the conditions for such availability set forth in the Eclipse
- * Public License v. 2.0 are satisfied: GNU General Public License, version 2
- * with the GNU Classpath Exception which is available at
- * https://www.gnu.org/software/classpath/license.html.
- *
- * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
- ********************************************************************************/
-
-import * as fs from 'fs';
-import { glob } from 'glob';
-import * as jq from 'node-jq';
-import * as path from 'path';
-import sh from 'shelljs';
-import { baseCommand, configureShell } from '../util/command-util';
-import { getUncommittedChanges } from '../util/git-util';
-import { LOGGER, configureLogger } from '../util/logger';
-import { validateGitDirectory } from '../util/validation-util';
-
-export const UpdateNextCommand = baseCommand()
-    .name('updateNext')
-    .alias('u')
-    .description('Updates all `next` dependencies in GLSP project to the latest version')
-    .argument('[rootDir]', 'The repository root', validateGitDirectory, process.cwd())
-    .option('-v, --verbose', 'Enable verbose (debug) log output', false)
-    .action(updateNext);
-
-export async function updateNext(rootDir: string, options: { verbose: boolean }): Promise<void> {
-    configureLogger(options.verbose);
-    configureShell({ silent: true, fatal: true });
-
-    const rootPackage = path.join(rootDir, 'package.json');
-    if (getUncommittedChanges(rootDir).includes(rootPackage)) {
-        LOGGER.warn('Uncommitted changes in root `package.json`. Please commit or stash them before running this command.');
-        return;
-    }
-
-    configureShell({ silent: false, fatal: true });
-
-    LOGGER.info('Updating next dependencies ...');
-    rootDir = path.resolve(rootDir);
-    const packages = await getWorkspacePackages(rootDir);
-    LOGGER.debug(`Scanning ${packages.length} packages to derive resolutions`, packages);
-    const resolutions = await getResolutions(packages);
-    if (Object.keys(resolutions).length === 0) {
-        LOGGER.info('No next dependencies found');
-        return;
-    }
-    LOGGER.info('Upgrade and rebuild packages ...');
-    const packageJson = fs.readFileSync(path.join(rootDir, 'package.json'), 'utf-8');
-    LOGGER.debug('Updating package.json with resolutions', resolutions);
-    fs.writeFileSync(path.join(rootDir, 'package.json'), JSON.stringify({ ...JSON.parse(packageJson), resolutions }, undefined, 2));
-    LOGGER.debug('Running yarn install');
-    sh.exec('yarn install --ignore-scripts');
-    LOGGER.debug('Reverting package.json');
-    sh.exec('git checkout HEAD -- package.json');
-    LOGGER.debug('Rebuild to update yarn.lock');
-    sh.exec('yarn');
-    LOGGER.info('Upgrade successfully completed');
-}
-
-async function getWorkspacePackages(rootDir: string): Promise<string[]> {
-    const rootPackage = path.join(rootDir, 'package.json');
-    const packages = [rootPackage];
-    if (!fs.existsSync(rootPackage)) {
-        LOGGER.error('No package.json found in root directory');
-        process.exit(1);
-    }
-    const workspaces = await getWorkspaceConfig(rootPackage);
-    if (workspaces) {
-        workspaces
-            .map(workspace => `${workspace}/**/package.json`)
-            .forEach(pattern => {
-                glob.sync(pattern, {
-                    cwd: rootDir,
-                    ignore: ['**/node_modules/**']
-                }).forEach(packageJson => packages.push(path.join(rootDir, packageJson)));
-            });
-    }
-
-    return [...new Set(packages)];
-}
-
-async function getResolutions(packages: string[]): Promise<Record<string, string>> {
-    let dependencies: string[] = [];
-    for (const pkg of packages) {
-        const deps = await jq.run(
-            '.dependencies //{} + .devDependencies + .peerDependencies | with_entries(select(.value == "next")) | keys',
-            pkg,
-            {
-                output: 'json'
-            }
-        );
-        if (Array.isArray(deps)) {
-            dependencies.push(...deps);
-        }
-    }
-    dependencies = [...new Set(dependencies)];
-    LOGGER.debug(`Found ${dependencies.length} 'next' dependencies`, dependencies);
-    LOGGER.info('Retrieve next versions ... ');
-    const resolutions: Record<string, string> = {};
-    [...new Set(dependencies)].forEach(dep => {
-        LOGGER.info(`Retrieving next version for ${dep}`);
-        const version = sh.exec(`npm view ${dep}@next version`, { silent: true }).stdout.trim();
-        resolutions[`**/${dep}`] = version;
-    });
-    return resolutions;
-}
-async function getWorkspaceConfig(rootPackage: string): Promise<string[] | undefined> {
-    const result = await jq.run('.workspaces', rootPackage, { output: 'json' });
-    if (!result) {
-        return undefined;
-    }
-    if (Array.isArray(result)) {
-        return result;
-    }
-    if (typeof result === 'object' && 'packages' in result && Array.isArray(result.packages)) {
-        return result.packages;
-    }
-
-    return undefined;
-}

package/src/util/command-util.ts

@@ -1,54 +0,0 @@
-/********************************************************************************
- * Copyright (c) 2022-2024 EclipseSource and others.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0.
- *
- * This Source Code may also be made available under the following Secondary
- * Licenses when the conditions for such availability set forth in the Eclipse
- * Public License v. 2.0 are satisfied: GNU General Public License, version 2
- * with the GNU Classpath Exception which is available at
- * https://www.gnu.org/software/classpath/license.html.
- *
- * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
- ********************************************************************************/
-import { Command } from 'commander';
-import sh from 'shelljs';
-
-// Commander.js utils
-export function baseCommand(cmd = new Command()): Command {
-    return cmd //
-        .showSuggestionAfterError(true)
-        .showHelpAfterError(true)
-        .allowUnknownOption(false);
-}
-
-export type ShellConfig = sh.ExecOptions & { async: false };
-export const SH_CONFIG: ShellConfig = {
-    async: false,
-    fatal: true,
-    silent: false
-};
-
-export function getShellConfig(options: Partial<Omit<ShellConfig, 'async'>> = {}): ShellConfig {
-    return {
-        ...SH_CONFIG,
-        ...options
-    };
-}
-
-export function configureShell(config: Partial<sh.ShellConfig>): void {
-    sh.config.reset();
-    getShellConfig({});
-    SH_CONFIG.silent = config.silent;
-    SH_CONFIG.fatal = config.fatal;
-}
-
-export function fatalExec(command: string, fatalErrorMessage: string, options: Partial<Omit<ShellConfig, 'async'>> = {}): sh.ShellString {
-    const result = sh.exec(command, getShellConfig(options));
-    if (result.code !== 0) {
-        throw new Error(fatalErrorMessage);
-    }
-    return result;
-}

package/src/util/git-util.ts

@@ -1,123 +0,0 @@
-/********************************************************************************
- * Copyright (c) 2022-2024 EclipseSource and others.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0.
- *
- * This Source Code may also be made available under the following Secondary
- * Licenses when the conditions for such availability set forth in the Eclipse
- * Public License v. 2.0 are satisfied: GNU General Public License, version 2
- * with the GNU Classpath Exception which is available at
- * https://www.gnu.org/software/classpath/license.html.
- *
- * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
- ********************************************************************************/
-
-import { resolve } from 'path';
-import sh from 'shelljs';
-import { getShellConfig } from './command-util';
-
-export function isGitRepository(path?: string): boolean {
-    cdIfPresent(path);
-    const isGitRepo =
-        sh
-            .exec('git rev-parse --is-inside-work-tree', getShellConfig({ silent: true }))
-            .stdout.trim()
-            .toLocaleLowerCase() === 'true';
-    return isGitRepo;
-}
-
-export function getGitRoot(path?: string): string {
-    cdIfPresent(path);
-    const fileString = sh.exec('git rev-parse --show-toplevel', getShellConfig()).stdout.trim();
-    return resolve(fileString);
-}
-
-export function hasGitChanges(path?: string): boolean {
-    return getUncommittedChanges(path).length > 0;
-}
-
-/**
- * Returns the files that have uncommitted changes (staged, not staged and untracked) of a git repository.
- * Filepaths are absolute.
- */
-export function getUncommittedChanges(path?: string): string[] {
-    cdIfPresent(path);
-    return sh
-        .exec('git status --porcelain', getShellConfig())
-        .stdout.trim()
-        .split('\n')
-        .filter(value => value.trim().length !== 0)
-        .map(fileInfo =>
-            // Extract relative file path from the info string and convert to absolute path
-            resolve(path ?? process.cwd(), fileInfo.trim().split(' ').pop() ?? '')
-        );
-}
-
-/**
- * Returns the files tha have been changed with the last commit (also includes currently staged but uncommitted changes)
- * Filepaths are absolute.
- */
-export function getChangesOfLastCommit(path?: string): string[] {
-    cdIfPresent(path);
-    return sh
-        .exec('git diff --name-only HEAD^', getShellConfig())
-        .stdout.trim()
-        .split('\n')
-        .map(file => resolve(path ?? process.cwd(), file));
-}
-
-/**
- * Returns the last modification date of a file (or the last commit) in a git repo.
- * @param filePath The file. If undefined the modification date of the last commit will be returned
- * @param repoRoot The path to the repo root. If undefined the current working directory is used.
- * @param excludeMessage Only consider commits that don`t match the excludeMessage
- * @returns The date or undefined if the file is outside of the git repo.
- */
-export function getLastModificationDate(filePath?: string, repoRoot?: string, excludeMessage?: string): Date | undefined {
-    cdIfPresent(repoRoot);
-    const additionalArgs = excludeMessage ? `--grep="${excludeMessage}" --invert-grep` : '';
-    const result = sh.exec(`git log -1 ${additionalArgs} --pretty="format:%ci" ${filePath ?? ''}`, getShellConfig());
-    if (result.code !== 0) {
-        return undefined;
-    }
-    return new Date(result.stdout.trim());
-}
-
-export function getFilesOfCommit(commitHash: string, repoRoot?: string): string[] {
-    cdIfPresent(repoRoot);
-    const result = sh.exec(`git show --pretty="" --name-only ${commitHash}`, getShellConfig());
-    if (result.code !== 0) {
-        return [];
-    }
-
-    return result.stdout.trim().split('\n');
-}
-
-export function getLatestGithubRelease(path?: string): string {
-    cdIfPresent(path);
-    const release = sh.exec('gh release list --exclude-drafts -L 1', getShellConfig()).stdout.trim().split('\t');
-    return release[release.length - 2];
-}
-
-export function getLatestTag(path?: string): string {
-    cdIfPresent(path);
-    return sh.exec('git describe --abbrev=0 --tags', getShellConfig()).stdout.trim();
-}
-
-export function hasBranch(branch: string, path?: string): boolean {
-    cdIfPresent(path);
-    return sh.exec(`git branch --list ${branch}`, getShellConfig()).stdout.trim().length !== 0;
-}
-
-export function getRemoteUrl(path?: string): string {
-    cdIfPresent(path);
-    return sh.exec('git config --get remote.origin.url', getShellConfig()).stdout.trim();
-}
-
-function cdIfPresent(path?: string): void {
-    if (path) {
-        sh.cd(path);
-    }
-}

package/src/util/logger.ts

@@ -1,57 +0,0 @@
-/********************************************************************************
- * Copyright (c) 2022-2023 EclipseSource and others.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0.
- *
- * This Source Code may also be made available under the following Secondary
- * Licenses when the conditions for such availability set forth in the Eclipse
- * Public License v. 2.0 are satisfied: GNU General Public License, version 2
- * with the GNU Classpath Exception which is available at
- * https://www.gnu.org/software/classpath/license.html.
- *
- * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
- ********************************************************************************/
-
-export interface Logger extends Pick<Console, LogLevel> {
-    newLine(): void;
-}
-
-export type LogLevel = 'info' | 'debug' | 'error' | 'warn';
-
-const levels: Record<LogLevel, { threshold: number; color: string }> = {
-    error: { threshold: 0, color: '\x1b[31m' }, // red
-    warn: { threshold: 1, color: '\x1b[33m' }, // yellow
-    info: { threshold: 2, color: '\x1b[0m' }, // default terminal color
-    debug: { threshold: 3, color: '\x1b[32m' } // green
-};
-
-let levelThreshold: number = levels.info.threshold;
-
-export const LOGGER: Logger = {
-    info: (...args) => log('info', ...args),
-    error: (...args) => log('error', ...args),
-    warn: (...args) => log('warn', ...args),
-    debug: (...args) => log('debug', ...args),
-    newLine: () => console.log('')
-} as const;
-
-function log(level: LogLevel, ...args: any[]): void {
-    const levelData = levels[level];
-    if (levelThreshold < levelData.threshold) {
-        return;
-    }
-    console[level](levelData.color, ...args, '\x1b[0m');
-}
-
-export function configureLogger(level: LogLevel): void;
-export function configureLogger(verbose: boolean): void;
-export function configureLogger(levelOrVerbose: LogLevel | boolean): void {
-    if (typeof levelOrVerbose === 'boolean') {
-        const level: LogLevel = levelOrVerbose ? 'debug' : 'info';
-        levelThreshold = levels[level].threshold;
-    } else {
-        levelThreshold = levels[levelOrVerbose].threshold;
-    }
-}

package/src/util/validation-util.ts

@@ -1,62 +0,0 @@
-/********************************************************************************
- * Copyright (c) 2022-2024 EclipseSource and others.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0.
- *
- * This Source Code may also be made available under the following Secondary
- * Licenses when the conditions for such availability set forth in the Eclipse
- * Public License v. 2.0 are satisfied: GNU General Public License, version 2
- * with the GNU Classpath Exception which is available at
- * https://www.gnu.org/software/classpath/license.html.
- *
- * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
- ********************************************************************************/
-import { InvalidArgumentError } from 'commander';
-import * as fs from 'fs';
-import { resolve } from 'path';
-import * as semver from 'semver';
-import { getGitRoot, isGitRepository } from './git-util';
-import { LOGGER } from './logger';
-
-export function validateDirectory(rootDir: string): string {
-    const path = resolve(rootDir);
-    if (!fs.existsSync(path)) {
-        throw new InvalidArgumentError('Not a valid file path!');
-    }
-
-    if (!fs.statSync(path).isDirectory()) {
-        throw new InvalidArgumentError('Not a directory!');
-    }
-    return path;
-}
-
-export function validateFile(filePath: string, hasToExist = false): string {
-    const path = resolve(filePath);
-
-    if (hasToExist && !fs.existsSync(path)) {
-        throw new InvalidArgumentError('Not a valid file path!');
-    }
-    if (!fs.statSync(path).isFile()) {
-        throw new InvalidArgumentError('Not a file!');
-    }
-    return path;
-}
-
-export function validateVersion(version: string): string {
-    LOGGER.debug(`Validate version format of: ${version}`);
-    if (!semver.valid(version)) {
-        throw new InvalidArgumentError(`Not a valid version: ${version}`);
-    }
-    return version;
-}
-
-export function validateGitDirectory(repository: string): string {
-    const repoPath = validateDirectory(repository);
-    if (!isGitRepository(repoPath)) {
-        throw new InvalidArgumentError('Not a valid git repository');
-    }
-
-    return getGitRoot(repository);
-}