.changeset/modern-apricots-flash.md

@@ -0,0 +1,5 @@
+---
+'@intlify/eslint-plugin-vue-i18n': minor
+---
+
+add lowercase option to key-format-style rule

.changeset/pre.json

@@ -8,6 +8,7 @@
     "forty-tools-dream",
     "fresh-squids-build",
     "khaki-eyes-serve",
+    "modern-apricots-flash",
     "ninety-snakes-scream",
     "olive-chairs-invent",
     "pink-hairs-fail",

.eslintrc.cjs

@@ -59,7 +59,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['*.ts'],
+      files: ['*.ts', '*.mts'],
       extends: ['plugin:@typescript-eslint/recommended'],
       parser: 'vue-eslint-parser',
       parserOptions: {

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @intlify/eslint-plugin-vue-i18n
 
+## 3.0.0-next.9
+
+### Minor Changes
+
+- [#492](https://github.com/intlify/eslint-plugin-vue-i18n/pull/492) [`30ad848`](https://github.com/intlify/eslint-plugin-vue-i18n/commit/30ad84859d21d12b9882c3d03dd411360e804bea) Thanks [@oikalyptus](https://github.com/oikalyptus)! - add lowercase option to key-format-style rule
+
 ## 3.0.0-next.8
 
 ### Minor Changes

docs/.vitepress/config.mts

@@ -0,0 +1,70 @@
+import { defineConfig } from 'vitepress'
+import { getRulesWithCategories } from '../../scripts/lib/rules'
+import '../../scripts/update-rule-docs'
+import '../../scripts/update-index-docs'
+
+// https://vitepress.dev/reference/site-config
+export default async () => {
+  const rules = await getRulesWithCategories()
+  return defineConfig({
+    base: '/',
+    title: 'eslint-plugin-vue-i18n',
+    description: 'ESLint plugin for Vue I18n',
+    head: [['meta', { name: 'theme-color', content: '#3eaf7c' }]],
+    lastUpdated: true,
+    themeConfig: {
+      editLink: {
+        pattern:
+          'https://github.com/intlify/eslint-plugin-vue-i18n/edit/master/docs/:path',
+        text: 'Edit this page on GitHub'
+      },
+      nav: [
+        {
+          text: 'Support Intlify',
+          items: [
+            {
+              text: 'GitHub Sponsors',
+              link: 'https://github.com/sponsors/kazupon'
+            },
+            {
+              text: 'Patreon',
+              link: 'https://www.patreon.com/kazupon'
+            }
+          ]
+        },
+        {
+          text: 'Release Notes',
+          link: 'https://github.com/intlify/eslint-plugin-vue-i18n/releases'
+        }
+      ],
+      sidebar: [
+        {
+          text: 'Introduction',
+          link: '/intro'
+        },
+        {
+          text: 'Getting Started',
+          link: '/started'
+        },
+        {
+          text: 'Available Rules',
+          link: '/rules/'
+        },
+        ...rules.map(({ category, rules }) => ({
+          text: `Rules in ${category}`,
+          collapsed: false,
+          items: rules.map(rule => ({
+            text: rule.name,
+            link: `/rules/${rule.name}`
+          }))
+        }))
+      ],
+      socialLinks: [
+        {
+          icon: 'github',
+          link: 'https://github.com/intlify/eslint-plugin-vue-i18n'
+        }
+      ]
+    }
+  })
+}

docs/rules/key-format-style.md

@@ -13,6 +13,7 @@ This rule aims to enforces specific casing for localization key names.
 ```yaml
 camelCaseKey: The key for this value is camel case.
 kebab-case-key: The key for this value is kebab case.
+lowercase: The key for this value is lower case.
 snake_case_key: The key for this value is snake case.
 mixed_Case-key: Perhaps you don't want to use this casing.
 ```
@@ -47,7 +48,7 @@ Also, the following localization key definitions are reported as errors, because
 {
   "@intlify/vue-i18n/key-format-style": [
     "error",
-    "camelCase" | "kebab-case" | "snake_case",
+    "camelCase" | "kebab-case" | "lowercase" | "snake_case",
     {
       "allowArray": false,
       "splitByDots": false
@@ -114,6 +115,34 @@ app_title: I18N Management System
 
 </eslint-code-block>
 
+:+1: Examples of **correct** code for this rule with `"lowercase"`:
+
+<eslint-code-block language="yaml">
+
+```yaml
+# eslint @intlify/vue-i18n/key-format-style: ['error', 'lowercase']
+
+# ✓ GOOD
+apptitle: I18N Management System
+```
+
+</eslint-code-block>
+
+:-1: Examples of **incorrect** code for this rule with `"lowercase"`:
+
+<eslint-code-block language="yaml">
+
+```yaml
+# eslint @intlify/vue-i18n/key-format-style: ['error', 'lowercase']
+
+# ✗ BAD
+appTitle: I18N Management System
+app_title: I18N Management System
+APP_TITLE: I18N Management System
+```
+
+</eslint-code-block>
+
 :+1: Examples of **correct** code for this rule with `"snake_case"`:
 
 <eslint-code-block language="yaml">

lib/rules/key-format-style.ts

@@ -16,6 +16,7 @@ const debug = debugBuilder('eslint-plugin-vue-i18n:key-format-style')
 const allowedCaseOptions = [
   'camelCase',
   'kebab-case',
+  'lowercase',
   'snake_case',
   'SCREAMING_SNAKE_CASE'
 ] as const

lib/utils/casing.ts

@@ -75,6 +75,20 @@ export function isCamelCase(str: string): boolean {
   return true
 }
 
+/**
+ * Checks whether the given string is lowercase.
+ */
+export function isLowerCase(str: string): boolean {
+  if (
+    hasSymbols(str) ||
+    hasUpper(str) ||
+    /-|_|\s/u.exec(str) // kebab or snake or space
+  ) {
+    return false
+  }
+  return true
+}
+
 /**
  * Checks whether the given string is PascalCase.
  */
@@ -104,6 +118,7 @@ const checkersMap = {
   'kebab-case': isKebabCase,
   snake_case: isSnakeCase,
   camelCase: isCamelCase,
+  lowercase: isLowerCase,
   PascalCase: isPascalCase,
   SCREAMING_SNAKE_CASE: isScreamingSnakeCase
 }
@@ -127,6 +142,7 @@ export function pascalCase(str: string): string {
 export const allowedCaseOptions = [
   'camelCase',
   'kebab-case',
+  'lowercase',
   'PascalCase',
   'snake_case',
   'SCREAMING_SNAKE_CASE'

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intlify/eslint-plugin-vue-i18n",
   "description": "ESLint plugin for Vue I18n",
-  "version": "3.0.0-next.8",
+  "version": "3.0.0-next.9",
   "license": "MIT",
   "homepage": "https://github.com/intlify/eslint-plugin-vue-i18n#readme",
   "keywords": [
@@ -29,7 +29,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "packageManager": "pnpm@8.15.5",
+  "packageManager": "pnpm@8.15.6",
   "type": "commonjs",
   "files": [
     "dist"
@@ -115,7 +115,7 @@
     "path-scurry": "^1.10.1",
     "prettier": "^2.8.8",
     "typescript": "^5.1.6",
-    "vitepress": "1.0.0-beta.7",
+    "vitepress": "^1.0.2",
     "vue-eslint-editor": "^1.1.0",
     "vue-github-button": "^3.1.0"
   },