Merge pull request #2 from function-artisans/simple-cli

Replace the Raycast extension with a CLI

Author: raszi

.github/workflows/ci.yml

@@ -30,9 +30,6 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Run ESLint
-        run: npm run eslint
-
       - name: Run lint
         run: npm run lint
 

.gitignore

@@ -3,8 +3,12 @@
 # dependencies
 /node_modules
 
-# Raycast specific files
-raycast-env.d.ts
+# build output
+/dist
 
 # misc
 .DS_Store
+
+# devenv
+.devenv
+.devenv.flake.nix

README.md

@@ -1,3 +1,48 @@
 # format-code
 
-Formats source code of various languages from your clipboard and copies that back to the clipboard in the formatted way.
+Formats source code from stdin and writes the formatted code to stdout.
+
+## Install
+
+```sh
+npm install
+npm run build
+npm link
+```
+
+## Usage
+
+```sh
+format-code <language> [--print-width=100] [--sql-dialect=sql] < input
+```
+
+Languages: `angular`, `css`, `glimmer`, `graphql`, `html`, `javascript`, `json`,
+`json5`, `less`, `lwc`, `markdown`, `mdx`, `scss`, `typescript`, `vue`, `yaml`,
+`sql`, `sql-output`.
+
+The `sql-output` language formats a SQL query and its result as two Markdown code
+blocks.
+
+To format the code on the macOS clipboard, run:
+
+```sh
+pbpaste | format-code json | pbcopy
+```
+
+## macOS shortcuts
+
+To generate a signed shortcut for each language, run:
+
+```sh
+format-code shortcuts --sql-dialect postgresql
+```
+
+Each shortcut formats the code on the clipboard and copies the result back to the
+clipboard. The command writes the files to the current directory. To import a
+shortcut, open its file:
+
+```sh
+open "Format JSON.shortcut"
+```
+
+To see all the options, run `format-code shortcuts --help`.

assets/icon.png

@@ -0,0 +1,10 @@
+// @ts-check
+
+import js from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+export default defineConfig(
+  js.configs.recommended,
+  tseslint.configs.recommended,
+);