eyeling 1.18.2 → 1.19.0

package/HANDBOOK.md

@@ -1777,12 +1777,16 @@ Install from npm:
 npm i eyeling
 ```
 
-Run a file:
+Run a self-contained example from stdin:
 
 ```bash
-npx eyeling examples/socrates.n3
+echo '@prefix : <http://example.org/> .
+:Socrates a :Man .
+{ ?x a :Man } => { ?x a :Mortal } .' | npx eyeling
 ```
 
+You can also pass a file path, or `-` to read explicitly from stdin.
+
 Show the available options:
 
 ```bash
@@ -1823,6 +1827,8 @@ The current CLI supports a small set of flags (see `lib/cli.js`):
 - `-t`, `--stream` — stream derived triples as soon as they are derived.
 - `-v`, `--version` — print version and exit.
 - `-h`, `--help` — show usage.
+- With no positional argument, Eyeling reads from stdin when input is piped.
+- Use `-` as the input path to read explicitly from stdin.
 
 ### 14.3 `lib/entry.js`: bundler-friendly exports
 

package/README.md

@@ -7,8 +7,9 @@ A compact [Notation3 (N3)](https://notation3.org/) reasoner in **JavaScript**.
 ## Quick start
 
 ```bash
-npm i eyeling
-npx eyeling examples/socrates.n3
+echo '@prefix : <http://example.org/> .
+:Socrates a :Man .
+{ ?x a :Man } => { ?x a :Mortal } .' | npx eyeling
 ```
 
 ## Read more

package/eyeling.js

@@ -4536,6 +4536,11 @@ function formatN3SyntaxError(err, text, path) {
 }
 
 // CLI entry point (invoked when eyeling.js is run directly)
+function readTextFromStdinSync() {
+  const fs = require('node:fs');
+  return fs.readFileSync(0, { encoding: 'utf8' });
+}
+
 function main() {
   // Drop "node" and script name; keep only user-provided args
   // Expand combined short options: -pt == -p -t
@@ -4555,7 +4560,8 @@ function main() {
 
   function printHelp(toStderr = false) {
     const msg =
-      `Usage: ${prog} [options] <file.n3>\n\n` +
+      `Usage: ${prog} [options] [file.n3|-]\n\n` +
+      `When no file is given and stdin is piped, read N3 from stdin.\n\n` +
       `Options:\n` +
       `  -a, --ast                    Print parsed AST as JSON and exit.\n` +
       `      --builtin <module.js>    Load a custom builtin module (repeatable).\n` +
@@ -4626,12 +4632,13 @@ function main() {
   }
 
   // Positional args (the N3 file)
-  if (positional.length === 0) {
+  const useImplicitStdin = positional.length === 0 && !process.stdin.isTTY;
+  if (positional.length === 0 && !useImplicitStdin) {
     printHelp(false);
     process.exit(0);
   }
-  if (positional.length !== 1) {
-    console.error('Error: expected exactly one input <file.n3>.');
+  if (positional.length > 1) {
+    console.error('Error: expected at most one input [file.n3|-].');
     printHelp(true);
     process.exit(1);
   }
@@ -4646,13 +4653,17 @@ function main() {
     }
   }
 
-  const filePath = positional[0];
+  const sourceLabel = useImplicitStdin || positional[0] === '-' ? '<stdin>' : positional[0];
   let text;
   try {
-    const fs = require('fs');
-    text = fs.readFileSync(filePath, { encoding: 'utf8' });
+    if (sourceLabel === '<stdin>') text = readTextFromStdinSync();
+    else {
+      const fs = require('node:fs');
+      text = fs.readFileSync(sourceLabel, { encoding: 'utf8' });
+    }
   } catch (e) {
-    console.error(`Error reading file ${JSON.stringify(filePath)}: ${e.message}`);
+    if (sourceLabel === '<stdin>') console.error(`Error reading stdin: ${e.message}`);
+    else console.error(`Error reading file ${JSON.stringify(sourceLabel)}: ${e.message}`);
     process.exit(1);
   }
 
@@ -4666,7 +4677,7 @@ function main() {
     engine.setTracePrefixes(prefixes);
   } catch (e) {
     if (e && e.name === 'N3SyntaxError') {
-      console.error(formatN3SyntaxError(e, text, filePath));
+      console.error(formatN3SyntaxError(e, text, sourceLabel));
       process.exit(1);
     }
     throw e;

package/lib/cli.js

@@ -45,6 +45,11 @@ function formatN3SyntaxError(err, text, path) {
 }
 
 // CLI entry point (invoked when eyeling.js is run directly)
+function readTextFromStdinSync() {
+  const fs = require('node:fs');
+  return fs.readFileSync(0, { encoding: 'utf8' });
+}
+
 function main() {
   // Drop "node" and script name; keep only user-provided args
   // Expand combined short options: -pt == -p -t
@@ -64,7 +69,8 @@ function main() {
 
   function printHelp(toStderr = false) {
     const msg =
-      `Usage: ${prog} [options] <file.n3>\n\n` +
+      `Usage: ${prog} [options] [file.n3|-]\n\n` +
+      `When no file is given and stdin is piped, read N3 from stdin.\n\n` +
       `Options:\n` +
       `  -a, --ast                    Print parsed AST as JSON and exit.\n` +
       `      --builtin <module.js>    Load a custom builtin module (repeatable).\n` +
@@ -135,12 +141,13 @@ function main() {
   }
 
   // Positional args (the N3 file)
-  if (positional.length === 0) {
+  const useImplicitStdin = positional.length === 0 && !process.stdin.isTTY;
+  if (positional.length === 0 && !useImplicitStdin) {
     printHelp(false);
     process.exit(0);
   }
-  if (positional.length !== 1) {
-    console.error('Error: expected exactly one input <file.n3>.');
+  if (positional.length > 1) {
+    console.error('Error: expected at most one input [file.n3|-].');
     printHelp(true);
     process.exit(1);
   }
@@ -155,13 +162,17 @@ function main() {
     }
   }
 
-  const filePath = positional[0];
+  const sourceLabel = useImplicitStdin || positional[0] === '-' ? '<stdin>' : positional[0];
   let text;
   try {
-    const fs = require('fs');
-    text = fs.readFileSync(filePath, { encoding: 'utf8' });
+    if (sourceLabel === '<stdin>') text = readTextFromStdinSync();
+    else {
+      const fs = require('node:fs');
+      text = fs.readFileSync(sourceLabel, { encoding: 'utf8' });
+    }
   } catch (e) {
-    console.error(`Error reading file ${JSON.stringify(filePath)}: ${e.message}`);
+    if (sourceLabel === '<stdin>') console.error(`Error reading stdin: ${e.message}`);
+    else console.error(`Error reading file ${JSON.stringify(sourceLabel)}: ${e.message}`);
     process.exit(1);
   }
 
@@ -175,7 +186,7 @@ function main() {
     engine.setTracePrefixes(prefixes);
   } catch (e) {
     if (e && e.name === 'N3SyntaxError') {
-      console.error(formatN3SyntaxError(e, text, filePath));
+      console.error(formatN3SyntaxError(e, text, sourceLabel));
       process.exit(1);
     }
     throw e;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyeling",
-  "version": "1.18.2",
+  "version": "1.19.0",
   "description": "A minimal Notation3 (N3) reasoner in JavaScript.",
   "main": "./index.js",
   "keywords": [

package/test/api.test.js

@@ -1762,6 +1762,55 @@ _:x :hates { _:foo :making :mess }.
     },
     expect: [/http:\/\/example\.org\/ancestor/m],
   },
+  {
+    name: '67 CLI stdin: accepts piped N3 when no file argument is given',
+    run() {
+      const input = `@prefix : <http://example.org/> .
+:Socrates a :Man .
+{ ?x a :Man } => { ?x a :Mortal } .
+`;
+      const r = spawnSync(process.execPath, [path.join(ROOT, 'eyeling.js')], {
+        input,
+        encoding: 'utf8',
+        stdio: ['pipe', 'pipe', 'pipe'],
+      });
+      if (r.error) throw r.error;
+      if (r.status !== 0) {
+        const err = new Error(`CLI failed with exit ${r.status}`);
+        err.code = r.status;
+        err.stdout = r.stdout;
+        err.stderr = r.stderr;
+        throw err;
+      }
+      return r.stdout;
+    },
+    expect: [/:(?:Socrates)\s+a\s+:(?:Mortal)\s*\./],
+  },
+  {
+    name: '68 CLI stdin: accepts explicit - for stdin',
+    run() {
+      const input = `@prefix : <http://example.org/> .
+:Socrates a :Man .
+{ ?x a :Man } => { ?x a :Mortal } .
+`;
+      const r = spawnSync(process.execPath, [path.join(ROOT, 'eyeling.js'), '-'], {
+        input,
+        encoding: 'utf8',
+        stdio: ['pipe', 'pipe', 'pipe'],
+      });
+      if (r.error) throw r.error;
+      if (r.status !== 0) {
+        const err = new Error(`CLI failed with exit ${r.status}`);
+        err.code = r.status;
+        err.stdout = r.stdout;
+        err.stderr = r.stderr;
+        throw err;
+      }
+      return r.stdout;
+    },
+    expect: [/:(?:Socrates)\s+a\s+:(?:Mortal)\s*\./],
+  },
+
   {
     name: '240 custom builtin module can be loaded via --builtin',
     run() {