@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.0.0 - 13/10/2023

Changes

• [config] Update all dependencies & peerDependencies of the dev to the latest version #1136

• [protocol] Removed Protocol.MD file. #892

  • The protocol documentation is now maintained on https://eclipse.dev/glsp/documentation/protocol/

• [eslint-config] Tweaked chai-friendly/no-unused expression rule to enable allowTenary and allowShortCircuit options. #936

• [config] Introduce all-in-one @eclipse-glsp/dev meta package. #842

• [cli] Contribute the checkHeaders command to validate the copyright year (range) of license headers. #834

• [config] Introduce @eclipse-glsp/nyc-config package and the @eclipse-glsp/config-test meta package. #755

  • Contribute the coverageReport command to create a full nyc test coverage report for a lerna/yarn mono repository

• [cli] Introduce @eclipse-glsp/cli package to offer CLI tooling & utility scripts for GLSP projects. #755 - Contributed on behalf of STMicroelectronics

  • Contribute the release command to prepare & publish a new Github release for a specific GLSP component

• [deps] Updates dependencies of @eclipse-glsp/config and @eclipse-glsp/config-test packages to the latest version #1023

Breaking Changes

• [node] Update minimum requirements for Node to >=16.11.0 #829
• [config] Typescript is now a peerDependency, a concrete matching Typscript depdendency has to be provided by consuming projects#1023