@eclipse-glsp/dev 2.9.0-next.1 → 2.9.0-next.2

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.
Files changed (2) hide show
  1. package/README.md +31 -21
  2. package/package.json +11 -11
package/README.md CHANGED
@@ -9,8 +9,8 @@ The package is available via npm and can be used by all GLSP components implemen
9
9
 
10
10
  - [`@eclipse-glsp/config`](https://www.npmjs.com/package/@eclipse-glsp/config): Meta package for shared build configuration
11
11
  - [`@eclipse-glsp/ts-config`](https://www.npmjs.com/package/@eclipse-glsp/ts-config): Shared Typescript configuration for GLSP projects
12
- - [`@eclipse-glsp/eslint-config`](https://www.npmjs.com/package/@eclipse-glsp/esling-config): Shared ESLint configuration for GLSP projects
13
- - [`@eclipse-glsp/prettier-config`](https://www.npmjs.com/package/@eclipse-glsp/prettier-config): Shared Prettier configuration for GLSP projects
12
+ - [`@eclipse-glsp/oxlint-config`](https://www.npmjs.com/package/@eclipse-glsp/oxlint-config): Shared oxlint configuration for GLSP projects
13
+ - [`@eclipse-glsp/oxfmt-config`](https://www.npmjs.com/package/@eclipse-glsp/oxfmt-config): Shared oxfmt configuration for GLSP projects
14
14
  - [`@eclipse-glsp/config-test`](https://www.npmjs.com/package/@eclipse-glsp/config-test): Meta package for shared test configuration
15
15
  - [`@eclipse-glsp/mocha-config`](https://www.npmjs.com/package/@eclipse-glsp/mocha-config): Shared Mocha configuration for GLSP projects
16
16
  - [`@eclipse-glsp/nyc-config`](https://www.npmjs.com/package/@eclipse-glsp/nyc-config): Shared nyc configuration for GLSP projects
@@ -42,38 +42,48 @@ In addition, a custom configuration for projects that use `mocha` is available:
42
42
 
43
43
  - `@eclipse-glsp/ts-config/mocha`
44
44
 
45
- ### ESLint
45
+ ### oxlint
46
46
 
47
- **Create a `.eslintrc.js`**:
47
+ **Create an `oxlint.config.mts` at the workspace root**:
48
48
 
49
- ```javascript
50
- /** @type {import('eslint').Linter.Config} */
51
- module.exports = {
52
- extends: '@eclipse-glsp',
53
- parserOptions: {
54
- tsconfigRootDir: __dirname,
55
- project: 'tsconfig.json'
56
- }
57
- };
58
- ```
49
+ ```typescript
50
+ import glspConfig from '@eclipse-glsp/oxlint-config';
51
+ import { defineConfig } from 'oxlint';
59
52
 
60
- ### Prettier
53
+ export default defineConfig({
54
+ extends: [glspConfig],
55
+ // Enables the type-aware rules of the shared configuration (requires `oxlint-tsgolint`, a dependency of the config package)
56
+ options: { typeAware: true },
57
+ ignorePatterns: ['**/lib', '**/dist', '**/*.d.ts']
58
+ });
59
+ ```
61
60
 
62
- **Add to the `package.json`**:
61
+ Projects that prefer a JSON configuration can extend the shared rules by path in a `.oxlintrc.json`:
63
62
 
64
63
  ```json
65
64
  {
66
- // ...
67
- "prettier": "@eclipse-glsp/prettier-config"
65
+ "$schema": "./node_modules/oxlint/configuration_schema.json",
66
+ "extends": ["./node_modules/@eclipse-glsp/oxlint-config/oxlintrc.json"],
67
+ "options": { "typeAware": true }
68
68
  }
69
69
  ```
70
70
 
71
- **Or add a `.prettierrc` to the workspace root**:
71
+ ### oxfmt
72
72
 
73
- ```json
74
- "@eclipse-glsp/prettier-config"
73
+ **Create an `oxfmt.config.mts` at the workspace root**:
74
+
75
+ ```typescript
76
+ import shared from '@eclipse-glsp/oxfmt-config' with { type: 'json' };
77
+ import { defineConfig } from 'oxfmt';
78
+
79
+ export default defineConfig({
80
+ ...shared,
81
+ ignorePatterns: ['lib/', 'dist/']
82
+ });
75
83
  ```
76
84
 
85
+ Format with `oxfmt` and verify with `oxfmt --check`.
86
+
77
87
  ### Mocha
78
88
 
79
89
  **Create a `.mocharc`**:
package/package.json CHANGED
@@ -1,17 +1,13 @@
1
1
  {
2
2
  "name": "@eclipse-glsp/dev",
3
- "version": "2.9.0-next.1",
3
+ "version": "2.9.0-next.2",
4
4
  "description": "All-in-one meta package that provides the GLSP development and test configuration packages, as well as the GLSP CLI package",
5
5
  "keywords": [
6
- "eclipse",
7
- "config"
6
+ "config",
7
+ "eclipse"
8
8
  ],
9
9
  "homepage": "https://www.eclipse.org/glsp/",
10
10
  "bugs": "https://github.com/eclipse-glsp/glsp/issues",
11
- "repository": {
12
- "type": "git",
13
- "url": "https://github.com/eclipse-glsp/glsp.git"
14
- },
15
11
  "license": "(EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0)",
16
12
  "author": {
17
13
  "name": "Eclipse GLSP"
@@ -23,12 +19,16 @@
23
19
  "url": "https://projects.eclipse.org/projects/ecd.glsp"
24
20
  }
25
21
  ],
26
- "dependencies": {
27
- "@eclipse-glsp/config": "2.9.0-next.1",
28
- "@eclipse-glsp/cli": "2.9.0-next.1",
29
- "@eclipse-glsp/config-test": "2.9.0-next.1"
22
+ "repository": {
23
+ "type": "git",
24
+ "url": "https://github.com/eclipse-glsp/glsp-core.git"
30
25
  },
31
26
  "publishConfig": {
32
27
  "access": "public"
28
+ },
29
+ "dependencies": {
30
+ "@eclipse-glsp/cli": "2.9.0-next.2",
31
+ "@eclipse-glsp/config": "2.9.0-next.1",
32
+ "@eclipse-glsp/config-test": "2.9.0-next.1"
33
33
  }
34
34
  }