feat: format command (#41)

* feat: format command

* updates

* add playground

* add prettier config option

* updates

* update api docs

Author: kazupon

api.md

@@ -5,15 +5,20 @@
 - [Function](#function)
   - [annotate](#annotate)
   - [compile](#compile)
+  - [format](#format)
 - [TypeAlias](#typealias)
   - [AnnotateOptions](#annotateoptions)
+  - [FormatOptions](#formatoptions)
 - [Enum](#enum)
   - [AnnotateWarningCodes](#annotatewarningcodes)
   - [CompileErrorCodes](#compileerrorcodes)
 - [Interface](#interface)
   - [CompileOptions](#compileoptions)
   - [SFCParseError](#sfcparseerror)
+- [Variable](#variable)
+  - [DEFAULT_PRETTIER_OPTIONS](#default_prettier_options)
 - [Class](#class)
+  - [FormatLangNotFoundError](#formatlangnotfounderror)
   - [SFCAnnotateError](#sfcannotateerror)
 
 ## Function
@@ -64,6 +69,31 @@ declare function compile(source: string, output: string, options?: CompileOption
 
 This functoin is **asyncronous** function. If you want to get about error details, use the handler of [CompileOptions](#compileoptions) and [CompileErrorCodes](#compileerrorcodes)
 
+### format
+
+Format the Vue SFC block
+
+**Signature:**
+```typescript
+declare function format(source: string, filepath: string, options?: FormatOptions): string;
+```
+
+#### Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| source | string | The source code of the Vue SFC |
+| filepath | string | The file path of the Vue SFC |
+| options | FormatOptions | The [options](#formatoptions) of the format function |
+
+#### Returns
+
+ The formatted source code of the Vue SFC
+
+#### Remarks
+
+Currently, only i18n custom blocks supporting
+
 
 ## TypeAlias
 
@@ -81,6 +111,17 @@ declare type AnnotateOptions = {
 };
 ```
 
+### FormatOptions
+
+Format options of [format](#format) function
+
+**Signature:**
+```typescript
+declare type FormatOptions = {
+    prettier?: Options;
+};
+```
+
 
 ## Enum
 
@@ -214,8 +255,68 @@ filepath: string;
 
 
 
+## Variable
+
+### DEFAULT_PRETTIER_OPTIONS
+
+The default prettier options for formatting the content of `i18n` custom blocks
+
+**Signature:**
+```typescript
+DEFAULT_PRETTIER_OPTIONS: {
+    printWidth: number;
+    tabWidth: number;
+    jsonRecursiveSort: boolean;
+    plugins: string[];
+}
+```
+
+
 ## Class
 
+### FormatLangNotFoundError
+
+Fortmat lang fwnot found error
+
+**Signature:**
+```typescript
+declare class FormatLangNotFoundError extends Error 
+```
+
+### Remarks
+
+The error that not specified `lang` attribute in `i18n` custom block
+
+
+#### Constructor
+
+Constructor
+
+**Signature:**
+```typescript
+constructor(message: string, filepath: string);
+```
+
+*Parameters*
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| message | string | The error message |
+| filepath | string | The filepath of the target file at formatting processing |
+
+
+#### Properties
+
+##### filepath
+
+The filepath of the target file at formatting processing
+
+**Signature:**
+```typescript
+filepath: string;
+```
+
+
 ### SFCAnnotateError
 
 The Annocation error

locales/en.json

@@ -1,5 +1,6 @@
 {
   "Usage: $0 <command> [options]": "Usage: $0 <command> [options]",
+  "dry run mode": "dry run mode",
   "compile the i18n resources": "compile the i18n resources",
   "the i18n resource source path": "the i18n resource source path",
   "the compiled i18n resource output path": "the compiled i18n resource output path",
@@ -16,7 +17,6 @@
   "the attributes to annotate": "the attributes to annotate",
   "'--type' is not supported except for 'custom-block'": "'--type' is not supported except for 'custom-block'",
   "if you don't specify some files at the end of the command, the '—-source' option is required": "if you don't specify some files at the end of the command, the '—-source' option is required",
-  "there is a parse error in {filename}": "there is a parse error in {filename}",
   "Unsupported '{type}' block content type: {actual}": "Unsupported '{type}' block content type: {actual}",
   "Detected lang mismatch in block `src` ('{src}') and block content ('{content}')": "Detected lang mismatch in block `src` ('{src}') and block content ('{content}')",
   "Detected lang mismatch in `lang` option ('{lang}') and block content ('{content}')": "Detected lang mismatch in `lang` option ('{lang}') and block content ('{content}')",
@@ -27,5 +27,16 @@
   "{count} warnings": "{count} warnings",
   "{count} forces": "{count} forces",
   "{count} ignores": "{count} ignores",
-  "{count} errors": "{count} errors"
+  "{count} errors": "{count} errors",
+  "`lang` attr not found": "`lang` attr not found",
+  "format for single-file components": "format for single-file components",
+  "the format type": "the format type",
+  "the config file path of prettier": "the config file path of prettier",
+  "target files without formatting": "target files without formatting",
+  "formatted": "formatted",
+  "no change": "no change",
+  "{count} formattable files": "{count} formattable files",
+  "{count} formatted files": "{count} formatted files",
+  "{count} no change files": "{count} no change files",
+  "{count} error files": "{count} error files"
 }

package.json

@@ -32,11 +32,14 @@
     "@intlify/shared": "^9.1.9",
     "@vue/compiler-sfc": "^3.2.20",
     "chalk": "^4.1.0",
+    "cosmiconfig": "^7.0.1",
     "debug": "^4.3.2",
     "diff": "^5.0.0",
     "fast-glob": "^3.2.7",
     "jsonc-eslint-parser": "^1.4.1",
     "pathe": "^0.2.0",
+    "prettier": "^2.4.1",
+    "prettier-plugin-sort-json": "^0.0.2",
     "yaml-eslint-parser": "^0.4.1",
     "yargs": "^17.2.0"
   },
@@ -52,6 +55,7 @@
     "@types/glob": "^7.1.3",
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.10.3",
+    "@types/prettier": "^2.4.1",
     "@types/sinon": "^10.0.4",
     "@types/yargs": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
@@ -67,7 +71,6 @@
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "opener": "^1.5.1",
-    "prettier": "^2.3.2",
     "secretlint": "^3.3.0",
     "shipjs": "^0.24.0",
     "sinon": "^11.1.2",

playground/format/BasicFormat.vue

@@ -0,0 +1,26 @@
+<template>
+  <p>This is BasicFormat</p>
+</template>
+
+<script>
+export default {
+  name: 'BasicFormat'
+}
+</script>
+
+<style scoped>
+#app {
+  color: red;
+}
+</style>
+
+<i18n lang="json">
+{
+  "en": {
+    "title": "The application"
+  },
+  "ja": {
+    "title": "アプリケーション"
+  }
+}
+</i18n>

playground/format/HasNested.vue

@@ -0,0 +1,44 @@
+<template>
+  <p>This is Nested resources</p>
+</template>
+
+<script>
+export default {
+  name: 'App'
+}
+</script>
+
+<i18n lang="json" global>
+{
+  "en": {
+    "title": "The application",
+    "menu": {
+      "sub2": "this is sub2 placeholder",
+      "sub1": {
+        "menu1": "menu 1",
+        "menu2": {
+          "menu2": "this is sub menu2",
+          "menu1": "this is sub menu1",
+          "1menu": "this is sub 1menu"
+        }
+      },
+      "sub3": "this is sub3 placeholder",
+      "sub4": {
+        "menu10": "menu 10",
+        "menu1": {
+          "menu1": "this is sub menu1",
+          "menu2": "this is sub menu2"
+        },
+        "0menu": "this is sub 0menu"
+      }
+    },
+    "footer": "this is footer placeholder"
+  }
+}
+</i18n>
+
+<style scoped>
+#app {
+  color: red;
+}
+</style>

playground/format/MultiFormat.vue

@@ -0,0 +1,39 @@
+<template>
+  <p>This is MultiFormat</p>
+</template>
+
+<i18n lang="json">
+{
+  "en": {
+    "title": "The application"
+  },
+  "ja": {
+    "title": "アプリケーション"
+  }
+}
+</i18n>
+
+<script>
+export default {
+  name: 'MultiFormat'
+}
+</script>
+
+<i18n lang="yaml">
+  en:
+    login: "login"
+  ja:
+    login: "ログイン"
+</i18n>
+
+<style scoped>
+#app {
+  color: red;
+}
+</style>
+
+<i18n lang="json5">{en:
+     { login: "login" },
+  ja: {
+    login: "ログイン" }}
+</i18n>

playground/format/Oneline.vue

@@ -0,0 +1,13 @@
+<template>
+  <p>This is Oneline</p>
+</template>
+
+<script>
+export default { name: 'App' }
+</script>
+
+<style scoped>
+#app { color: red; }
+</style>
+
+<i18n lang="json">{ "en": { "title": "The application" } }</i18n>