@eclipse-glsp/config

Eclipse GLSP - Shared configuration

Common shared configuration for Eclipse GLSP components that are implemented with Typescript. Provides a meta package that export common configuration objects for:

• Typescript (tsconfig.json)
• ESLint (.eslintrc)
• Prettier (.prettierrc).

The package is available via npm and is used by all GLSP components implemented with Typescript. ESLint and prettier are included as direct dependencies. In addition, common GLSP dev dependencies like lerna, typescript, rimraf, etc. are included.

Components

• @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

Install

yarn add --dev @eclipse-glsp/config

Usage

TSConfig

Create a tsconfig.json:

{
    "extends": "@eclipse-glsp/ts-config",
    "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 file to the workspace root:

"@eclipse-glsp/prettier-config"

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.