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

package/src/commands/release/release-eclipse-integration.ts

@@ -1,113 +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 sh from 'shelljs';
-import { fatalExec, getShellConfig } from '../../util/command-util';
-import { LOGGER } from '../../util/logger';
-import {
-    ReleaseOptions,
-    ReleaseType,
-    asMvnVersion,
-    checkJavaServerVersion,
-    checkoutAndCd,
-    commitAndTag,
-    lernaSetVersion,
-    publish,
-    updateLernaForDryRun,
-    updateVersion,
-    yarnInstall
-} from './common.js';
-
-let REPO_ROOT: string;
-
-export async function releaseEclipseIntegration(options: ReleaseOptions): Promise<void> {
-    LOGGER.info('Prepare glsp-eclipse-integration release');
-    LOGGER.debug('Release options: ', options);
-    checkJavaServerVersion(options.version);
-
-    REPO_ROOT = checkoutAndCd(options);
-    prepareClient(options);
-    prepareServer(options);
-    generateChangeLog();
-    commitAndTag(asMvnVersion(options.version), REPO_ROOT);
-    publish(REPO_ROOT, options);
-    LOGGER.info('glsp-eclipse-integration release successful!');
-}
-
-function prepareClient(options: ReleaseOptions): void {
-    LOGGER.info('Prepare client');
-    updateExternalGLSPDependencies(options.version);
-    lernaSetVersion(`${REPO_ROOT}/client`, options.version);
-    buildClient();
-    if (options.npmDryRun) {
-        updateLernaForDryRun();
-    }
-}
-
-function updateExternalGLSPDependencies(version: string): void {
-    LOGGER.info('Update external GLSP dependencies (Client and workflow example)');
-    sh.cd(`${REPO_ROOT}/client`);
-    updateVersion({ name: '@eclipse-glsp/client', version }, { name: '@eclipse-glsp-examples/workflow-glsp', version });
-}
-
-function buildClient(): void {
-    LOGGER.info('[Client] Install & Build with yarn');
-    yarnInstall(`${REPO_ROOT}/client`);
-    LOGGER.debug('Build successful');
-}
-
-function generateChangeLog(): void {
-    // do nothing for now
-}
-
-function prepareServer(options: ReleaseOptions): void {
-    const mvnVersion = asMvnVersion(options.version);
-    setServerVersion(mvnVersion);
-    updateTarget(mvnVersion, options.releaseType);
-    buildServer();
-}
-
-function setServerVersion(version: string): void {
-    LOGGER.info(`Set pom version to ${version}`);
-    sh.cd(`${REPO_ROOT}/server`);
-    // Execute tycho-versions plugin
-    fatalExec(`mvn tycho-versions:set-version -DnewVersion=${version}`, 'Mvn set-versions failed', getShellConfig({ silent: false }));
-    LOGGER.debug('Version update complete!');
-}
-
-function buildServer(): void {
-    sh.cd(`${REPO_ROOT}/server`);
-    LOGGER.info('Build Server(P2)');
-    fatalExec('mvn clean install', 'P2 build failed', getShellConfig({ silent: false }));
-}
-function updateTarget(mvnVersion: string, releaseType: ReleaseType): void {
-    const p2SubLocation = releaseType === 'rc' ? 'staging' : 'releases';
-    const p2Location = `https://download.eclipse.org/glsp/server/p2/${p2SubLocation}/${mvnVersion}/`;
-    LOGGER.info(`Update glsp server p2 repository to ${p2Location}`);
-    sh.cd(`${REPO_ROOT}/server/releng/org.eclipse.glsp.ide.releng.target`);
-    LOGGER.debug('Update r2021-03.tpd file');
-    sh.exec(
-        `sed -i 's_location "https://download.eclipse.org/glsp/server/p2/.*"_location "${p2Location}"_' r2021-03.tpd`,
-        getShellConfig()
-    );
-    LOGGER.debug('Update r2021-03.target file');
-    sh.exec(
-        // eslint-disable-next-line max-len
-        `sed -i 's_      <repository location="https://download.eclipse.org/glsp/server/p2/.*"_      <repository location="${p2Location}"_g' r2021-03.target`,
-        getShellConfig()
-    );
-    LOGGER.debug('Target update successful');
-}

package/src/commands/release/release-java-server.ts

@@ -1,73 +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 sh from 'shelljs';
-import { fatalExec, getShellConfig } from '../../util/command-util';
-import { LOGGER } from '../../util/logger';
-import { ReleaseOptions, asMvnVersion, checkoutAndCd, commitAndTag, publish } from './common';
-
-let REPO_ROOT: string;
-
-export async function releaseJavaServer(options: ReleaseOptions): Promise<void> {
-    LOGGER.info('Prepare glsp-server release');
-    LOGGER.debug('Release options: ', options);
-    const mvnVersion = asMvnVersion(options.version);
-    REPO_ROOT = checkoutAndCd(options);
-    sh.find();
-    setVersion(mvnVersion);
-    build();
-    generateChangeLog();
-    commitAndTag(mvnVersion, REPO_ROOT);
-    publish(REPO_ROOT, options);
-    LOGGER.info('glsp-server release successful!');
-}
-
-function setVersion(version: string): void {
-    LOGGER.info(`Set pom version to ${version}`);
-    sh.cd(REPO_ROOT);
-    LOGGER.debug('Preprocessing eclipse-plugins poms');
-    // Capture all poms with a `${package.type}` property
-
-    const pluginPoms = sh
-        .exec('grep -ril --include pom.xml \\${package-type}', getShellConfig()) //
-        .stdout.trim()
-        .split('\n')
-        .map(file => `${REPO_ROOT}/${file}`);
-
-    // Replace `${package.type}` property with `eclipse-plugin`
-    sh.sed('-i', /\${package-type}/, 'eclipse-plugin', pluginPoms);
-    LOGGER.debug('Preprocessing complete');
-
-    // Execute tycho-versions plugin
-    fatalExec(`mvn tycho-versions:set-version -DnewVersion=${version}`, 'Mvn set-versions failed', getShellConfig({ silent: false }));
-
-    LOGGER.debug('Restore eclipse-plugin poms');
-    sh.sed('-i', /<packaging>eclipse-plugin/, '<packaging>${package-type}', pluginPoms);
-
-    LOGGER.debug('Version update complete!');
-}
-
-function generateChangeLog(): void {
-    // do nothing for now
-}
-
-function build(): void {
-    LOGGER.info('Build M2 & P2');
-    LOGGER.debug('M2');
-    fatalExec('mvn clean install -Pm2', 'M2 build failed', getShellConfig({ silent: false }));
-    LOGGER.newLine();
-    LOGGER.debug('P2');
-    fatalExec('mvn clean install -Pp2', 'P2 build failed', getShellConfig({ silent: false }));
-}

package/src/commands/release/release-server-node.ts

@@ -1,61 +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 sh from 'shelljs';
-import { LOGGER } from '../../util/logger';
-import {
-    checkoutAndCd,
-    commitAndTag,
-    lernaSetVersion,
-    publish,
-    ReleaseOptions,
-    updateLernaForDryRun,
-    updateVersion,
-    yarnInstall
-} from './common.js';
-
-let REPO_ROOT: string;
-
-export async function releaseServerNode(options: ReleaseOptions): Promise<void> {
-    LOGGER.info('Prepare glsp-server-node release');
-    LOGGER.debug('Release options: ', options);
-    REPO_ROOT = checkoutAndCd(options);
-    updateExternalGLSPDependencies(options.version);
-    generateChangeLog();
-    lernaSetVersion(REPO_ROOT, options.version);
-    build();
-    if (options.npmDryRun) {
-        updateLernaForDryRun();
-    }
-    commitAndTag(options.version, REPO_ROOT);
-    publish(REPO_ROOT, options);
-}
-
-function updateExternalGLSPDependencies(version: string): void {
-    LOGGER.info('Update external GLSP dependencies (Protocol)');
-    sh.cd(REPO_ROOT);
-    updateVersion({ name: '@eclipse-glsp/protocol', version });
-}
-
-function build(): void {
-    LOGGER.info('Install & Build with yarn');
-    yarnInstall(REPO_ROOT);
-    LOGGER.debug('Build successful');
-}
-
-function generateChangeLog(): void {
-    // do nothing for now
-}

package/src/commands/release/release-theia-integration.ts

@@ -1,65 +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 sh from 'shelljs';
-import { LOGGER } from '../../util/logger';
-import {
-    checkoutAndCd,
-    commitAndTag,
-    lernaSetVersion,
-    publish,
-    ReleaseOptions,
-    updateLernaForDryRun,
-    updateVersion,
-    yarnInstall
-} from './common.js';
-
-let REPO_ROOT: string;
-
-export async function releaseTheiaIntegration(options: ReleaseOptions): Promise<void> {
-    LOGGER.info('Prepare glsp-theia-integration release');
-    LOGGER.debug('Release options: ', options);
-    REPO_ROOT = checkoutAndCd(options);
-    updateExternalGLSPDependencies(options.version);
-    generateChangeLog();
-    lernaSetVersion(REPO_ROOT, options.version);
-    build();
-    if (options.npmDryRun) {
-        updateLernaForDryRun();
-    }
-    commitAndTag(options.version, REPO_ROOT);
-    publish(REPO_ROOT, options);
-}
-
-function updateExternalGLSPDependencies(version: string): void {
-    LOGGER.info('Update external GLSP dependencies (Client and workflow example & server)');
-    sh.cd(REPO_ROOT);
-    updateVersion(
-        { name: '@eclipse-glsp/client', version },
-        { name: '@eclipse-glsp-examples/workflow-glsp', version },
-        { name: '@eclipse-glsp-examples/workflow-server', version }
-    );
-}
-
-function build(): void {
-    LOGGER.info('Install & Build with yarn');
-    yarnInstall(REPO_ROOT);
-    LOGGER.debug('Build successful');
-}
-
-function generateChangeLog(): void {
-    // do nothing for now
-}

package/src/commands/release/release-vscode-integration.ts

@@ -1,67 +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 sh from 'shelljs';
-import { LOGGER } from '../../util/logger';
-import {
-    checkoutAndCd,
-    commitAndTag,
-    lernaSetVersion,
-    publish,
-    ReleaseOptions,
-    updateLernaForDryRun,
-    updateVersion,
-    yarnInstall
-} from './common.js';
-
-let REPO_ROOT: string;
-
-export async function releaseVscodeIntegration(options: ReleaseOptions): Promise<void> {
-    LOGGER.info('Prepare glsp-vscode-integration release');
-    LOGGER.debug('Release options: ', options);
-    REPO_ROOT = checkoutAndCd(options);
-    updateExternalGLSPDependencies(options.version);
-    generateChangeLog();
-    lernaSetVersion(REPO_ROOT, options.version);
-    build();
-    if (options.npmDryRun) {
-        updateLernaForDryRun();
-    }
-    commitAndTag(options.version, REPO_ROOT);
-    publish(REPO_ROOT, options);
-}
-
-function updateExternalGLSPDependencies(version: string): void {
-    LOGGER.info('Update external GLSP dependencies (Protocol)');
-    sh.cd(REPO_ROOT);
-    updateVersion(
-        { name: '@eclipse-glsp/protocol', version },
-        { name: '@eclipse-glsp/client', version },
-        { name: '@eclipse-glsp-examples/workflow-glsp', version },
-        { name: '@eclipse-glsp-examples/workflow-server', version },
-        { name: '@eclipse-glsp-examples/workflow-server-bundled', version }
-    );
-}
-
-function build(): void {
-    LOGGER.info('Install & Build with yarn');
-    yarnInstall(REPO_ROOT);
-    LOGGER.debug('Build successful');
-}
-
-function generateChangeLog(): void {
-    // do nothing for now
-}

package/src/commands/release/release.ts

@@ -1,215 +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 { ChildProcess } from 'child_process';
-import { Argument } from 'commander';
-import { exit } from 'process';
-import { createInterface } from 'readline';
-import * as readline from 'readline-sync';
-import * as semver from 'semver';
-import sh from 'shelljs';
-import { baseCommand, configureShell, fatalExec, getShellConfig } from '../../util/command-util';
-import { LOGGER, configureLogger } from '../../util/logger';
-import { validateDirectory, validateVersion } from '../../util/validation-util';
-import {
-    Component,
-    ReleaseOptions,
-    ReleaseType,
-    VERDACCIO_REGISTRY,
-    asMvnVersion,
-    checkIfMavenVersionExists,
-    checkIfNpmVersionIsNew
-} from './common.js';
-import { releaseClient } from './release-client';
-import { releaseEclipseIntegration } from './release-eclipse-integration';
-import { releaseJavaServer } from './release-java-server';
-import { releaseServerNode } from './release-server-node';
-import { releaseTheiaIntegration } from './release-theia-integration';
-import { releaseVscodeIntegration } from './release-vscode-integration';
-
-interface ReleaseCmdOptions {
-    checkoutDir: string;
-    branch: string;
-    force: boolean;
-    publish: boolean;
-    npmDryRun: boolean;
-    draft: boolean;
-    verbose: boolean;
-}
-
-export const ReleaseCommand = baseCommand()
-    .name('release')
-    .description('Prepare & publish a new release for a glsp component')
-    .addArgument(new Argument('<component>', 'The glsp component to be released').choices(Component.CLI_CHOICES).argParser(Component.parse))
-    .addArgument(new Argument('<releaseType>', 'The release type').choices(ReleaseType.CLI_CHOICES))
-    .argument('[customVersion]', 'Custom version number. Will be ignored if the release type is not "custom"', validateVersion)
-    .option('-f, --force', 'Enable force mode', false)
-    .option('-d, --checkoutDir <checkoutDir>', 'The git checkout directory', validateDirectory, process.cwd())
-    .option('-b, --branch <branch>', 'The git branch to checkout', 'master')
-    .option('-v, --verbose', 'Enable verbose (debug) log output', false)
-    .option('--no-publish', 'Only prepare release but do not publish to github', true)
-    .option('--draft', 'Publish github releases as drafts', false)
-    .option(
-        '--npm-dryRun',
-        'Execute a npm dry-run for inspection. Publishes to the local npm registry and does not publish to github',
-        false
-    )
-    .action(release);
-
-let verdaccioChildProcess: ChildProcess | undefined = undefined;
-
-export async function release(
-    component: Component,
-    releaseType: ReleaseType,
-    customVersion: string | undefined,
-    cliOptions: ReleaseCmdOptions
-): Promise<void> {
-    try {
-        configureLogger(cliOptions.verbose);
-        LOGGER.debug('Cli options:', cliOptions);
-        configureShell({ silent: !cliOptions.verbose });
-        checkGHCli();
-        const version = deriveVersion(releaseType, customVersion);
-        const options: ReleaseOptions = { ...cliOptions, component, releaseType, version };
-        if (cliOptions.npmDryRun && options.component.releaseRepo === 'npm') {
-            await launchVerdaccio().catch(error => LOGGER.error('Error occurred during verdaccio launch', error));
-        }
-        switch (component.type) {
-            case 'server-java':
-                checkIfMavenVersionExists('org.eclipse.glsp', 'org.eclipse.glsp.server', asMvnVersion(version));
-                return releaseJavaServer(options);
-            case 'server-node':
-                await checkIfNpmVersionIsNew('@eclipse-glsp/server-node', version);
-                return releaseServerNode(options);
-            case 'client':
-                await checkIfNpmVersionIsNew('@eclipse-glsp/client', version);
-                return releaseClient(options);
-            case 'theia-integration':
-                await checkIfNpmVersionIsNew('@eclipse-glsp/theia-integration', version);
-                return releaseTheiaIntegration(options);
-            case 'vscode-integration':
-                await checkIfNpmVersionIsNew('@eclipse-glsp/vscode-integration', version);
-                return releaseVscodeIntegration(options);
-            case 'eclipse-integration':
-                await checkIfNpmVersionIsNew('@eclipse-glsp/ide', version);
-                return releaseEclipseIntegration(options);
-        }
-    } catch (err) {
-        console.error('An error occurred during command execution:', err);
-        exit(1);
-    } finally {
-        if (verdaccioChildProcess) {
-            verdaccioChildProcess.kill();
-        }
-    }
-}
-
-function checkGHCli(): void {
-    LOGGER.debug('Verify that Github CLI is configured correctly');
-    if (!isGithubCLIAuthenticated()) {
-        throw new Error("Github CLI is not configured properly. No user is logged in for host 'github.com'");
-    }
-}
-
-function isGithubCLIAuthenticated(): boolean {
-    LOGGER.debug('Verify that Github CLI is installed');
-    fatalExec('which gh', 'Github CLI is not installed!');
-
-    const status = sh.exec('gh auth status', getShellConfig());
-    if (status.code !== 0) {
-        if (status.stderr.includes('You are not logged into any GitHub hosts')) {
-            return false;
-        }
-        throw new Error(status.stderr);
-    }
-    if (!status.stdout.trim().includes('Logged in to github.com')) {
-        LOGGER.debug("No user is logged in for host 'github.com'");
-        return false;
-    }
-    LOGGER.debug('Github CLI is authenticated and ready to use');
-    return true;
-}
-
-function launchVerdaccio(): Promise<void> {
-    LOGGER.debug('Verify that verdaccio is installed and start if necessary');
-    fatalExec('which verdaccio', 'Verdaccio is not installed!');
-    // Check if verdaccio is alreaddy running
-    const result = sh.exec(`curl -i ${VERDACCIO_REGISTRY}`, getShellConfig());
-    if (result.code !== 0) {
-        LOGGER.info('Starting local verdaccio registry');
-        verdaccioChildProcess = sh.exec('verdaccio', { async: true, silent: true });
-        return new Promise(resolve => {
-            createInterface(verdaccioChildProcess!.stdout!).on('line', line => {
-                if (line.includes(`http address - ${VERDACCIO_REGISTRY}`)) {
-                    resolve();
-                }
-            });
-        });
-    }
-    return Promise.resolve();
-}
-
-function deriveVersion(releaseType: ReleaseType, customVersion?: string): string {
-    LOGGER.debug(`Derive version from release type: ${release}`);
-    switch (releaseType) {
-        case 'custom':
-            return getCustomVersion(customVersion);
-        case 'rc':
-            return getRCVersion();
-        case 'patch':
-        case 'major':
-        case 'minor':
-            return semverInc(releaseType);
-    }
-}
-
-const REFERENCE_NPM_PACKAGE = '@eclipse-glsp/ide';
-
-function getRCVersion(): string {
-    LOGGER.debug('Retrieve and new RC version');
-    const newBaseVersion = semverInc('minor');
-    const currentRcVersion = sh.exec(`npm view ${REFERENCE_NPM_PACKAGE} dist-tags.rc`, getShellConfig()).stdout.trim();
-    const currentRcBaseVersion = currentRcVersion.split('-')[0];
-    if (currentRcBaseVersion !== newBaseVersion) {
-        return `${newBaseVersion}-RC01`;
-    }
-    let rcNumber = Number.parseInt(currentRcVersion.replace(`${currentRcBaseVersion}-RC`, ''), 10);
-    rcNumber++;
-
-    return `${newBaseVersion}-RC` + `${rcNumber}`.padStart(2, '0');
-}
-
-function getCustomVersion(customVersion?: string): string {
-    LOGGER.debug('Retrieve and validate custom version');
-    LOGGER.debug(customVersion ? `Custom version has been passed as argument: ${customVersion}` : 'Prompt custom version from user');
-    const version = customVersion ?? readline.question('> Please enter the new version');
-    return validateVersion(version);
-}
-
-function getCurrentVersion(): string {
-    LOGGER.debug('Retrieve base version by querying the latest tag of the reference npm package');
-    const version = sh.exec(`npm view ${REFERENCE_NPM_PACKAGE} dist-tags.latest`, getShellConfig()).stdout.trim();
-    return validateVersion(version);
-}
-
-function semverInc(releaseType: semver.ReleaseType, identifier?: string): string {
-    const currentVersion = getCurrentVersion();
-    LOGGER.debug(`Execute: semver.inc("${currentVersion}", ${releaseType}, ${identifier})`);
-    const newVersion = semver.inc(currentVersion, releaseType, identifier);
-    if (!newVersion) {
-        throw new Error(`Could not increment version: ${currentVersion} `);
-    }
-    return newVersion;
-}