Rule text-encoding-identifier-case: Change utf8 canonical to utf-8

docs/rules/no-array-callback-reference.md

@@ -179,7 +179,7 @@ array.forEach(function (element) {
 
 ```js
 function readFile(filename) {
-	return fs.readFile(filename, 'utf8');
+	return fs.readFile(filename, 'utf-8');
 }
 
 Promise.map(filenames, readFile);

docs/rules/prefer-json-parse-buffer.md

@@ -14,11 +14,11 @@ Passing in a buffer may not be performant and is not compatible with TypeScript.
 ## Fail
 
 ```js
-const packageJson = JSON.parse(await fs.readFile('./package.json', 'utf8'));
+const packageJson = JSON.parse(await fs.readFile('./package.json', 'utf-8'));
 ```
 
 ```js
-const promise = fs.readFile('./package.json', {encoding: 'utf8'});
+const promise = fs.readFile('./package.json', {encoding: 'utf-8'});
 const packageJson = JSON.parse(await promise);
 ```
 
@@ -29,7 +29,7 @@ const packageJson = JSON.parse(await fs.readFile('./package.json'));
 ```
 
 ```js
-const promise = fs.readFile('./package.json', {encoding: 'utf8', signal});
+const promise = fs.readFile('./package.json', {encoding: 'utf-8', signal});
 const packageJson = JSON.parse(await promise);
 ```
 

docs/rules/prefer-module.md

@@ -85,7 +85,7 @@ const file = path.join(__dirname, 'foo.js');
 ```
 
 ```js
-const content = fs.readFileSync(__filename, 'utf8');
+const content = fs.readFileSync(__filename, 'utf-8');
 ```
 
 ```js

docs/rules/text-encoding-identifier-case.md

@@ -7,7 +7,7 @@
 <!-- end auto-generated rule header -->
 <!-- Do not manually modify this header. Run: `npm run fix:eslint-docs` -->
 
-- Enforce `'utf8'` for [UTF-8](https://en.wikipedia.org/wiki/UTF-8) encoding.
+- Enforce `'utf-8'` for [UTF-8](https://en.wikipedia.org/wiki/UTF-8) encoding.
 - Enforce `'ascii'` for [ASCII](https://en.wikipedia.org/wiki/ASCII) encoding.
 
 This rule only auto-fix encoding in `fs.readFile()` and `fs.readFileSync()`.
@@ -23,19 +23,23 @@ await fs.readFile(file, 'ASCII');
 ```
 
 ```js
-const string = buffer.toString('utf-8');
+const string = buffer.toString('utf8');
+```
+
+```js
+const string = buffer.toString('UTF8');
 ```
 
 ## Pass
 
 ```js
-await fs.readFile(file, 'utf8');
+await fs.readFile(file, 'utf-8');
 ```
 
 ```js
 await fs.readFile(file, 'ascii');
 ```
 
 ```js
-const string = buffer.toString('utf8');
+const string = buffer.toString('utf-8');
 ```

rules/text-encoding-identifier-case.js

@@ -10,9 +10,9 @@ const messages = {
 const getReplacement = encoding => {
 	switch (encoding.toLowerCase()) {
 		// eslint-disable-next-line unicorn/text-encoding-identifier-case
-		case 'utf-8':
-		case 'utf8': {
-			return 'utf8';
+		case 'utf8':
+		case 'utf-8': {
+			return 'utf-8';
 		}
 
 		case 'ascii': {
@@ -41,21 +41,6 @@ const create = () => ({
 			return;
 		}
 
-		if (
-			// eslint-disable-next-line unicorn/text-encoding-identifier-case
-			node.value === 'utf-8'
-			&& node.parent.type === 'JSXAttribute'
-			&& node.parent.value === node
-			&& node.parent.name.type === 'JSXIdentifier'
-			&& node.parent.name.name.toLowerCase() === 'charset'
-			&& node.parent.parent.type === 'JSXOpeningElement'
-			&& node.parent.parent.attributes.includes(node.parent)
-			&& node.parent.parent.name.type === 'JSXIdentifier'
-			&& node.parent.parent.name.name.toLowerCase() === 'meta'
-		) {
-			return;
-		}
-
 		const {raw} = node;
 		const value = raw.slice(1, -1);
 

scripts/create-rule.js

@@ -29,7 +29,7 @@ function checkFiles(ruleId) {
 function renderTemplate({source, target, data}) {
 	const templateFile = path.join(dirname, `template/${source}`);
 	const targetFile = path.join(ROOT, target);
-	const templateContent = fs.readFileSync(templateFile, 'utf8');
+	const templateContent = fs.readFileSync(templateFile, 'utf-8');
 
 	const compiled = template(templateContent);
 	const content = compiled(data);

scripts/rename-rule.js

@@ -52,7 +52,7 @@ async function renameRule(from, to) {
 		}
 
 		// eslint-disable-next-line no-await-in-loop
-		let text = await fsAsync.readFile(file, 'utf8');
+		let text = await fsAsync.readFile(file, 'utf-8');
 		text = text.replaceAll(from, to);
 		// eslint-disable-next-line no-await-in-loop
 		await fsAsync.writeFile(file, text);

test/integration/run-eslint.js

@@ -109,7 +109,7 @@ function getBabelParserConfig(project) {
 async function runEslint(project) {
 	const eslintIgnoreFile = path.join(project.location, '.eslintignore');
 	const ignore = fs.existsSync(eslintIgnoreFile)
-		? fs.readFileSync(eslintIgnoreFile, 'utf8').split('\n').filter(line => line && !line.startsWith('#'))
+		? fs.readFileSync(eslintIgnoreFile, 'utf-8').split('\n').filter(line => line && !line.startsWith('#'))
 		: [];
 
 	const eslint = new ESLint({

test/integration/test.js

@@ -15,7 +15,7 @@ import runEslint from './run-eslint.js';
 
 if (isCI) {
 	const CI_CONFIG_FILE = new URL('../../.github/workflows/main.yml', import.meta.url);
-	const content = fs.readFileSync(CI_CONFIG_FILE, 'utf8');
+	const content = fs.readFileSync(CI_CONFIG_FILE, 'utf-8');
 	const config = YAML.parse(content).jobs.integration.strategy.matrix.group;
 
 	const expected = [...new Set(allProjects.map(project => String(project.group + 1)))];

test/package.js

@@ -108,7 +108,7 @@ test('Every rule has valid meta.type', t => {
 });
 
 test('Every deprecated rules listed in docs/deprecated-rules.md', async t => {
-	const content = await fsAsync.readFile('docs/deprecated-rules.md', 'utf8');
+	const content = await fsAsync.readFile('docs/deprecated-rules.md', 'utf-8');
 	const rulesInMarkdown = new Set(content.match(/(?<=^## ).*?$/gm));
 
 	for (const name of deprecatedRules) {
@@ -125,7 +125,7 @@ test('Every rule file has the appropriate contents', t => {
 	for (const ruleFile of ruleFiles) {
 		const ruleName = path.basename(ruleFile, '.js');
 		const rulePath = path.join('rules', `${ruleName}.js`);
-		const ruleContents = fs.readFileSync(rulePath, 'utf8');
+		const ruleContents = fs.readFileSync(rulePath, 'utf-8');
 
 		t.true(ruleContents.includes('/** @type {import(\'eslint\').Rule.RuleModule} */'), `${ruleName} includes jsdoc comment for rule type`);
 	}
@@ -140,7 +140,7 @@ test('Every rule has a doc with the appropriate content', t => {
 		}
 
 		/// const documentPath = path.join('docs/rules', `${ruleName}.md`);
-		/// const documentContents = fs.readFileSync(documentPath, 'utf8');
+		/// const documentContents = fs.readFileSync(documentPath, 'utf-8');
 
 		// TODO: Disabled until https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2530 is done.
 		// Check for examples.