feat: ktlint-all (cli), ktlintAll (api)

package.json

@@ -9,6 +9,8 @@
     "@types/node": "^16.11.12",
     "got": "^11.0.0"
   },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "resources",
@@ -18,7 +20,8 @@
     "!src/**/__exclude"
   ],
   "bin": {
-    "run-ktlint": "dist/bin/run-ktlint.js"
+    "run-ktlint": "dist/bin/run-ktlint.js",
+    "ktlint-all": "dist/bin/ktlint-all.js"
   },
   "publishConfig": {
     "access": "public"

readme.md

@@ -45,3 +45,15 @@ yarn run-ktlint "someFile.kt"
 ```
 
 Test it with `yarn run-ktlint --version`
+
+## ktlint-all
+
+```shell
+yarn ktlint-all
+```
+
+Equivalent of running `ktlint -F`.
+
+It also exposes a `ktlintAll` function in `index.js` for programmatic usage.
+
+It will throw an Error on non-zero return codes.

src/bin/ktlint-all.ts

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+/*
+
+yarn tsn ./src/bin/ktlint-all.ts
+
+ */
+
+import { runCommand } from '../exec.util'
+import { ktlintPath } from '../paths'
+
+// argv[0] is /usr/local/bin/node
+// argv[1] is ./src/bin/run-ktlint.ts (when ran with `yarn tsn`)
+const args = process.argv.slice(2)
+// console.log({argv, argv0, args})
+
+runCommand(ktlintPath, ['-F', ...args])

src/bin/run-ktlint.ts

@@ -6,26 +6,12 @@ yarn tsn ./src/bin/run-ktlint.ts --version
 
  */
 
-import { spawn } from 'child_process'
+import { runCommand } from '../exec.util'
 import { ktlintPath } from '../paths'
 
 // argv[0] is /usr/local/bin/node
 // argv[1] is ./src/bin/run-ktlint.ts (when ran with `yarn tsn`)
 const args = process.argv.slice(2)
 // console.log({argv, argv0, args})
 
-console.log(['ktlint', ...args].join(' '))
-
-const p = spawn(ktlintPath, [...args], {
-  stdio: 'inherit',
-  shell: true,
-})
-
-// out.on('error', (error) => {
-//   console.log(`error: ${error.message}`);
-// });
-
-p.on('close', code => {
-  // console.log(`child process exited with code ${code}`);
-  process.exit(code || 0)
-})
+runCommand(ktlintPath, args)

src/exec.util.ts

@@ -0,0 +1,44 @@
+import { spawn, SpawnOptions } from 'child_process'
+
+export function runCommand(command: string, args: string[] = [], opt: SpawnOptions = {}): void {
+  console.log([command, ...args].join(' '))
+
+  const p = spawn(command, [...args], {
+    stdio: 'inherit',
+    shell: true,
+    ...opt,
+  })
+
+  p.on('close', code => {
+    if (code) {
+      console.log(`${command} exited with code ${code}`)
+    }
+
+    process.exit(code || 0)
+  })
+}
+
+/**
+ * Throws error on failure.
+ */
+export async function runCommandSafe(
+  command: string,
+  args: string[] = [],
+  opt: SpawnOptions = {},
+): Promise<void> {
+  console.log([command, ...args].join(' '))
+
+  return await new Promise((resolve, reject) => {
+    const p = spawn(command, [...args], {
+      stdio: 'inherit',
+      shell: true,
+      ...opt,
+    })
+
+    p.on('close', code => {
+      if (!code) return resolve()
+
+      reject(new Error(`${command} exited with code ${code}`))
+    })
+  })
+}

src/index.ts

@@ -0,0 +1,7 @@
+import { SpawnOptions } from 'child_process'
+import { runCommandSafe } from './exec.util'
+import { ktlintPath } from './paths'
+
+export async function ktlintAll(args: string[] = [], opt: SpawnOptions): Promise<void> {
+  await runCommandSafe(ktlintPath, ['-F', ...args], opt)
+}

tsconfig.prod.json

@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "declaration": false,
+    "declaration": true,
     "sourceMap": false
   },
   "exclude": ["**/__exclude", "src/test", "src/**/*.test.*"]