eyelang 1.7.2 → 1.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/docs/guide.md +1 -1
  2. package/docs/language-reference.md +1 -1
  3. package/package.json +1 -1
  4. package/test/conformance/README.md +21 -6
  5. package/test/conformance/cases/atoms/graphic_angle_atom_stays_graphic.eye +4 -0
  6. package/test/conformance/cases/atoms/iri_atoms_in_lists.eye +4 -0
  7. package/test/conformance/cases/atoms/iri_quoted_absolute_readback.eye +5 -0
  8. package/test/conformance/cases/atoms/iri_quoted_and_angle_unify.eye +3 -0
  9. package/test/conformance/cases/atoms/zero_arity_atom_roundtrip.eye +5 -0
  10. package/test/conformance/cases/declarations/memoize_is_ordinary_fact.eye +4 -0
  11. package/test/conformance/cases/declarations/mode_determinism_are_facts.eye +8 -0
  12. package/test/conformance/cases/negation/stratified_negation_answers.eye +6 -0
  13. package/test/conformance/cases/table/table_does_not_change_answers.eye +7 -0
  14. package/test/conformance/cases/variables/question_anonymous_not_reused.eye +6 -0
  15. package/test/conformance/cases/variables/question_underscore_named_reuse.eye +5 -0
  16. package/test/conformance/errors/atoms/zero_arity_compound_rejected.eye +1 -0
  17. package/test/conformance/errors/syntax/colon_name_rejected.eye +1 -0
  18. package/test/conformance/errors/syntax/unclosed_quoted_atom_rejected.eye +1 -0
  19. package/test/conformance/errors/variables/bare_underscore_rejected.eye +1 -0
  20. package/test/conformance/errors/variables/underscore_named_rejected.eye +1 -0
  21. package/test/conformance/errors/variables/uppercase_variable_rejected.eye +1 -0
  22. package/test/conformance/expected/atoms/graphic_angle_atom_stays_graphic.eye +1 -0
  23. package/test/conformance/expected/atoms/iri_atoms_in_lists.eye +1 -0
  24. package/test/conformance/expected/atoms/iri_quoted_absolute_readback.eye +2 -0
  25. package/test/conformance/expected/atoms/iri_quoted_and_angle_unify.eye +1 -0
  26. package/test/conformance/expected/atoms/zero_arity_atom_roundtrip.eye +3 -0
  27. package/test/conformance/expected/declarations/memoize_is_ordinary_fact.eye +1 -0
  28. package/test/conformance/expected/declarations/mode_determinism_are_facts.eye +3 -0
  29. package/test/conformance/expected/negation/stratified_negation_answers.eye +1 -0
  30. package/test/conformance/expected/table/table_does_not_change_answers.eye +3 -0
  31. package/test/conformance/expected/variables/question_anonymous_not_reused.eye +4 -0
  32. package/test/conformance/expected/variables/question_underscore_named_reuse.eye +1 -0
  33. package/test/conformance/expected-errors/atoms/zero_arity_compound_rejected.txt +1 -0
  34. package/test/conformance/expected-errors/syntax/colon_name_rejected.txt +1 -0
  35. package/test/conformance/expected-errors/syntax/unclosed_quoted_atom_rejected.txt +1 -0
  36. package/test/conformance/expected-errors/variables/bare_underscore_rejected.txt +1 -0
  37. package/test/conformance/expected-errors/variables/underscore_named_rejected.txt +1 -0
  38. package/test/conformance/expected-errors/variables/uppercase_variable_rejected.txt +1 -0
  39. package/test/conformance/expected-warnings/negation/stratified_quiet.eye +1 -0
  40. package/test/conformance/expected-warnings/negation/stratified_quiet.txt +0 -0
  41. package/test/conformance/expected-warnings/negation/unstratified_mutual.eye +0 -0
  42. package/test/conformance/expected-warnings/negation/unstratified_mutual.txt +3 -0
  43. package/test/conformance/expected-warnings/negation/unstratified_self.eye +0 -0
  44. package/test/conformance/expected-warnings/negation/unstratified_self.txt +2 -0
  45. package/test/conformance/warnings/negation/stratified_quiet.eye +4 -0
  46. package/test/conformance/warnings/negation/unstratified_mutual.eye +5 -0
  47. package/test/conformance/warnings/negation/unstratified_self.eye +4 -0
  48. package/test/run-conformance.mjs +91 -9
package/docs/guide.md CHANGED
@@ -497,7 +497,7 @@ node test/run-regression.mjs
497
497
  node test/run-examples.mjs
498
498
  ```
499
499
 
500
- The conformance suite lives in [`test/conformance/`](../test/conformance/) as one flat eyelang corpus. Each case is a small `.eye` program with an exact expected stdout `.eye` file, and some cases also include a goal file for testing the embeddable solver, so other implementations can reuse the same cases. The suite covers the standard language surface from the language reference, including reusable built-ins. The regression suite lives in [`test/run-regression.mjs`](../test/run-regression.mjs) and covers CLI regressions, the public JavaScript API, and white-box invariants for parser, unification, and indexing behavior.
500
+ The conformance suite lives in [`test/conformance/`](../test/conformance/) as a file-based eyelang corpus. Positive cases pair `cases/<name>.eye` with exact expected stdout under `expected/<name>.eye`; negative cases pair `errors/<name>.eye` with exact expected error text under `expected-errors/<name>.txt`; warning cases pair `warnings/<name>.eye` with exact `--warnings` stdout and stderr files under `expected-warnings/`. Cases may be grouped in category directories such as `atoms/`, `variables/`, `negation/`, and `syntax/`, so another implementation can reuse the same corpus as an executable language contract. The suite covers the standard language surface from the language reference, including reusable built-ins, standard errors, and standard warnings. The regression suite lives in [`test/run-regression.mjs`](../test/run-regression.mjs) and covers CLI regressions, the public JavaScript API, and white-box invariants for parser, unification, and indexing behavior.
501
501
 
502
502
  ## Development and release
503
503
 
@@ -702,7 +702,7 @@ A conforming eyelang implementation supports the standard language described abo
702
702
 
703
703
  Browser execution, package layout, CLI URL loading, and any implementation-specific built-ins described in host documentation are outside this conformance surface unless separately standardized.
704
704
 
705
- Conformance cases live in the repository under `test/conformance/`. They are run by `npm test` before the example suite, and can be run alone with `node test/run-conformance.mjs`. Each case has an input program under `conformance/cases/` and an exact expected standard-output file under `conformance/expected/`; both use `.eye` so expected output remains eyelang-readable.
705
+ Conformance cases live in the repository under `test/conformance/`. They are run by `npm test` before the example suite, and can be run alone with `node test/run-conformance.mjs`. Positive cases have input programs under `conformance/cases/` and exact expected standard-output files under `conformance/expected/`; both use `.eye` so expected output remains eyelang-readable. Expected-error cases live under `conformance/errors/` with exact messages under `conformance/expected-errors/`. Expected-warning cases live under `conformance/warnings/` with exact `--warnings` stdout and stderr files under `conformance/expected-warnings/`.
706
706
 
707
707
  ## 15. Relationship to ISO Prolog
708
708
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eyelang",
3
- "version": "1.7.2",
3
+ "version": "1.7.3",
4
4
  "description": "A small Prolog-like logic programming language for rules, goals, answers, and proofs.",
5
5
  "type": "module",
6
6
  "main": "./index.js",
@@ -2,12 +2,25 @@
2
2
 
3
3
  This directory contains the executable conformance cases for the Eyelang language and reference engine. The normative language description is in the [Eyelang language reference](../../../docs/language-reference.md).
4
4
 
5
- The suite is intentionally file-based so another implementation can run the same programs and compare exact standard output. A case consists of:
5
+ The suite is intentionally file-based so another implementation can run the same programs and compare exact standard output, expected errors, and expected warnings. The conformance corpus is part of the public language contract, not just an implementation smoke test.
6
+
7
+ A normal positive case consists of:
6
8
 
7
9
  - `conformance/cases/<name>.eye` — input program;
8
10
  - `conformance/expected/<name>.eye` — exact expected standard output, stored as eyelang-readable facts.
9
11
 
10
- The current runner compares standard output from normal execution. Proof explanations are opt-in in the CLI and are not part of these conformance goldens. Standard error, performance, and resource limits are outside this suite.
12
+ Expected-error cases consist of:
13
+
14
+ - `conformance/errors/<name>.eye` — input program that must fail during parsing or execution;
15
+ - `conformance/expected-errors/<name>.txt` — exact expected error message followed by a newline.
16
+
17
+ Expected-warning cases consist of:
18
+
19
+ - `conformance/warnings/<name>.eye` — input program run through the CLI with `--warnings`;
20
+ - `conformance/expected-warnings/<name>.eye` — exact expected standard output;
21
+ - `conformance/expected-warnings/<name>.txt` — exact expected standard error.
22
+
23
+ Case names may be nested in category directories such as `atoms/`, `variables/`, `negation/`, or `syntax/`. Expected files mirror the same relative path.
11
24
 
12
25
  ## Running the suite
13
26
 
@@ -23,21 +36,23 @@ Run only the conformance suite:
23
36
  node test/run-conformance.mjs
24
37
  ```
25
38
 
26
- Run matching conformance cases by passing a filename fragment:
39
+ Run matching conformance cases by passing a filename or directory fragment:
27
40
 
28
41
  ```sh
29
42
  node test/run-conformance.mjs reusable
30
43
  node test/run-conformance.mjs 092_scalar_string_conversions
44
+ node test/run-conformance.mjs variables/
45
+ node test/run-conformance.mjs error/variables
31
46
  ```
32
47
 
33
- The runner executes materialized programs in-process through the public JavaScript API so small conformance cases avoid measuring Node startup overhead.
48
+ The runner executes normal materialized programs in-process through the public JavaScript API so small conformance cases avoid measuring Node startup overhead. Warning cases intentionally use the CLI because warning output is a host-interface contract.
34
49
 
35
50
  ## Scope
36
51
 
37
- The conformance corpus is a single eyelang suite. It covers the standard language described by the language reference: lexical syntax, facts, definite clauses, first-order terms, lists, conjunction, structured unification, left-to-right goal-directed proof search, materialized output, read-back printing, standard built-ins, declarations, and standard host behavior.
52
+ The conformance corpus is a single eyelang suite. It covers the standard language described by the language reference: lexical syntax, facts, definite clauses, first-order terms, lists, conjunction, structured unification, left-to-right goal-directed proof search, materialized output, read-back printing, standard built-ins, declarations, warnings, errors, and standard host behavior.
38
53
 
39
54
  The suite deliberately does not separate `core` and `extension` profiles. Reusable built-ins such as arithmetic, strings, lists, aggregation, context terms, term inspection, and search control are part of the standard eyelang conformance surface. Implementation-specific built-ins may still exist in downstream hosts, but they should have their own tests outside this corpus unless they are standardized.
40
55
 
41
56
  ## Updating expected output
42
57
 
43
- There is no committed auto-accept mode. To update an expected file, run the matching case with the conformance runner, inspect the result, and replace the corresponding file under `conformance/expected/` deliberately.
58
+ There is no committed auto-accept mode. To update an expected file, run the matching case with the conformance runner, inspect the result, and replace the corresponding file under `conformance/expected/`, `conformance/expected-errors/`, or `conformance/expected-warnings/` deliberately.
@@ -0,0 +1,4 @@
1
+ % Graphic atoms that are not absolute IRIs remain graphic atoms.
2
+ materialize(answer, 1).
3
+ operator(<=>).
4
+ answer(?op) :- operator(?op).
@@ -0,0 +1,4 @@
1
+ % IRI atoms can appear anywhere ordinary atoms can appear, including lists.
2
+ materialize(answer, 1).
3
+ route([<urn:example:a>, <urn:example:b>, <urn:example:c>]).
4
+ answer(?route) :- route(?route).
@@ -0,0 +1,5 @@
1
+ % Quoted absolute IRI atoms read back in angle-bracket form.
2
+ materialize(answer, 1).
3
+ item('https://example.org/alice').
4
+ item('urn:example:bob').
5
+ answer(?iri) :- item(?iri).
@@ -0,0 +1,3 @@
1
+ % Angle-bracket and quoted spellings denote the same absolute IRI atom.
2
+ materialize(answer, 1).
3
+ answer(ok) :- eq(<urn:example:a>, 'urn:example:a').
@@ -0,0 +1,5 @@
1
+ % Arity-zero data is represented as atoms, never zero-arity compounds.
2
+ materialize(answer, 2).
3
+ answer(name, ?name) :- compound_name_arguments(nil, ?name, ?args).
4
+ answer(args, ?args) :- compound_name_arguments(nil, ?name, ?args).
5
+ answer(term, ?term) :- compound_name_arguments(?term, nil, []).
@@ -0,0 +1,4 @@
1
+ % `memoize/2` is no longer a declaration, but it remains an ordinary fact.
2
+ materialize(answer, 2).
3
+ memoize(path, 2).
4
+ answer(?name, ?arity) :- memoize(?name, ?arity).
@@ -0,0 +1,8 @@
1
+ % Advisory declarations are also ordinary facts that programs can inspect.
2
+ mode(path, 2, [in, out]).
3
+ semidet(edge, 2).
4
+ det(root, 1).
5
+ materialize(answer, 2).
6
+ answer(mode, ?modes) :- mode(path, 2, ?modes).
7
+ answer(semidet, edge) :- semidet(edge, 2).
8
+ answer(det, root) :- det(root, 1).
@@ -0,0 +1,6 @@
1
+ % Stratified negation is portable and produces ordinary answers.
2
+ materialize(open, 1).
3
+ place(a).
4
+ place(b).
5
+ closed(b).
6
+ open(?x) :- place(?x), not(closed(?x)).
@@ -0,0 +1,7 @@
1
+ % `table/2` is a search-control declaration and does not change answers.
2
+ materialize(path, 2).
3
+ table(path, 2).
4
+ edge(a, b).
5
+ edge(b, c).
6
+ path(?x, ?y) :- edge(?x, ?y).
7
+ path(?x, ?z) :- edge(?x, ?y), path(?y, ?z).
@@ -0,0 +1,6 @@
1
+ % Each `?_` occurrence is anonymous and independent.
2
+ materialize(answer, 1).
3
+ pair(a, b).
4
+ pair(c, d).
5
+ answer(left(?x)) :- pair(?x, ?_).
6
+ answer(right(?y)) :- pair(?_, ?y).
@@ -0,0 +1,5 @@
1
+ % `?_name` is a named variable and must be reused within a clause.
2
+ materialize(answer, 1).
3
+ pair(a, a).
4
+ pair(a, b).
5
+ answer(?_value) :- pair(?_value, ?_value).
@@ -0,0 +1 @@
1
+ answer([<urn:example:a>, <urn:example:b>, <urn:example:c>]).
@@ -0,0 +1,2 @@
1
+ answer(<https://example.org/alice>).
2
+ answer(<urn:example:bob>).
@@ -0,0 +1,3 @@
1
+ answer(name, nil).
2
+ answer(args, []).
3
+ answer(term, nil).
@@ -0,0 +1,3 @@
1
+ answer(mode, [in, out]).
2
+ answer(semidet, edge).
3
+ answer(det, root).
@@ -0,0 +1,3 @@
1
+ path(a, b).
2
+ path(b, c).
3
+ path(a, c).
@@ -0,0 +1,4 @@
1
+ answer(left(a)).
2
+ answer(left(c)).
3
+ answer(right(b)).
4
+ answer(right(d)).
@@ -0,0 +1 @@
1
+ parse line 1: zero-arity compound syntax is not supported; use atom "nil" for arity zero data
@@ -0,0 +1 @@
1
+ colon names are not supported; use name or prefix_name
@@ -0,0 +1 @@
1
+ parse line 1: unterminated quoted term
@@ -0,0 +1 @@
1
+ parse line 1: bad character "_"
@@ -0,0 +1 @@
1
+ parse line 1: bad character "_"
@@ -0,0 +1 @@
1
+ parse line 1: bad character "X"
@@ -0,0 +1,3 @@
1
+ eyelang warning: unstratified negation
2
+ p/1 depends negatively on q/1
3
+ q/1 depends negatively on p/1
@@ -0,0 +1,2 @@
1
+ eyelang warning: unstratified negation
2
+ p/1 depends negatively on p/1
@@ -0,0 +1,4 @@
1
+ % Stratified negation emits no portability warning.
2
+ materialize(answer, 1).
3
+ candidate(a).
4
+ answer(ok) :- candidate(a), not(blocked(a)).
@@ -0,0 +1,5 @@
1
+ % Warnings report unstratified negation without changing normal execution.
2
+ materialize(answer, 1).
3
+ p(a) :- not(q(a)).
4
+ q(a) :- not(p(a)).
5
+ answer(ok).
@@ -0,0 +1,4 @@
1
+ % A direct negative self-dependency is reported as unstratified.
2
+ materialize(answer, 1).
3
+ p(a) :- not(p(a)).
4
+ answer(ok).
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  // Conformance test runner.
3
- // It executes cases in-process so the conformance corpus measures engine behavior instead of Node process startup.
3
+ // It executes normal cases in-process so the conformance corpus measures engine behavior instead of Node process startup.
4
4
  import fs from 'node:fs';
5
5
  import path from 'node:path';
6
6
  import { spawnSync } from 'node:child_process';
@@ -9,29 +9,67 @@ import { fileURLToPath } from 'node:url';
9
9
  import { TestReporter, isMainModule } from './test-style.mjs';
10
10
 
11
11
  const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)));
12
+ const packageRoot = path.resolve(root, '..');
13
+ const cliBin = path.join(packageRoot, 'src', 'bin.js');
12
14
  const filterArg = process.argv[2] ?? null;
13
15
 
14
16
  export function runConformance(reporter = new TestReporter(), requestedFilter = null) {
15
17
  const filter = requestedFilter ?? filterArg;
16
18
  const label = filter == null ? 'eyelang' : `eyelang ${filter}`;
17
19
  reporter.section(`Conformance ${label}`);
18
- for (const file of listCaseFiles(filter)) runCaseFile(reporter, file);
20
+ for (const file of listCaseFiles('cases', filter)) runCaseFile(reporter, file);
21
+ for (const file of listCaseFiles('errors', filter)) runErrorFile(reporter, file);
22
+ for (const file of listCaseFiles('warnings', filter)) runWarningFile(reporter, file);
19
23
  reporter.sectionTotal(`conformance ${label}`);
20
24
  }
21
25
 
22
- function listCaseFiles(filter = null) {
23
- const casesDir = path.join(root, 'conformance', 'cases');
24
- return fs.readdirSync(casesDir)
25
- .filter((name) => name.endsWith('.eye'))
26
- .filter((name) => filter == null || name.includes(filter) || name.slice(0, -4) === filter)
26
+ function listCaseFiles(kind, filter = null) {
27
+ const base = path.join(root, 'conformance', kind);
28
+ if (!fs.existsSync(base)) return [];
29
+ return listEyeFiles(base)
30
+ .filter((name) => matchesFilter(kind, name, filter))
27
31
  .sort();
28
32
  }
29
33
 
34
+ function matchesFilter(kind, name, filter) {
35
+ if (filter == null) return true;
36
+ const stem = name.slice(0, -4);
37
+ const label = kind === 'errors' ? 'error' : kind === 'warnings' ? 'warning' : kind;
38
+ return name.includes(filter)
39
+ || stem === filter
40
+ || stem.includes(filter)
41
+ || `${kind}/${stem}`.includes(filter)
42
+ || `${label}/${stem}`.includes(filter);
43
+ }
44
+
45
+ function listEyeFiles(base, dir = base) {
46
+ const files = [];
47
+ for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
48
+ const full = path.join(dir, entry.name);
49
+ if (entry.isDirectory()) {
50
+ files.push(...listEyeFiles(base, full));
51
+ } else if (entry.isFile() && entry.name.endsWith('.eye')) {
52
+ files.push(path.relative(base, full).split(path.sep).join('/'));
53
+ }
54
+ }
55
+ return files;
56
+ }
57
+
30
58
  function runCaseFile(reporter, file) {
31
59
  const name = file.slice(0, -4);
32
60
  reporter.test(name, () => runCase(name, file));
33
61
  }
34
62
 
63
+ function runErrorFile(reporter, file) {
64
+ const name = file.slice(0, -4);
65
+ reporter.test(`error/${name}`, () => runErrorCase(name, file));
66
+ }
67
+
68
+ function runWarningFile(reporter, file) {
69
+ const name = file.slice(0, -4);
70
+ reporter.test(`warning/${name}`, () => runWarningCase(name, file));
71
+ }
72
+
35
73
  function runCase(name, file) {
36
74
  const casesDir = path.join(root, 'conformance', 'cases');
37
75
  const expectedDir = path.join(root, 'conformance', 'expected');
@@ -41,13 +79,57 @@ function runCase(name, file) {
41
79
  const program = Program.parseSources([{ text, filename: file }], { sourceMetadata: false, markRecursive: false });
42
80
  const actual = run(program).stdout;
43
81
 
82
+ compareExpectedFile(expected, actual, name, 'output');
83
+ }
84
+
85
+ function runErrorCase(name, file) {
86
+ const casesDir = path.join(root, 'conformance', 'errors');
87
+ const expectedDir = path.join(root, 'conformance', 'expected-errors');
88
+ const programFile = path.join(casesDir, file);
89
+ const expected = path.join(expectedDir, `${name}.txt`);
90
+ const text = fs.readFileSync(programFile, 'utf8');
91
+ let actual = null;
92
+
93
+ try {
94
+ const program = Program.parseSources([{ text, filename: file }], { sourceMetadata: false, markRecursive: false });
95
+ run(program);
96
+ } catch (error) {
97
+ actual = `${error?.message ?? String(error)}\n`;
98
+ }
99
+
100
+ if (actual == null) throw new Error(`expected error for ${name}, but program succeeded`);
101
+ compareExpectedFile(expected, actual, name, 'error');
102
+ }
103
+
104
+ function runWarningCase(name, file) {
105
+ const warningsDir = path.join(root, 'conformance', 'warnings');
106
+ const expectedDir = path.join(root, 'conformance', 'expected-warnings');
107
+ const programFile = path.join(warningsDir, file);
108
+ const expectedStdout = path.join(expectedDir, `${name}.eye`);
109
+ const expectedStderr = path.join(expectedDir, `${name}.txt`);
110
+ const text = fs.readFileSync(programFile, 'utf8');
111
+ const result = spawnSync(process.execPath, [cliBin, '--warnings', '-'], {
112
+ cwd: packageRoot,
113
+ input: text,
114
+ encoding: 'utf8',
115
+ });
116
+
117
+ if (result.status !== 0) {
118
+ throw new Error(`warning case ${name} exited with ${result.status}\n${result.stderr}`.trimEnd());
119
+ }
120
+
121
+ compareExpectedFile(expectedStdout, result.stdout, name, 'warning stdout');
122
+ compareExpectedFile(expectedStderr, result.stderr, name, 'warning stderr');
123
+ }
124
+
125
+ function compareExpectedFile(expected, actual, name, kind) {
44
126
  if (!fs.existsSync(expected)) {
45
- throw new Error(`missing expected file: ${path.relative(root, expected)}`);
127
+ throw new Error(`missing expected ${kind} file: ${path.relative(root, expected)}`);
46
128
  }
47
129
 
48
130
  const expectedText = fs.readFileSync(expected, 'utf8');
49
131
  if (expectedText !== actual) {
50
- throw new Error(`output mismatch for ${name}\n${diffText(expected, actual)}`.trimEnd());
132
+ throw new Error(`${kind} mismatch for ${name}\n${diffText(expected, actual)}`.trimEnd());
51
133
  }
52
134
  }
53
135