@eclipse-glsp/cli 1.1.0-next.4c65907.114

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

@@ -0,0 +1,77 @@
+/********************************************************************************
+ * Copyright (c) 2022 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 sh from 'shelljs';
+import { LOGGER } from '../util/logger';
+import {
+    asMvnVersion,
+    checkoutAndCd,
+    commitAndTag,
+    isExistingMavenVersion,
+    lernaSetVersion,
+    publish,
+    ReleaseOptions,
+    updateLernaForDryRun,
+    updateServerConfig,
+    updateVersion,
+    yarnInstall
+} from './common';
+
+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);
+    await updateDownloadServerScript(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)');
+    sh.cd(REPO_ROOT);
+    updateVersion({ name: '@eclipse-glsp/client', version }, { name: '@eclipse-glsp-examples/workflow-glsp', version });
+}
+
+async function updateDownloadServerScript(version: string): Promise<void> {
+    LOGGER.info('Update example server download config');
+    const mvnVersion = asMvnVersion(version);
+    if (!isExistingMavenVersion('org.eclipse.glsp', 'org.eclipse.glsp.server', mvnVersion)) {
+        LOGGER.warn(`No Java GLSP server with version ${mvnVersion} found on maven central!. Please release a new Java GLSP Server version
+        before publishing this release!`);
+    }
+
+    sh.cd(`${REPO_ROOT}/examples/workflow-theia/src/node`);
+    updateServerConfig('server-config.json', mvnVersion, false);
+}
+
+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/release/release-vscode-integration.ts

@@ -0,0 +1,65 @@
+/********************************************************************************
+ * Copyright (c) 2022 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 sh from 'shelljs';
+import { LOGGER } from '../util/logger';
+import {
+    checkoutAndCd,
+    commitAndTag,
+    lernaSetVersion,
+    publish,
+    ReleaseOptions,
+    updateLernaForDryRun,
+    updateVersion,
+    yarnInstall
+} from './common';
+
+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 }
+    );
+}
+
+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/release/release.ts

@@ -0,0 +1,174 @@
+/********************************************************************************
+ * Copyright (c) 2022 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 { exit } from 'process';
+import { createInterface } from 'readline';
+import * as readline from 'readline-sync';
+import * as semver from 'semver';
+import * as sh from 'shelljs';
+import { BaseCmdOptions, fatalExec, getShellConfig, initialConfiguration } from '../util/command-util';
+import { isGithubCLIAuthenticated } from '../util/git-util';
+import { LOGGER } from '../util/logger';
+import { validateVersion } from '../util/validation-util';
+import {
+    asMvnVersion,
+    checkIfMavenVersionExists,
+    checkIfNpmVersionExists,
+    Component,
+    ReleaseOptions,
+    ReleaseType,
+    VERDACCIO_REGISTRY
+} from './common';
+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 extends BaseCmdOptions {
+    checkoutDir: string;
+    branch: string;
+    force: boolean;
+    publish: boolean;
+    npmDryRun: boolean;
+    draft: boolean;
+}
+
+let verdaccioChildProcess: ChildProcess | undefined = undefined;
+
+export async function release(
+    component: Component,
+    releaseType: ReleaseType,
+    customVersion: string | undefined,
+    cliOptions: ReleaseCmdOptions
+): Promise<void> {
+    try {
+        LOGGER.debug('Cli options:', cliOptions);
+        initialConfiguration(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 checkIfNpmVersionExists('@eclipse-glsp/server-node', version);
+                return releaseServerNode(options);
+            case 'client':
+                await checkIfNpmVersionExists('@eclipse-glsp/client', version);
+                return releaseClient(options);
+            case 'theia-integration':
+                await checkIfNpmVersionExists('@eclipse-glsp/theia-integration', version);
+                return releaseTheiaIntegration(options);
+            case 'vscode-integration':
+                await checkIfNpmVersionExists('@eclipse-glsp/vscode-integration', version);
+                return releaseVscodeIntegration(options);
+            case 'eclipse-integration':
+                await checkIfNpmVersionExists('@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 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(release: ReleaseType, customVersion?: string): string {
+    LOGGER.debug(`Derive version from release type: ${release}`);
+    switch (release) {
+        case 'custom':
+            return getCustomVersion(customVersion);
+        case 'rc':
+            return getRCVersion();
+        case 'patch':
+        case 'major':
+        case 'minor':
+            return semverInc(release);
+    }
+}
+
+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;
+}

package/src/util/command-util.ts

@@ -0,0 +1,63 @@
+/********************************************************************************
+ * Copyright (c) 2022 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 * as sh from 'shelljs';
+import { configureLogger } from './logger';
+export const COMMAND_VERSION = '1.1.0-next';
+
+export function baseConfiguration(cmd: Command): Command {
+    return cmd
+        .version(COMMAND_VERSION) //
+        .showSuggestionAfterError(true)
+        .showHelpAfterError(true)
+        .allowUnknownOption(false);
+}
+
+export interface BaseCmdOptions {
+    verbose: boolean;
+}
+
+export const SH_CONFIG: sh.ExecOptions & { async: false } = {
+    async: false,
+    fatal: true,
+    silent: false
+};
+
+export function getShellConfig(options: Partial<Omit<sh.ExecOptions, 'async'>> = {}): sh.ExecOptions & { async: false } {
+    return {
+        ...SH_CONFIG,
+        ...options
+    };
+}
+
+export function initialConfiguration(verbose: boolean): void {
+    sh.config.reset();
+
+    SH_CONFIG.silent = !verbose;
+    configureLogger(verbose);
+}
+
+export function fatalExec(
+    command: string,
+    fatalErrorMessage: string,
+    options: Partial<Omit<sh.ExecOptions, '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

@@ -0,0 +1,87 @@
+/********************************************************************************
+ * Copyright (c) 2022 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 sh from 'shelljs';
+import { fatalExec, getShellConfig } from './command-util';
+import { LOGGER } from './logger';
+import { validateGitDirectory } from './validation-util';
+
+export 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.stderr.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;
+}
+
+export function isGitRepository(path: string): boolean {
+    LOGGER.debug(`Check if the given directory is a git repo: ${path}`);
+    sh.cd(path);
+    return sh.exec('git rev-parse --is-inside-work-tree', getShellConfig()).stdout.trim().toLocaleLowerCase() === 'true';
+}
+
+export function hasGitChanges(path?: string): boolean {
+    LOGGER.debug(`Check if the directory has git changes:  ${asDebugArg(path)}`);
+    cdIfPresent(path);
+    return sh.exec('git status --porcelain').stdout.trim().length !== 0;
+}
+
+export function getLatestRelease(path?: string): string {
+    LOGGER.debug(`Retrieve latest release from repo:  ${asDebugArg(path)}`);
+    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 {
+    LOGGER.debug(`Retrieve latest tag from local repo :  ${asDebugArg(path)}`);
+    cdIfPresent(path);
+    return sh.exec('git describe --abbrev=0 --tags', getShellConfig()).stdout.trim();
+}
+
+export function hasBranch(branch: string, path?: string): boolean {
+    LOGGER.debug(`Check if branch exists:  ${asDebugArg(path)}`);
+    cdIfPresent(path);
+    return sh.exec(`git branch --list ${branch}`, getShellConfig()).stdout.trim().length !== 0;
+}
+
+export function getRemoteUrl(path?: string): string {
+    LOGGER.debug(`Retrieve remote git url for:  ${asDebugArg(path)}`);
+    cdIfPresent(path);
+    return sh.exec('git config --get remote.origin.url', getShellConfig()).stdout.trim();
+}
+
+function cdIfPresent(path?: string): void {
+    if (path) {
+        validateGitDirectory(path);
+        sh.cd(path);
+    }
+}
+
+function asDebugArg(path?: string): string {
+    return path ?? sh.pwd().stdout;
+}

package/src/util/logger.ts

@@ -0,0 +1,38 @@
+/********************************************************************************
+ * Copyright (c) 2022 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
+ ********************************************************************************/
+let verbose = false;
+
+export const LOGGER: Logger = {
+    info: (message, ...args) => console.info(`[INFO] ${message}`, ...args),
+    error: (message, ...args) => console.error(`[ERROR] ${message}`, ...args),
+    warn: (message, ...args) => console.warn(`[WARNING] ${message}`, ...args),
+    debug: (message, ...args) => {
+        if (verbose) {
+            console.log(`[DEBUG] ${message}`, ...args);
+        }
+    }
+};
+
+export function configureLogger(isVerbose: boolean): void {
+    verbose = isVerbose;
+}
+
+export interface Logger {
+    info(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    debug(message: string, ...args: any[]): void;
+}

package/src/util/validation-util.ts

@@ -0,0 +1,50 @@
+/********************************************************************************
+ * Copyright (c) 2022 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 { isGitRepository } from './git-util';
+import { LOGGER } from './logger';
+export const COMMAND_VERSION = '1.1.0-next';
+
+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 validateVersion(version: string): string {
+    LOGGER.debug(`Validate version format of: ${version}`);
+    if (!semver.valid(version)) {
+        throw new Error(`Not a valid version: ${version}`);
+    }
+    return version;
+}
+
+export function validateGitDirectory(repository: string): string {
+    const repoPath = validateDirectory(repository);
+    if (!isGitRepository(repoPath)) {
+        throw new Error('Not a valid git repository');
+    }
+    return repoPath;
+}