@pgpmjs/ast 0.1.0 → 0.1.2

package/esm/files/extension/reader.js

@@ -1,13 +1,26 @@
 import { readFileSync } from 'fs';
-import { basename, dirname, relative } from 'path';
+import { dirname, relative } from 'path';
 import { parsePlanFileSimple } from '../plan';
 /**
  * Parse a .control file and extract its metadata.
  * https://www.postgresql.org/docs/current/extend-extensions.html
  */
 export function parseControlFile(filePath, basePath) {
-    const contents = readFileSync(filePath, 'utf-8');
-    const key = basename(filePath).split('.control')[0];
+    const { requires, version } = parseControlContent(readFileSync(filePath, 'utf-8'));
+    return {
+        // posix separators: this path is a portable identifier recorded in
+        // pgpm.json and plan metadata, not a filesystem path
+        path: dirname(relative(basePath, filePath)).replace(/\\/g, '/'),
+        requires,
+        version,
+    };
+}
+/**
+ * Parse .control file content and extract its metadata. The in-memory core of
+ * {@link parseControlFile}, for control text that does not live on disk (e.g.
+ * inside a migration bundle artifact).
+ */
+export function parseControlContent(contents) {
     const requires = contents
         .split('\n')
         .find((line) => /^requires/.test(line))
@@ -20,11 +33,7 @@ export function parseControlFile(filePath, basePath) {
         ?.split('=')[1]
         .replace(/[\']*/g, '')
         .trim() || '';
-    return {
-        path: dirname(relative(basePath, filePath)),
-        requires,
-        version,
-    };
+    return { requires, version };
 }
 /**
  * Parse the pgpm.plan file to get the extension name.

package/esm/files/plan/parser.js

@@ -6,7 +6,14 @@ import { errors } from '@pgpmjs/types';
  * Supports both changes and tags
  */
 export function parsePlanFile(planPath) {
-    const content = readFileSync(planPath, 'utf-8');
+    return parsePlanContent(readFileSync(planPath, 'utf-8'));
+}
+/**
+ * Parse Sqitch plan content (the text of a `pgpm.plan`) with full validation.
+ * The in-memory core of {@link parsePlanFile}, for plan text that does not
+ * live on disk (e.g. inside a migration bundle artifact).
+ */
+export function parsePlanContent(content) {
     const lines = content.split('\n');
     let project = '';
     let uri = '';

package/files/extension/reader.d.ts

@@ -9,6 +9,15 @@ export interface Module {
  * https://www.postgresql.org/docs/current/extend-extensions.html
  */
 export declare function parseControlFile(filePath: string, basePath: string): Module;
+/**
+ * Parse .control file content and extract its metadata. The in-memory core of
+ * {@link parseControlFile}, for control text that does not live on disk (e.g.
+ * inside a migration bundle artifact).
+ */
+export declare function parseControlContent(contents: string): {
+    requires: string[];
+    version: string;
+};
 /**
  * Parse the pgpm.plan file to get the extension name.
  */

package/files/extension/reader.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInstalledExtensions = exports.getExtensionInfo = exports.getExtensionName = void 0;
 exports.parseControlFile = parseControlFile;
+exports.parseControlContent = parseControlContent;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const plan_1 = require("../plan");
@@ -10,8 +11,21 @@ const plan_1 = require("../plan");
  * https://www.postgresql.org/docs/current/extend-extensions.html
  */
 function parseControlFile(filePath, basePath) {
-    const contents = (0, fs_1.readFileSync)(filePath, 'utf-8');
-    const key = (0, path_1.basename)(filePath).split('.control')[0];
+    const { requires, version } = parseControlContent((0, fs_1.readFileSync)(filePath, 'utf-8'));
+    return {
+        // posix separators: this path is a portable identifier recorded in
+        // pgpm.json and plan metadata, not a filesystem path
+        path: (0, path_1.dirname)((0, path_1.relative)(basePath, filePath)).replace(/\\/g, '/'),
+        requires,
+        version,
+    };
+}
+/**
+ * Parse .control file content and extract its metadata. The in-memory core of
+ * {@link parseControlFile}, for control text that does not live on disk (e.g.
+ * inside a migration bundle artifact).
+ */
+function parseControlContent(contents) {
     const requires = contents
         .split('\n')
         .find((line) => /^requires/.test(line))
@@ -24,11 +38,7 @@ function parseControlFile(filePath, basePath) {
         ?.split('=')[1]
         .replace(/[\']*/g, '')
         .trim() || '';
-    return {
-        path: (0, path_1.dirname)((0, path_1.relative)(basePath, filePath)),
-        requires,
-        version,
-    };
+    return { requires, version };
 }
 /**
  * Parse the pgpm.plan file to get the extension name.

package/files/plan/parser.d.ts

@@ -4,6 +4,12 @@ import { ExtendedPlanFile, ParseResult, PlanFile } from '../types';
  * Supports both changes and tags
  */
 export declare function parsePlanFile(planPath: string): ParseResult<ExtendedPlanFile>;
+/**
+ * Parse Sqitch plan content (the text of a `pgpm.plan`) with full validation.
+ * The in-memory core of {@link parsePlanFile}, for plan text that does not
+ * live on disk (e.g. inside a migration bundle artifact).
+ */
+export declare function parsePlanContent(content: string): ParseResult<ExtendedPlanFile>;
 /**
  * Resolve a reference within a plan file context
  * Handles symbolic references (HEAD, ROOT) and relative references

package/files/plan/parser.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parsePlanFile = parsePlanFile;
+exports.parsePlanContent = parsePlanContent;
 exports.resolveReference = resolveReference;
 exports.parsePlanFileSimple = parsePlanFileSimple;
 exports.getChanges = getChanges;
@@ -13,7 +14,14 @@ const types_1 = require("@pgpmjs/types");
  * Supports both changes and tags
  */
 function parsePlanFile(planPath) {
-    const content = (0, fs_1.readFileSync)(planPath, 'utf-8');
+    return parsePlanContent((0, fs_1.readFileSync)(planPath, 'utf-8'));
+}
+/**
+ * Parse Sqitch plan content (the text of a `pgpm.plan`) with full validation.
+ * The in-memory core of {@link parsePlanFile}, for plan text that does not
+ * live on disk (e.g. inside a migration bundle artifact).
+ */
+function parsePlanContent(content) {
     const lines = content.split('\n');
     let project = '';
     let uri = '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/ast",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Constructive <developers@constructive.io>",
   "description": "PGPM module AST — plan/control/SQL-header parsers and the lossless module read/write layer",
   "main": "index.js",
@@ -41,8 +41,8 @@
     "makage": "^0.3.0"
   },
   "dependencies": {
-    "@pgpmjs/env": "^2.28.2",
-    "@pgpmjs/types": "^2.35.1"
+    "@pgpmjs/env": "^2.29.0",
+    "@pgpmjs/types": "^2.36.0"
   },
-  "gitHead": "15a831fa029544068ee64e3386e4b08715d2b86d"
+  "gitHead": "39db6d576bce7bc1de8123849f237b1695779d88"
 }