generate deparser packages

Author: pyramation

packages/deparser/.gitignore

@@ -1 +1,3 @@
 __tests__/__snapshots__/kitchen-sink.test.ts.snap
+
+versions/

packages/deparser/README.md

@@ -69,6 +69,23 @@ console.log(deparse(stmt));
 // Output: SELECT * FROM another_table
 ```
 
+### Latest Version (PostgreSQL 17)
+
+```sh
+npm install pgsql-deparser
+```
+
+### Version-Specific Packages (PostgreSQL 13-16)
+
+While we highly recommend using PG17, for PostgreSQL versions 13-16, use the version-specific packages:
+
+```sh
+npm install pgsql-deparser@v13  # PostgreSQL 13
+npm install pgsql-deparser@v14  # PostgreSQL 14
+npm install pgsql-deparser@v15  # PostgreSQL 15
+npm install pgsql-deparser@v16  # PostgreSQL 16
+```
+
 ## Options
 
 The deparser accepts optional configuration for formatting and output control:

packages/transform/config/deparser-versions.json renamed to packages/deparser/config/deparser-versions.json

@@ -30,6 +30,16 @@
     "author": "Dan Lynch <[email protected]>",
     "homepage": "https://github.com/launchql/pgsql-parser",
     "license": "MIT",
+    "main": "index.js",
+    "module": "esm/index.js",
+    "types": "index.d.ts",
+    "description": "PostgreSQL AST Deparser",
+    "scripts": {
+      "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
+      "clean": "rimraf dist",
+      "prepare": "npm run build",
+      "build": "npm run clean && tsc && tsc -p tsconfig.esm.json && npm run copy"
+    },
     "publishConfig": {
       "access": "public",
       "directory": "dist"

packages/deparser/package.json

@@ -33,7 +33,14 @@
     "fixtures:upstream-diff": "ts-node scripts/make-upstream-diff.ts",
     "lint": "eslint . --fix",
     "test": "jest",
-    "test:watch": "jest --watch"
+    "test:watch": "jest --watch",
+    "strip-transformer-types": "ts-node scripts/strip-transformer-types.ts",
+    "strip-direct-transformer-types": "ts-node scripts/strip-direct-transformer-types.ts",
+    "strip-deparser-types": "ts-node scripts/strip-deparser-types.ts",
+    "organize-transformers": "ts-node scripts/organize-transformers-by-version.ts",
+    "generate-version-deparsers": "ts-node scripts/generate-version-deparsers.ts",
+    "generate-packages": "ts-node scripts/generate-version-packages.ts",
+    "prepare-versions": "npm run strip-transformer-types && npm run strip-direct-transformer-types && npm run strip-deparser-types && npm run organize-transformers && npm run generate-version-deparsers && npm run generate-packages"
   },
   "keywords": [
     "sql",

packages/transform/scripts/generate-version-deparsers.ts renamed to packages/deparser/scripts/generate-version-deparsers.ts

@@ -90,60 +90,15 @@ function updateVersionDirectory(config: VersionConfig): void {
   console.log(`  ✓ Created index.ts with deparser functionality`);
 }
 
-function updateReadme(version: number): void {
-  const versionDir = path.join(VERSIONS_DIR, version.toString());
-  const readmePath = path.join(versionDir, 'README.md');
-  
-  const readmeContent = `# PostgreSQL Version ${version} Deparser
-
-This directory contains a deparser for PostgreSQL version ${version} that automatically transforms ASTs to v17 format before deparsing.
-
-## Usage
-
-\`\`\`javascript
-import { deparse, deparseSync } from './index';
-
-// Async deparse
-const sql = await deparse(pgNode);
-
-// Sync deparse
-const sql = deparseSync(pgNode);
-
-// With options
-const sql = await deparse(pgNode, {
-  paramPrefix: '$',
-  trimSpace: true
-});
-\`\`\`
-
-## How it Works
 
-1. The deparser uses the \`PG${version}ToPG17Transformer\` to transform your v${version} AST to v17 format
-2. It then uses the standard \`pgsql-deparser\` to generate SQL from the v17 AST
-3. This ensures compatibility with the latest deparser while supporting older AST versions
-
-## Files
-
-- \`index.ts\` - Main deparser exports
-- \`v${version}-to-v17.ts\` - Direct transformer to v17
-- Other transformer files are dependencies for the direct transformer
-
-## Note
-
-These are type-stripped versions optimized for bundle size. For TypeScript support with full types, use the original source files from the main package.
-`;
-
-  fs.writeFileSync(readmePath, readmeContent);
-  console.log(`  ✓ Updated README.md`);
-}
 
 function main(): void {
   console.log('Generating version-specific deparsers...\n');
 
   for (const config of versionConfigs) {
     console.log(`Processing version ${config.version}...`);
     updateVersionDirectory(config);
-    updateReadme(config.version);
+
     console.log('');
   }
 

packages/transform/scripts/generate-version-packages.ts renamed to packages/deparser/scripts/generate-version-packages.ts

@@ -29,55 +29,38 @@ function loadConfig(): Config {
 }
 
 function generatePackageJson(packageName: string, version: string, versionConfig: VersionConfig, template: Record<string, any>): any {
-  return {
+  // Start with the template and override only the version-specific fields
+  const packageJson: any = {
+    ...template,
     name: packageName,
     version: versionConfig.deparserVersion,
-    description: `PostgreSQL v${version} AST Deparser - Transforms v${version} ASTs to v17 and deparses them`,
-    main: "index.js",
-    module: "esm/index.js",
-    types: "index.d.ts",
-    ...template,
-    scripts: {
-      "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
-      "clean": "rimraf dist",
-      "prepare": "npm run build",
-      "build": "npm run clean && tsc && tsc -p tsconfig.esm.json && npm run copy"
-    },
     dependencies: {
       [`@pgsql/types`]: `^${versionConfig.typesVersion}`
-    },
-    keywords: [
-      ...template.keywords,
-      `v${version}`,
-      `postgresql-${version}`
-    ]
+    }
   };
+  
+  return packageJson;
 }
 
 function generateTsConfig(): any {
   return {
     "compilerOptions": {
-      "target": "es2018",
+      "outDir": "dist",
+      "rootDir": "src/",  
+      "target": "es2022",
       "module": "commonjs",
-      "lib": ["es2018"],
-      "declaration": true,
-      "outDir": "./dist",
-      "rootDir": "./",
-      "strict": false,
       "esModuleInterop": true,
-      "skipLibCheck": true,
       "forceConsistentCasingInFileNames": true,
-      "moduleResolution": "node",
-      "resolveJsonModule": true
+      "strict": true,
+      "strictNullChecks": false,
+      "skipLibCheck": true,
+      "sourceMap": false,
+      "declaration": true,
+      "resolveJsonModule": true,
+      "moduleResolution": "node"
     },
-    "include": [
-      "**/*.ts"
-    ],
-    "exclude": [
-      "node_modules",
-      "dist",
-      "**/*.test.ts"
-    ]
+    "include": ["src/**/*.ts"],
+    "exclude": ["dist", "node_modules", "**/*.spec.*", "**/*.test.*"]
   };
 }
 
@@ -125,61 +108,15 @@ function generateVersionPackages(): void {
     fs.writeFileSync(tsConfigEsmPath, JSON.stringify(tsConfigEsm, null, 2));
     console.log(`  ✓ Created tsconfig.esm.json`);
 
-    // Update README with package name and npm tag
-    updateReadmeWithPackageName(version, config.packageName, versionConfig.npmTag);
+
 
     console.log('');
   }
 
   console.log('Done! Package files have been generated for all versions.');
 }
 
-function updateReadmeWithPackageName(version: string, packageName: string, npmTag: string): void {
-  const versionDir = path.join(VERSIONS_DIR, version);
-  const readmePath = path.join(versionDir, 'README.md');
-  
-  if (!fs.existsSync(readmePath)) {
-    return;
-  }
-  
-  let content = fs.readFileSync(readmePath, 'utf-8');
-  
-  // Remove any existing installation sections
-  content = content.replace(/## Installation[\s\S]*?(?=##|$)/gm, '');
-  
-  // Add installation instructions at the beginning
-  const installSection = `## Installation
-
-\`\`\`bash
-# Install specific version using npm tag
-npm install ${packageName}@${npmTag}
-
-# Or using yarn
-yarn add ${packageName}@${npmTag}
-\`\`\`
 
-`;
-  
-  // Insert after the title
-  const lines = content.split('\n');
-  const titleIndex = lines.findIndex(line => line.startsWith('# '));
-  if (titleIndex !== -1) {
-    // Find the next non-empty line after title
-    let insertIndex = titleIndex + 1;
-    while (insertIndex < lines.length && lines[insertIndex].trim() === '') {
-      insertIndex++;
-    }
-    lines.splice(insertIndex, 0, installSection);
-    content = lines.join('\n');
-  }
-  
-  // Update import examples
-  content = content.replace(/from '\.\/index'/g, `from '${packageName}'`);
-  content = content.replace(/from 'pgsql-deparser-v\d+'/g, `from '${packageName}'`);
-  
-  fs.writeFileSync(readmePath, content);
-  console.log(`  ✓ Updated README.md with package name`);
-}
 
 // Run the script
 generateVersionPackages();

packages/transform/scripts/organize-transformers-by-version.ts renamed to packages/deparser/scripts/organize-transformers-by-version.ts

@@ -76,49 +76,13 @@ ${transformers.map(t => `    to${t.targetVersion}: ${t.className}`).join(',\n')}
 `;
 }
 
-function createReadme(version: number, transformers: TransformerMapping['transformers']): string {
-  const transformerList = transformers.map(t => 
-    `- \`${t.className}\` - Transform from v${version} to v${t.targetVersion}`
-  ).join('\n');
-
-  return `# PostgreSQL Version ${version} Transformers
-
-This directory contains all transformers that start from PostgreSQL version ${version}.
-
-## Available Transformers
-
-${transformerList}
-
-## Usage
-
-### Individual Transformers
-
-\`\`\`javascript
-import { ${transformers[0].className} } from './${path.basename(transformers[0].fileName, '.ts')}';
-
-const transformer = new ${transformers[0].className}();
-const result = transformer.transform(node);
-\`\`\`
-
-### All Transformers
-
-\`\`\`javascript
-import { getTransformersForV${version} } from './index';
-
-const transformers = getTransformersForV${version}();
-const v${transformers[0].targetVersion}Result = new transformers.to${transformers[0].targetVersion}().transform(node);
-\`\`\`
-
-## Files
-
-${transformers.map(t => `- \`${path.basename(t.fileName)}\` - ${t.className}`).join('\n')}
-- \`index.js\` - Exports all transformers and convenience function
-- \`README.md\` - This file
-
-## Note
-
-These are type-stripped versions optimized for bundle size. For TypeScript support, use the original source files.
-`;
+function copyReadme(versionDir: string): void {
+  const sourcePath = path.join(__dirname, '..', 'README.md');
+  const destPath = path.join(versionDir, 'README.md');
+  
+  if (fs.existsSync(sourcePath)) {
+    fs.copyFileSync(sourcePath, destPath);
+  }
 }
 
 function organizeByVersion(): void {
@@ -154,8 +118,7 @@ function organizeByVersion(): void {
     console.log(`  ✓ Created index.js`);
 
     // Create README
-    const readmeContent = createReadme(mapping.sourceVersion, mapping.transformers);
-    fs.writeFileSync(path.join(versionDir, 'README.md'), readmeContent);
+    copyReadme(versionDir);
     console.log(`  ✓ Created README.md`);
 
     console.log('');

packages/transform/scripts/strip-deparser-types.ts renamed to packages/deparser/scripts/strip-deparser-types.ts

@@ -7,7 +7,7 @@ import * as path from 'path';
  * Replaces @pgsql/types imports and t.* type references with 'any'
  */
 
-const DEPARSER_SRC_DIR = '../deparser/src';
+const DEPARSER_SRC_DIR = 'src';
 const VERSIONS_DIR = 'versions';
 const VERSIONS = [13, 14, 15, 16];
 

packages/transform/scripts/strip-direct-transformer-types.ts renamed to packages/deparser/scripts/strip-direct-transformer-types.ts

@@ -8,10 +8,10 @@ import * as path from 'path';
  */
 
 const DIRECT_TRANSFORMER_FILES = [
-  'src/transformers-direct/v13-to-v17/index.ts',
-  'src/transformers-direct/v14-to-v17/index.ts',
-  'src/transformers-direct/v15-to-v17/index.ts',
-  'src/transformers-direct/v16-to-v17/index.ts'
+  '../transform/src/transformers-direct/v13-to-v17/index.ts',
+  '../transform/src/transformers-direct/v14-to-v17/index.ts',
+  '../transform/src/transformers-direct/v15-to-v17/index.ts',
+  '../transform/src/transformers-direct/v16-to-v17/index.ts'
 ];
 
 const OUTPUT_DIR = 'versions/direct';

packages/transform/scripts/strip-transformer-types.ts renamed to packages/deparser/scripts/strip-transformer-types.ts

@@ -8,10 +8,10 @@ import * as path from 'path';
  */
 
 const TRANSFORMER_FILES = [
-  'src/transformers/v13-to-v14.ts',
-  'src/transformers/v14-to-v15.ts',
-  'src/transformers/v15-to-v16.ts',
-  'src/transformers/v16-to-v17.ts'
+  '../transform/src/transformers/v13-to-v14.ts',
+  '../transform/src/transformers/v14-to-v15.ts',
+  '../transform/src/transformers/v15-to-v16.ts',
+  '../transform/src/transformers/v16-to-v17.ts'
 ];
 
 const OUTPUT_DIR = 'versions';