summaryrefslogtreecommitdiff
path: root/prettier/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'prettier/README.md')
-rw-r--r--prettier/README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/prettier/README.md b/prettier/README.md
new file mode 100644
index 000000000..7ec9b7355
--- /dev/null
+++ b/prettier/README.md
@@ -0,0 +1,39 @@
+# prettier
+
+Prettier APIs and tools for deno
+
+## Use as a CLI
+
+To formats the source files, run:
+
+```console
+deno --allow-run --allow-write https://deno.land/x/std/prettier/main.ts
+```
+
+You can format only specific files by passing the arguments.
+
+```console
+deno --allow-run --allow-write https://deno.land/x/std/prettier/main.ts path/to/script.ts
+```
+
+You can format files on specific directory by passing the directory's path.
+
+```console
+deno --allow-run --allow-write https://deno.land/x/std/prettier/main.ts path/to/script.ts
+```
+
+## Use API
+
+You can use APIs of prettier as the following:
+
+```ts
+import {
+ prettier,
+ prettierPlugins
+} from "https://deno.land/x/std/prettier/prettier.ts";
+
+prettier.format("const x = 1", {
+ parser: "babel",
+ plugins: prettierPlugins
+}); // => "const x = 1;"
+```