Merge PR #621: fix EAGAIN error for stdin

sql-formatter-org · Jul 23, 2023 · 76d08f0 · 76d08f0
2 parents 0d4787c + 0a94042
commit 76d08f0
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 25 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -58,6 +58,7 @@ For those who have admin access on the repo, the new release publish flow is as
 - Romain Rigaux <hello@getromain.com>
 - Sasha Aliashkevich <olsender@gmail.com>
 - Sean Song <mail@seansong.dev>
+- Sebastian Lyng Johansen <seblyng98@gmail.com>
 - Sergei Egorov <sergei.egorov@zeroturnaround.com>
 - Stanislav Germanovskii <s.germanovskiy@tinkoff.ru>
 - Steven Yung <stevenyung@fastmail.com>

diff --git a/bin/sql-formatter-cli.cjs b/bin/sql-formatter-cli.cjs
@@ -7,14 +7,18 @@ const fs = require('fs');
 const tty = require('tty');
 const { version } = require('../package.json');
 const { ArgumentParser } = require('argparse');
+const { promisify } = require('util');
+const getStdin = require('get-stdin');
 
-class PrettierSQLArgs {
+class SqlFormatterCli {
   constructor() {
     this.parser = this.getParser();
     this.args = this.parser.parse_args();
-    this.cfg = this.readConfig();
+  }
 
-    this.query = this.getInput();
+  async run() {
+    this.cfg = await this.readConfig();
+    this.query = await this.getInput();
     const formattedQuery = format(this.query, this.cfg).trim() + '\n';
     this.writeOutput(this.getOutputFile(this.args), formattedQuery);
   }
@@ -59,7 +63,7 @@ class PrettierSQLArgs {
     return parser;
   }
 
-  readConfig() {
+  async readConfig() {
     if (
       tty.isatty(0) &&
       Object.entries(this.args).every(([k, v]) => k === 'language' || v === undefined)
@@ -68,45 +72,55 @@ class PrettierSQLArgs {
       process.exit(0);
     }
 
-    if (this.args.config)
+    if (this.args.config) {
       try {
-        const configFile = fs.readFileSync(this.args.config);
+        const configFile = await this.readFile(this.args.config);
         const configJson = JSON.parse(configFile);
         return { language: this.args.language, ...configJson };
       } catch (e) {
         if (e instanceof SyntaxError) {
           console.error(`Error: unable to parse JSON at file ${this.args.config}`);
           process.exit(1);
         }
-        if (e.code === 'ENOENT') {
-          console.error(`Error: could not open file ${this.args.config}`);
-          process.exit(1);
-        }
+        this.exitWhenIOError(e);
         console.error('An unknown error has occurred, please file a bug report at:');
         console.log('https://github.com/sql-formatter-org/sql-formatter/issues\n');
         throw e;
       }
+    }
     return {
       language: this.args.language,
     };
   }
 
-  getInput() {
+  async getInput() {
     const infile = this.args.file || process.stdin.fd;
-    try {
-      return fs.readFileSync(infile, 'utf-8');
-    } catch (e) {
-      if (e.code === 'EAGAIN') {
-        console.error('Error: no file specified and no data in stdin');
-        process.exit(1);
-      }
-      if (e.code === 'ENOENT') {
-        console.error(`Error: could not open file ${infile}`);
-        process.exit(1);
+    if (this.args.file) {
+      try {
+        return await this.readFile(infile, { encoding: 'utf-8' });
+      } catch (e) {
+        this.exitWhenIOError(e);
+        console.error('An unknown error has occurred, please file a bug report at:');
+        console.log('https://github.com/sql-formatter-org/sql-formatter/issues\n');
+        throw e;
       }
-      console.error('An unknown error has occurred, please file a bug report at:');
-      console.log('https://github.com/sql-formatter-org/sql-formatter/issues\n');
-      throw e;
+    } else {
+      return await getStdin();
+    }
+  }
+
+  async readFile(filename) {
+    return promisify(fs.readFile)(filename, { encoding: 'utf-8' });
+  }
+
+  exitWhenIOError(e) {
+    if (e.code === 'EAGAIN') {
+      console.error('Error: no file specified and no data in stdin');
+      process.exit(1);
+    }
+    if (e.code === 'ENOENT') {
+      console.error(`Error: could not open file ${infile}`);
+      process.exit(1);
     }
   }
 
@@ -136,4 +150,5 @@ class PrettierSQLArgs {
   }
 }
 
-new PrettierSQLArgs();
+const cli = new SqlFormatterCli();
+cli.run();
diff --git a/package.json b/package.json
@@ -78,6 +78,7 @@
     "Rodrigo Stuchi",
     "Romain Rigaux <hello@getromain.com>",
     "Sasha Aliashkevich <olsender@gmail.com>",
+    "Sebastian Lyng Johansen <seblyng98@gmail.com>",
     "Sean Song <mail@seansong.dev>",
     "Sergei Egorov <sergei.egorov@zeroturnaround.com>",
     "Stanislav Germanovskii <s.germanovskiy@tinkoff.ru>",
@@ -125,6 +126,7 @@
   },
   "dependencies": {
     "argparse": "^2.0.1",
+    "get-stdin": "=8.0.0",
     "nearley": "^2.20.1"
   },
   "devDependencies": {

diff --git a/yarn.lock b/yarn.lock
@@ -3500,6 +3500,11 @@ get-package-type@^0.1.0:
   resolved "https://registry.yarnpkg.com/get-package-type/-/get-package-type-0.1.0.tgz#8de2d803cff44df3bc6c456e6668b36c3926e11a"
   integrity sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==
 
+get-stdin@=8.0.0:
+  version "8.0.0"
+  resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-8.0.0.tgz#cbad6a73feb75f6eeb22ba9e01f89aa28aa97a53"
+  integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==
+
 get-stream@^5.1.0:
   version "5.2.0"
   resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-5.2.0.tgz#4966a1795ee5ace65e706c4b7beb71257d6e22d3"