fix(vscode)!: use .oxlintrc.json as default value for oxc.configPath (#7442)

Sysix · web-flow · commit b04041d1cf42 · 2024-11-24T12:32:44.000+08:00
**BREAKING CHANGE**: VSCode-Client does not watch for `eslint`
configuration files. Default value for `oxc.configPath` is now
`.oxlintrc.json` instead of `.eslintrc`
diff --git a/editors/vscode/client/Config.ts b/editors/vscode/client/Config.ts
@@ -19,7 +19,7 @@ export class Config implements ConfigInterface {
     this._runTrigger = conf.get<Trigger>('lint.run') || 'onType';
     this._enable = conf.get<boolean>('enable') ?? true;
     this._trace = conf.get<TraceLevel>('trace.server') || 'off';
-    this._configPath = conf.get<string>('configPath') || '.eslintrc';
+    this._configPath = conf.get<string>('configPath') || '.oxlintrc.json';
     this._binPath = conf.get<string>('path.server');
   }
 
@@ -124,7 +124,7 @@ interface ConfigInterface {
    *
    * `oxc.configPath`
    *
-   * @default ".eslintrc"
+   * @default ".oxlintrc.json"
    */
   configPath: string;
   /**
diff --git a/editors/vscode/client/config.spec.ts b/editors/vscode/client/config.spec.ts
@@ -16,7 +16,7 @@ suite('Config', () => {
     strictEqual(config.runTrigger, 'onType');
     strictEqual(config.enable, true);
     strictEqual(config.trace, 'off');
-    strictEqual(config.configPath, '.eslintrc');
+    strictEqual(config.configPath, '.oxlintrc.json');
     strictEqual(config.binPath, '');
   });
 
diff --git a/editors/vscode/client/extension.ts b/editors/vscode/client/extension.ts
@@ -142,8 +142,7 @@ export async function activate(context: ExtensionContext) {
     synchronize: {
       // Notify the server about file config changes in the workspace
       fileEvents: [
-        workspace.createFileSystemWatcher('**/.eslintr{c,c.json}'),
-        workspace.createFileSystemWatcher('**/.oxlint{.json,rc.json,rc}'),
+        workspace.createFileSystemWatcher('**/.oxlint{.json,rc.json}'),
         workspace.createFileSystemWatcher('**/oxlint{.json,rc.json}'),
       ],
     },
diff --git a/editors/vscode/package.json b/editors/vscode/package.json
@@ -92,7 +92,7 @@
         "oxc.configPath": {
           "type": "string",
           "scope": "window",
-          "default": ".eslintrc",
+          "default": ".oxlintrc.json",
           "description": "Path to ESlint configuration."
         },
         "oxc.path.server": {
@@ -108,8 +108,7 @@
           "oxlintrc.json",
           "oxlint.json",
           ".oxlintrc.json",
-          ".oxlint.json",
-          ".oxlintrc"
+          ".oxlint.json"
         ],
         "url": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json"
       }
@@ -121,8 +120,7 @@
           "oxlintrc.json",
           "oxlint.json",
           ".oxlintrc.json",
-          ".oxlint.json",
-          ".oxlintrc"
+          ".oxlint.json"
         ]
       }
     ]

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export class Config implements ConfigInterface {`
`19`	`19`	`this._runTrigger = conf.get<Trigger>('lint.run') \|\| 'onType';`
`20`	`20`	`this._enable = conf.get<boolean>('enable') ?? true;`
`21`	`21`	`this._trace = conf.get<TraceLevel>('trace.server') \|\| 'off';`
`22`		`- this._configPath = conf.get<string>('configPath') \|\| '.eslintrc';`
	`22`	`+ this._configPath = conf.get<string>('configPath') \|\| '.oxlintrc.json';`
`23`	`23`	`this._binPath = conf.get<string>('path.server');`
`24`	`24`	`}`
`25`	`25`
`@@ -124,7 +124,7 @@ interface ConfigInterface {`
`124`	`124`	`*`
`125`	`125`	* `oxc.configPath`
`126`	`126`	`*`
`127`		`- * @default ".eslintrc"`
	`127`	`+ * @default ".oxlintrc.json"`
`128`	`128`	`*/`
`129`	`129`	`configPath: string;`
`130`	`130`	`/**`