patram 0.0.2 → 0.1.1

package/lib/list-source-files.test.js

@@ -1,101 +0,0 @@
-import { mkdtemp, mkdir, rm, writeFile } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-
-import { afterEach, expect, it } from 'vitest';
-
-import { listSourceFiles } from './list-source-files.js';
-
-const test_context = createTestContext();
-
-afterEach(async () => {
-  await cleanupTestContext(test_context);
-});
-
-it('lists matching source files as sorted repo-relative paths', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-
-  await writeProjectFile(test_context.project_directory, 'docs/zeta.md');
-  await writeProjectFile(test_context.project_directory, 'docs/alpha.md');
-  await writeProjectFile(
-    test_context.project_directory,
-    'docs/nested/overview.md',
-  );
-  await writeProjectFile(test_context.project_directory, 'docs/notes.txt');
-  await writeProjectFile(test_context.project_directory, 'notes/todo.md');
-
-  const source_files = await listSourceFiles(
-    ['docs/**/*.md'],
-    test_context.project_directory,
-  );
-
-  expect(source_files).toEqual([
-    'docs/alpha.md',
-    'docs/nested/overview.md',
-    'docs/zeta.md',
-  ]);
-});
-
-it('deduplicates paths matched by multiple include globs', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-
-  await writeProjectFile(test_context.project_directory, 'docs/patram.md');
-
-  const source_files = await listSourceFiles(
-    ['docs/**/*.md', 'docs/patram.md'],
-    test_context.project_directory,
-  );
-
-  expect(source_files).toEqual(['docs/patram.md']);
-});
-
-/**
- * Create a temporary project directory.
- *
- * @returns {Promise<string>}
- */
-async function createTempProjectDirectory() {
-  return mkdtemp(join(tmpdir(), 'patram-list-source-files-'));
-}
-
-/**
- * Write a file under the temporary project directory.
- *
- * @param {string} project_directory
- * @param {string} relative_path
- */
-async function writeProjectFile(project_directory, relative_path) {
-  const file_path = join(project_directory, relative_path);
-  const parent_directory = file_path.slice(0, file_path.lastIndexOf('/'));
-
-  await mkdir(parent_directory, { recursive: true });
-  await writeFile(file_path, `# ${relative_path}\n`);
-}
-
-/**
- * Remove a temporary directory tree.
- *
- * @param {string} project_directory
- */
-async function removeDirectory(project_directory) {
-  await rm(project_directory, { force: true, recursive: true });
-}
-
-/**
- * @returns {{ project_directory: string | null }}
- */
-function createTestContext() {
-  return {
-    project_directory: null,
-  };
-}
-
-/**
- * @param {{ project_directory: string | null }} test_context
- */
-async function cleanupTestContext(test_context) {
-  if (test_context.project_directory) {
-    await removeDirectory(test_context.project_directory);
-    test_context.project_directory = null;
-  }
-}

package/lib/load-patram-config.test.js

@@ -1,211 +0,0 @@
-import { mkdtemp, rm, writeFile } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-
-import { afterEach, expect, it } from 'vitest';
-
-import { loadPatramConfig } from './load-patram-config.js';
-
-const test_context = createTestContext();
-
-afterEach(async () => {
-  await cleanupTestContext(test_context);
-});
-
-it('loads and validates .patram.json from a project directory', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-  await writeProjectConfig(
-    test_context.project_directory,
-    createValidConfigSource(),
-  );
-
-  const load_result = await loadPatramConfig(test_context.project_directory);
-
-  expect(load_result).toEqual({
-    config: {
-      include: ['docs/**/*.md'],
-      queries: {
-        pending: {
-          where: 'kind=task and status=pending',
-        },
-      },
-    },
-    config_path: '.patram.json',
-    diagnostics: [],
-  });
-});
-
-it('defaults to the current working directory', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-  await writeProjectConfig(
-    test_context.project_directory,
-    createValidConfigSource(),
-  );
-  process.chdir(test_context.project_directory);
-
-  const load_result = await loadPatramConfig();
-
-  expect(load_result.config?.queries.pending.where).toBe(
-    'kind=task and status=pending',
-  );
-  expect(load_result.diagnostics).toEqual([]);
-});
-
-it('reports a missing config file', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-  const load_result = await loadPatramConfig(test_context.project_directory);
-
-  expect(load_result.config).toBeNull();
-  expect(load_result.diagnostics).toEqual([
-    {
-      code: 'config.not_found',
-      column: 1,
-      level: 'error',
-      line: 1,
-      message: 'Config file ".patram.json" was not found.',
-      path: '.patram.json',
-    },
-  ]);
-});
-
-it('reports invalid JSON syntax', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-  await writeProjectConfig(test_context.project_directory, createBrokenJson());
-
-  const load_result = await loadPatramConfig(test_context.project_directory);
-
-  expect(load_result.config).toBeNull();
-  expect(load_result.diagnostics).toEqual([
-    {
-      code: 'config.invalid_json',
-      column: 1,
-      level: 'error',
-      line: 3,
-      message: 'Invalid JSON syntax.',
-      path: '.patram.json',
-    },
-  ]);
-});
-
-it('reports config validation diagnostics', async () => {
-  test_context.project_directory = await createTempProjectDirectory();
-  await writeProjectConfig(
-    test_context.project_directory,
-    createInvalidConfigSource(),
-  );
-
-  const load_result = await loadPatramConfig(test_context.project_directory);
-
-  expect(load_result.config).toBeNull();
-  expect(load_result.diagnostics).toEqual([
-    {
-      code: 'config.invalid',
-      column: 1,
-      level: 'error',
-      line: 1,
-      message:
-        'Invalid config at "include": Include must contain at least one glob.',
-      path: '.patram.json',
-    },
-    {
-      code: 'config.invalid',
-      column: 1,
-      level: 'error',
-      line: 1,
-      message:
-        'Invalid config at "queries.pending.where": Stored query "where" must not be empty.',
-      path: '.patram.json',
-    },
-  ]);
-});
-
-/**
- * Create a temporary project directory.
- *
- * @returns {Promise<string>}
- */
-async function createTempProjectDirectory() {
-  return mkdtemp(join(tmpdir(), 'patram-load-config-'));
-}
-
-/**
- * Write a project config file.
- *
- * @param {string} project_directory
- * @param {string} config_source
- */
-async function writeProjectConfig(project_directory, config_source) {
-  await writeFile(join(project_directory, '.patram.json'), config_source);
-}
-
-/**
- * Remove a temporary directory tree.
- *
- * @param {string} project_directory
- */
-async function removeDirectory(project_directory) {
-  await rm(project_directory, { force: true, recursive: true });
-}
-
-/**
- * Create invalid JSON for parser tests.
- *
- * @returns {string}
- */
-function createBrokenJson() {
-  return ['{', '  "include": [', '}'].join('\n');
-}
-
-/**
- * Create invalid config JSON.
- *
- * @returns {string}
- */
-function createInvalidConfigSource() {
-  return JSON.stringify({
-    include: [],
-    queries: {
-      pending: {
-        where: '',
-      },
-    },
-  });
-}
-
-/**
- * Create valid config JSON.
- *
- * @returns {string}
- */
-function createValidConfigSource() {
-  return JSON.stringify({
-    include: ['docs/**/*.md'],
-    queries: {
-      pending: {
-        where: 'kind=task and status=pending',
-      },
-    },
-  });
-}
-
-/**
- * @returns {{ original_working_directory: string, project_directory: string | null }}
- */
-function createTestContext() {
-  return {
-    original_working_directory: process.cwd(),
-    project_directory: null,
-  };
-}
-
-/**
- * @param {{ original_working_directory: string, project_directory: string | null }} test_context
- */
-async function cleanupTestContext(test_context) {
-  process.chdir(test_context.original_working_directory);
-
-  if (test_context.project_directory) {
-    await removeDirectory(test_context.project_directory);
-    test_context.project_directory = null;
-  }
-}

package/lib/parse-claims.test.js

@@ -1,113 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { parseClaims } from './parse-claims.js';
-
-it('extracts markdown title, links and directives as neutral claims', () => {
-  const claims = parseClaims({
-    path: 'docs/patram.md',
-    source: createMarkdownSource(),
-  });
-
-  expect(claims).toEqual(createExpectedMarkdownClaims());
-});
-
-it('uses the first line as a plain markdown title', () => {
-  const claims = parseClaims({
-    path: 'docs/plain-title.md',
-    source: ['Patram Plain Title', '', 'Body text.'].join('\n'),
-  });
-
-  expect(claims).toEqual([
-    {
-      document_id: 'doc:docs/plain-title.md',
-      id: 'claim:doc:docs/plain-title.md:1',
-      origin: {
-        column: 1,
-        line: 1,
-        path: 'docs/plain-title.md',
-      },
-      type: 'document.title',
-      value: 'Patram Plain Title',
-    },
-  ]);
-});
-
-it('returns no claims for unsupported file types', () => {
-  const claims = parseClaims({
-    path: 'bin/patram.js',
-    source: 'console.log("Patram");',
-  });
-
-  expect(claims).toEqual([]);
-});
-
-it('returns no claims for extensionless files', () => {
-  const claims = parseClaims({
-    path: 'README',
-    source: '# Patram',
-  });
-
-  expect(claims).toEqual([]);
-});
-
-/**
- * Create markdown input for parser tests.
- *
- * @returns {string}
- */
-function createMarkdownSource() {
-  return [
-    '# Patram',
-    '',
-    'Read the [graph design](./graph-v0.md).',
-    'Defined by: terms/patram.md',
-  ].join('\n');
-}
-
-/**
- * Create the expected markdown claims.
- *
- * @returns {object[]}
- */
-function createExpectedMarkdownClaims() {
-  return [
-    {
-      document_id: 'doc:docs/patram.md',
-      id: 'claim:doc:docs/patram.md:1',
-      origin: {
-        column: 1,
-        line: 1,
-        path: 'docs/patram.md',
-      },
-      type: 'document.title',
-      value: 'Patram',
-    },
-    {
-      document_id: 'doc:docs/patram.md',
-      id: 'claim:doc:docs/patram.md:2',
-      origin: {
-        column: 10,
-        line: 3,
-        path: 'docs/patram.md',
-      },
-      type: 'markdown.link',
-      value: {
-        target: './graph-v0.md',
-        text: 'graph design',
-      },
-    },
-    {
-      document_id: 'doc:docs/patram.md',
-      id: 'claim:doc:docs/patram.md:3',
-      name: 'defined_by',
-      origin: {
-        column: 1,
-        line: 4,
-        path: 'docs/patram.md',
-      },
-      parser: 'markdown',
-      type: 'directive',
-      value: 'terms/patram.md',
-    },
-  ];
-}

package/lib/patram-config.test.js

@@ -1,147 +0,0 @@
-import { expect, it } from 'vitest';
-
-import graph_v0_config from '../docs/graph-v0.config.json' with { type: 'json' };
-import { parsePatramConfig } from './patram-config.js';
-
-it('parses the documented v0 config example', () => {
-  const config_json = parsePatramConfig(graph_v0_config);
-
-  expect(config_json.kinds.term.label).toBe('Term');
-  expect(config_json.mappings['markdown.directive.defined_by'].emit).toEqual({
-    relation: 'defines',
-    target: 'path',
-    target_kind: 'term',
-  });
-});
-
-it('rejects mappings that reference unknown relations', () => {
-  const issues = getIssues(createMissingRelationConfig());
-
-  expect(issues).toContainEqual(
-    expect.objectContaining({
-      message: 'Unknown relation "missing_relation".',
-      path: ['mappings', 'markdown.link', 'emit', 'relation'],
-    }),
-  );
-});
-
-it('rejects mappings that reference unknown kinds', () => {
-  const issues = getIssues(createUnknownKindConfig());
-
-  expect(issues).toContainEqual(
-    expect.objectContaining({
-      message: 'Unknown kind "term".',
-      path: [
-        'mappings',
-        'markdown.directive.defined_by',
-        'emit',
-        'target_kind',
-      ],
-    }),
-  );
-});
-
-it('rejects mappings without semantic output', () => {
-  const issues = getIssues(createEmptyMappingConfig());
-
-  expect(issues).toContainEqual(
-    expect.objectContaining({
-      message: 'Mapping must define at least one of "emit" or "node".',
-      path: ['mappings', 'document.title'],
-    }),
-  );
-});
-
-/**
- * Create a config with an unknown relation reference.
- *
- * @returns {object}
- */
-function createMissingRelationConfig() {
-  return {
-    kinds: {
-      document: {
-        builtin: true,
-      },
-    },
-    mappings: {
-      'markdown.link': {
-        emit: {
-          relation: 'missing_relation',
-          target: 'path',
-          target_kind: 'document',
-        },
-      },
-    },
-    relations: {},
-  };
-}
-
-/**
- * Create a config with an unknown kind reference.
- *
- * @returns {object}
- */
-function createUnknownKindConfig() {
-  return {
-    kinds: {
-      document: {
-        builtin: true,
-      },
-    },
-    mappings: {
-      'markdown.directive.defined_by': {
-        emit: {
-          relation: 'links_to',
-          target: 'path',
-          target_kind: 'term',
-        },
-      },
-    },
-    relations: {
-      links_to: {
-        from: ['document'],
-        to: ['document'],
-      },
-    },
-  };
-}
-
-/**
- * Create a config with an empty mapping definition.
- *
- * @returns {object}
- */
-function createEmptyMappingConfig() {
-  return {
-    kinds: {
-      document: {
-        builtin: true,
-      },
-    },
-    mappings: {
-      'document.title': {},
-    },
-    relations: {},
-  };
-}
-
-/**
- * Parse config and return validation issues.
- *
- * @param {object} config_json
- * @returns {unknown[]}
- */
-function getIssues(config_json) {
-  try {
-    parsePatramConfig(config_json);
-  } catch (error) {
-    if (error instanceof Error && 'issues' in error) {
-      return /** @type {{ issues: unknown[] }} */ (error).issues;
-    }
-
-    throw error;
-  }
-
-  throw new Error('Expected configuration parsing to fail.');
-}