Merge branch 'main' into dependabot/npm_and_yarn/npm_and_yarn-e04d5d616f

Author: SunsetTechuila

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.18.0
+
+- **Feat:** support `charset`
+
 ## 0.17.4
 
 - **Fix:** indentation shifting on focus

README.md

@@ -43,10 +43,7 @@ for more information on the multiple ways of installing VSCode extensions.
 - `end_of_line` (on save)
 - `insert_final_newline` (on save)
 - `trim_trailing_whitespace` (on save)
-
-## On the backlog
-
-- `charset`
+- `charset` (on open/after save)
 
 ## How it works
 

package-lock.json

@@ -3,10 +3,10 @@
   "displayName": "EditorConfig",
   "description": "EditorConfig Support for Visual Studio Code",
   "publisher": "EditorConfig",
-  "version": "0.17.4",
+  "version": "0.18.0",
   "icon": "EditorConfig_icon.png",
   "engines": {
-    "vscode": "^1.98.0"
+    "vscode": "^1.100.0"
   },
   "author": "EditorConfig Team",
   "license": "MIT",
@@ -114,7 +114,7 @@
   "devDependencies": {
     "@types/mocha": "^10.0.10",
     "@types/node": "^20.19.0",
-    "@types/vscode": "~1.98.0",
+    "@types/vscode": "~1.100.0",
     "@typescript-eslint/eslint-plugin": "^8.34.0",
     "@typescript-eslint/parser": "^8.34.0",
     "@vscode/test-electron": "^2.5.2",

package.json

@@ -8,20 +8,31 @@ import {
 	window,
 	workspace,
 } from 'vscode'
+import { KnownProps } from 'editorconfig'
+
 import {
 	InsertFinalNewline,
 	PreSaveTransformation,
 	SetEndOfLine,
 	TrimTrailingWhitespace,
 } from './transformations'
-
 import {
 	applyTextEditorOptions,
 	resolveCoreConfig,
 	resolveFile,
 	resolveTextEditorOptions,
 } from './api'
 
+type Charset = Exclude<KnownProps['charset'], undefined | 'unset'>
+type EncodingMap = Record<Charset, TextDocument['encoding']>
+const encodingMap = {
+	'utf-8': 'utf8',
+	'utf-8-bom': 'utf8bom',
+	'utf-16le': 'utf16le',
+	'utf-16be': 'utf16be',
+	latin1: 'iso88591',
+} as const satisfies EncodingMap
+
 export default class DocumentWatcher {
 	private disposable: Disposable
 	private preSaveTransformations: PreSaveTransformation[] = [
@@ -65,6 +76,8 @@ export default class DocumentWatcher {
 				if (path.basename(doc.fileName) === '.editorconfig') {
 					this.log('.editorconfig file saved.')
 				}
+				// in case document was dirty on open/text editor change
+				this.handleDocumentEncoding(doc)
 			}),
 		)
 
@@ -78,6 +91,10 @@ export default class DocumentWatcher {
 			}),
 		)
 
+		subscriptions.push(
+			workspace.onDidOpenTextDocument(this.handleDocumentEncoding),
+		)
+
 		this.disposable = Disposable.from.apply(this, subscriptions)
 		this.log('Document watcher initialized')
 	}
@@ -156,6 +173,39 @@ export default class DocumentWatcher {
 				onNoActiveTextEditor: this.onNoActiveTextEditor,
 				onSuccess: this.onSuccess,
 			})
+			this.handleDocumentEncoding(editor.document)
 		}
 	}
+
+	private async handleDocumentEncoding(document: TextDocument) {
+		const relativePath = workspace.asRelativePath(document.fileName)
+		const editorconfigSettings = await resolveCoreConfig(document, {
+			onBeforeResolve: this.onBeforeResolve,
+		})
+
+		const { charset } = editorconfigSettings
+		this.log(`${relativePath}: Target charset is`, charset ?? 'not set')
+		if (!charset) {
+			return
+		}
+		if (!(charset in encodingMap)) {
+			this.log(`${relativePath}: Unsupported charset`)
+			return
+		}
+
+		const targetEncoding = encodingMap[charset as keyof typeof encodingMap]
+		if (targetEncoding === document.encoding) {
+			return
+		}
+
+		if (document.isDirty) {
+			this.log(`${relativePath}: Cannot change encoding, document is dirty`)
+			return
+		}
+
+		this.log(`${relativePath}: Re-opening document with ${targetEncoding} encoding...`)
+		await workspace.openTextDocument(document.uri, {
+			encoding: targetEncoding,
+		})
+	}
 }

src/DocumentWatcher.ts

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+charset = latin1

src/test/suite/fixtures/charset/latin1/.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+charset = unset

src/test/suite/fixtures/charset/unset/.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+charset = utf-16be

src/test/suite/fixtures/charset/utf-16be/.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+charset = utf-16le

src/test/suite/fixtures/charset/utf-16le/.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+charset = utf-8-bom