@eclipse-glsp/config 0.9.0-next.a3910f6a → 0.9.0-next.a9855b44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -0
- package/package.json +4 -4
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Eclipse GLSP - Shared configuration [](https://ci.eclipse.org/glsp/job/eclipse-glsp/job/glsp-client/job/master) [](https://ci.eclipse.org/glsp/job/deploy-npm-glsp-config/)
|
|
2
|
+
|
|
3
|
+
Common shared configuration for Eclipse GLSP components that are implemented with Typescript. Provides a meta package that export common configuration objects for:
|
|
4
|
+
|
|
5
|
+
- [Typescript](https://www.typescriptlang.org/) (`tsconfig.json`)
|
|
6
|
+
- [ESLint](https://eslint.org/) (`.eslintrc`)
|
|
7
|
+
- [Prettier](https://prettier.io/) (`.prettierc`).
|
|
8
|
+
|
|
9
|
+
The package is available via npm and are used by all GLSP components implemented with Typescript. ESLint and prettier are included as direct dependencies.
|
|
10
|
+
|
|
11
|
+
## Components
|
|
12
|
+
|
|
13
|
+
- `@eclipse-glsp/ts-config`: Shared Typescript configuration for GLSP projects
|
|
14
|
+
- `@eclipse-glsp/eslint-config`: Shared ESLint configuration for GLSP projects
|
|
15
|
+
- `@eclipse-glsp/prettier-config`: Shared Prettier configuration for GLSP projects
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
$ yarn add --dev @eclipse-glsp/config
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
### TSConfig
|
|
26
|
+
|
|
27
|
+
**Create a `tsconfig.json`**:
|
|
28
|
+
|
|
29
|
+
```jsonc
|
|
30
|
+
{
|
|
31
|
+
"extends": "@eclipse-glsp/ts-config/tsconfig.json",
|
|
32
|
+
"compilerOptions": {
|
|
33
|
+
"rootDir": "src",
|
|
34
|
+
"outDir": "lib"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### ESLint
|
|
40
|
+
|
|
41
|
+
**Create a `.eslintrc.js`**:
|
|
42
|
+
|
|
43
|
+
```javascript
|
|
44
|
+
/** @type {import('eslint').Linter.Config} */
|
|
45
|
+
module.exports = {
|
|
46
|
+
extends: '@eclipse-glsp',
|
|
47
|
+
parserOptions: {
|
|
48
|
+
tsconfigRootDir: __dirname,
|
|
49
|
+
project: 'tsconfig.json'
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Prettier
|
|
55
|
+
|
|
56
|
+
**Add to the `package.json`**:
|
|
57
|
+
|
|
58
|
+
```jsonc
|
|
59
|
+
{
|
|
60
|
+
// ...
|
|
61
|
+
"prettier": "@eclipse-glsp/prettier-config"
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**Or add a `.prettierrc.json` to the workspace root**:
|
|
66
|
+
|
|
67
|
+
```jsonc
|
|
68
|
+
"@eclipse-glsp/prettier-config"
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## More information
|
|
72
|
+
|
|
73
|
+
For more information, please visit the [Eclipse GLSP Umbrella repository](https://github.com/eclipse-glsp/glsp) and the [Eclipse GLSP Website](https://www.eclipse.org/glsp/). If you have questions, please raise them in the [discussions](https://github.com/eclipse-glsp/glsp/discussions) and have a look at our [communication and support options](https://www.eclipse.org/glsp/contact/).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eclipse-glsp/config",
|
|
3
|
-
"version": "0.9.0-next.
|
|
3
|
+
"version": "0.9.0-next.a9855b44",
|
|
4
4
|
"description": "Wrapper package that provides Typescript, ESLint and prettier configurations for GLSP projects",
|
|
5
5
|
"license": "(EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0)",
|
|
6
6
|
"keywords": [
|
|
@@ -27,9 +27,9 @@
|
|
|
27
27
|
"access": "public"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@eclipse-glsp/eslint-config": "0.9.0-next.
|
|
31
|
-
"@eclipse-glsp/prettier-config": "0.9.0-next.
|
|
32
|
-
"@eclipse-glsp/ts-config": "0.9.0-next.
|
|
30
|
+
"@eclipse-glsp/eslint-config": "0.9.0-next.a9855b44",
|
|
31
|
+
"@eclipse-glsp/prettier-config": "0.9.0-next.a9855b44",
|
|
32
|
+
"@eclipse-glsp/ts-config": "0.9.0-next.a9855b44",
|
|
33
33
|
"prettier": "^2.4.1"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|