@eclipse-glsp/dev

Eclipse GLSP - All-in-one dev package

A meta package that includes all shared configuration packages Eclipse GLSP components. In addition, it also provides the GLSP CLI application.

The package is available via npm and can be used by all GLSP components implemented with Typescript.

Components

• @eclipse-glsp/config: Meta package for shared build configuration
  • @eclipse-glsp/ts-config: Shared Typescript configuration for GLSP projects
  • @eclipse-glsp/eslint-config: Shared ESLint configuration for GLSP projects
  • @eclipse-glsp/prettier-config: Shared Prettier configuration for GLSP projects
• @eclipse-glsp/config-test: Meta package for shared test configuration
  • @eclipse-glsp/mocha-config: Shared Mocha configuration for GLSP projects
  • @eclipse-glsp/nyc-config: Shared nyc configuration for GLSP projects
• @eclipse-glsp/cli: CLI Tooling & scripts for GLSP projects

Install

yarn add --dev @eclipse-glsp/dev

Usage

TSConfig

Create a tsconfig.json:

{
    "extends": "@eclipse-glsp/ts-config/tsconfig.json",
    "compilerOptions": {
        "rootDir": "src",
        "outDir": "lib"
    }
}

In addition, a custom configuration for projects that use mocha is available:

• @eclipse-glsp/ts-config/mocha

ESLint

Create a .eslintrc.js:

/** @type {import('eslint').Linter.Config} */
module.exports = {
    extends: '@eclipse-glsp',
    parserOptions: {
        tsconfigRootDir: __dirname,
        project: 'tsconfig.json'
    }
};

Prettier

Add to the package.json:

{
    // ...
    "prettier": "@eclipse-glsp/prettier-config"
}

Or add a .prettierrc to the workspace root:

"@eclipse-glsp/prettier-config"

Mocha

Create a .mocharc:

{
    "$schema": "https://json.schemastore.org/mocharc",
    "extends": "@eclipse-glsp/mocha-config"
}

Nyc

Add a .nycrc to your project root:

{
    "extends": "@eclipse-glsp/nyc-config"
}

Configuration can also be provided by nyc.config.js if programmed logic is required.

More information

For more information, please visit the Eclipse GLSP Umbrella repository and the Eclipse GLSP Website. If you have questions, please raise them in the discussions and have a look at our communication and support options.

Changelog

2.2.1 - 22/07/2024

Changes

• [cli] Contribute the generateIndex command to the GLSP CLI. Allows autogeneration of index files in GLSP projects. #1197
• [cli] Fix version updating of example servers in release CLI command. #1226
• [cli] Refactor and simplify checkHeader CLI command. Focus on end year copyright header validation and remove the error-prone validation of the start year. #1289
• [cli] Contribute the updateNext command to the GLSP CLI tool. Allows updating of all dependencies in GLSP projects that are tagged with `next´. 1229
• [ts-config] Update ts target to ES2019 #1372