@arkadia/data 0.1.7 → 0.1.8

package/eslint.config.mjs

@@ -0,0 +1,42 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import eslintConfigPrettier from 'eslint-config-prettier';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  // 1. Global ignores (equivalent to .eslintignore)
+  {
+    ignores: ['dist/', 'node_modules/', 'coverage/'],
+  },
+
+  // 2. Base configuration for all files
+  {
+    files: ['**/*.{js,mjs,cjs,ts}'],
+    languageOptions: {
+      globals: globals.node,
+    },
+  },
+
+  // 3. Recommended JS rules
+  pluginJs.configs.recommended,
+
+  // 4. Recommended TypeScript rules
+  ...tseslint.configs.recommended,
+
+  // 5. Custom Rules (Overrides)
+  {
+    rules: {
+      // Allow unused vars if they start with underscore (like Python setup)
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      // Allow 'any' type but warn about it (optional)
+      '@typescript-eslint/no-explicit-any': 'warn',
+    },
+  },
+
+  // 6. Prettier integration (Must be last to override other configs)
+  eslintConfigPrettier,
+];

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@arkadia/data",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Parser and Stringifier for Arkadia Data Format (AKD)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "check": "prettier --check . && eslint .",
     "clean": "rimraf dist",
     "build": "npm run clean && tsc",
     "verify": "node scripts/verify-build.js",
@@ -24,9 +28,15 @@
   "author": "Arkadia Solutions",
   "license": "MIT",
   "devDependencies": {
+    "@eslint/js": "^9.39.2",
     "@types/node": "^20.19.31",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.3.0",
+    "prettier": "^3.8.1",
     "rimraf": "^6.1.2",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.0",
     "vitest": "^3.2.4"
   }
 }

package/scripts/verify-build.js

@@ -1,15 +1,17 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+
 const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
 
 // Load package.json to get the real package name (e.g., @arkadia/data)
 const pkg = require('../package.json');
-const PACKAGE_NAME = pkg.name; 
+const PACKAGE_NAME = pkg.name;
 
 // --- CONFIGURATION ---
 const ROOT_DIR = path.resolve(__dirname, '..');
 const TEMP_DIR = path.join(ROOT_DIR, 'temp_smoke_test');
-const DIST_DIR = path.join(ROOT_DIR, 'dist'); 
+const DIST_DIR = path.join(ROOT_DIR, 'dist');
 
 // Node.js modules we DO NOT want in the browser build
 const FORBIDDEN_IMPORTS = ['util', 'fs', 'path', 'child_process', 'os'];
@@ -20,80 +22,80 @@ const success = (msg) => console.log(`\x1b[32m[SUCCESS]\x1b[0m ${msg}`);
 const error = (msg) => console.error(`\x1b[31m[ERROR]\x1b[0m ${msg}`);
 
 function scanDirForForbiddenImports(dir) {
-    if (!fs.existsSync(dir)) return;
-    
-    const files = fs.readdirSync(dir);
-    
-    for (const file of files) {
-        const fullPath = path.join(dir, file);
-        const stat = fs.statSync(fullPath);
-
-        if (stat.isDirectory()) {
-            scanDirForForbiddenImports(fullPath);
-        } else if (file.endsWith('.js') || file.endsWith('.mjs')) {
-            const content = fs.readFileSync(fullPath, 'utf-8');
-            
-            FORBIDDEN_IMPORTS.forEach(mod => {
-                // Regex looks for: require('util') OR from 'util'
-                const regex = new RegExp(`(require\\(['"]${mod}['"]\\)|from\\s+['"]${mod}['"])`);
-                if (regex.test(content)) {
-                    throw new Error(
-                        `Found Node.js specific module '${mod}' in file: ${file}\n` +
-                        `This will crash in the browser! Please remove the import or use a polyfill.`
-                    );
-                }
-            });
+  if (!fs.existsSync(dir)) return;
+
+  const files = fs.readdirSync(dir);
+
+  for (const file of files) {
+    const fullPath = path.join(dir, file);
+    const stat = fs.statSync(fullPath);
+
+    if (stat.isDirectory()) {
+      scanDirForForbiddenImports(fullPath);
+    } else if (file.endsWith('.js') || file.endsWith('.mjs')) {
+      const content = fs.readFileSync(fullPath, 'utf-8');
+
+      FORBIDDEN_IMPORTS.forEach((mod) => {
+        // Regex looks for: require('util') OR from 'util'
+        const regex = new RegExp(`(require\\(['"]${mod}['"]\\)|from\\s+['"]${mod}['"])`);
+        if (regex.test(content)) {
+          throw new Error(
+            `Found Node.js specific module '${mod}' in file: ${file}\n` +
+              `This will crash in the browser! Please remove the import or use a polyfill.`,
+          );
         }
+      });
     }
+  }
 }
 
 // --- MAIN PROCESS ---
 
 try {
-    log(`🚀 Starting verification process for: ${PACKAGE_NAME}...`);
-
-    // 1. Cleanup
-    if (fs.existsSync(TEMP_DIR)) {
-        log('Cleaning up old test artifacts...');
-        fs.rmSync(TEMP_DIR, { recursive: true, force: true });
-    }
-
-    // 2. Build Project
-    log('1. Building project (npm run build)...');
-    try {
-        execSync('npm run build', { stdio: 'inherit', cwd: ROOT_DIR });
-    } catch (e) {
-        throw new Error("Build failed. Fix compilation errors first.");
-    }
-
-    // 3. BROWSER COMPATIBILITY CHECK
-    log('2. Checking for browser compatibility (No Node.js built-ins)...');
-    scanDirForForbiddenImports(DIST_DIR);
-    success('Browser compatibility check passed! No forbidden imports found.');
-
-    // 4. Pack Project
-    log('3. Packaging (npm pack)...');
-    const packOutput = execSync('npm pack', { cwd: ROOT_DIR }).toString().trim();
-    // npm pack output might have multiple lines, take the last one (filename)
-    const tgzFileName = packOutput.split('\n').pop().trim();
-    const tgzPath = path.join(ROOT_DIR, tgzFileName);
-    
-    if (!fs.existsSync(tgzPath)) {
-        throw new Error(`Could not find packed file: ${tgzFileName}`);
-    }
-    log(`   📦 Created: ${tgzFileName}`);
-
-    // 5. Create Temp Environment
-    log('4. Creating temporary test environment...');
-    fs.mkdirSync(TEMP_DIR);
-    execSync('npm init -y', { cwd: TEMP_DIR, stdio: 'ignore' });
+  log(`🚀 Starting verification process for: ${PACKAGE_NAME}...`);
 
-    // 6. Install Tarball
-    log(`5. Installing tarball into temp env...`);
-    execSync(`npm install "${tgzPath}"`, { cwd: TEMP_DIR, stdio: 'ignore' });
-
-    // 7. Verify Script - USING FUNCTIONAL IMPORTS { decode, encode }
-    const verifyScript = `
+  // 1. Cleanup
+  if (fs.existsSync(TEMP_DIR)) {
+    log('Cleaning up old test artifacts...');
+    fs.rmSync(TEMP_DIR, { recursive: true, force: true });
+  }
+
+  // 2. Build Project
+  log('1. Building project (npm run build)...');
+  try {
+    execSync('npm run build', { stdio: 'inherit', cwd: ROOT_DIR });
+  } catch {
+    throw new Error('Build failed. Fix compilation errors first.');
+  }
+
+  // 3. BROWSER COMPATIBILITY CHECK
+  log('2. Checking for browser compatibility (No Node.js built-ins)...');
+  scanDirForForbiddenImports(DIST_DIR);
+  success('Browser compatibility check passed! No forbidden imports found.');
+
+  // 4. Pack Project
+  log('3. Packaging (npm pack)...');
+  const packOutput = execSync('npm pack', { cwd: ROOT_DIR }).toString().trim();
+  // npm pack output might have multiple lines, take the last one (filename)
+  const tgzFileName = packOutput.split('\n').pop().trim();
+  const tgzPath = path.join(ROOT_DIR, tgzFileName);
+
+  if (!fs.existsSync(tgzPath)) {
+    throw new Error(`Could not find packed file: ${tgzFileName}`);
+  }
+  log(`   📦 Created: ${tgzFileName}`);
+
+  // 5. Create Temp Environment
+  log('4. Creating temporary test environment...');
+  fs.mkdirSync(TEMP_DIR);
+  execSync('npm init -y', { cwd: TEMP_DIR, stdio: 'ignore' });
+
+  // 6. Install Tarball
+  log(`5. Installing tarball into temp env...`);
+  execSync(`npm install "${tgzPath}"`, { cwd: TEMP_DIR, stdio: 'ignore' });
+
+  // 7. Verify Script - USING FUNCTIONAL IMPORTS { decode, encode }
+  const verifyScript = `
         const { decode, encode } = require('${PACKAGE_NAME}');
         
         console.log("   🧪 Running functional tests...");
@@ -171,32 +173,33 @@ try {
         }
     `;
 
-    fs.writeFileSync(path.join(TEMP_DIR, 'verify_script.js'), verifyScript);
+  fs.writeFileSync(path.join(TEMP_DIR, 'verify_script.js'), verifyScript);
 
-    // 8. Run Verification
-    log('6. Running functional verification...');
-    execSync('node verify_script.js', { cwd: TEMP_DIR, stdio: 'inherit' });
+  // 8. Run Verification
+  log('6. Running functional verification...');
+  execSync('node verify_script.js', { cwd: TEMP_DIR, stdio: 'inherit' });
 
-    // 9. Cleanup
-    log('7. Cleanup...');
-    fs.rmSync(TEMP_DIR, { recursive: true, force: true });
-    fs.unlinkSync(tgzPath); 
-
-    console.log('\n');
-    success('READY FOR PUBLISH! 🚀');
-    console.log(` - Package: ${PACKAGE_NAME}`);
-    console.log(' - Browser Compatible: YES');
-    console.log('\n');
+  // 9. Cleanup
+  log('7. Cleanup...');
+  fs.rmSync(TEMP_DIR, { recursive: true, force: true });
+  fs.unlinkSync(tgzPath);
 
+  console.log('\n');
+  success('READY FOR PUBLISH! 🚀');
+  console.log(` - Package: ${PACKAGE_NAME}`);
+  console.log(' - Browser Compatible: YES');
+  console.log('\n');
 } catch (e) {
-    console.log('\n');
-    error('VERIFICATION FAILED!');
+  console.log('\n');
+  error('VERIFICATION FAILED!');
+  console.error(e.message || e);
+
+  try {
+    const tgzFiles = fs.readdirSync(ROOT_DIR).filter((f) => f.endsWith('.tgz'));
+    tgzFiles.forEach((f) => fs.unlinkSync(path.join(ROOT_DIR, f)));
+  } catch (e) {
     console.error(e.message || e);
-    
-    try {
-        const tgzFiles = fs.readdirSync(ROOT_DIR).filter(f => f.endsWith('.tgz'));
-        tgzFiles.forEach(f => fs.unlinkSync(path.join(ROOT_DIR, f)));
-    } catch (cleanupErr) {}
-    
-    process.exit(1);
-}
+  }
+
+  process.exit(1);
+}

package/src/config.ts

@@ -2,101 +2,101 @@
  * Configuration options for the AK Data Format Encoder.
  */
 export interface EncoderConfig {
-    /**
-     * Embed schema directly inside sample data (useful for LLM prompting).
-     * Example: [ (name: string /name of user/, age: int) ]
-     * Default: false
-     */
-    promptOutput: boolean;
+  /**
+   * Embed schema directly inside sample data (useful for LLM prompting).
+   * Example: [ (name: string /name of user/, age: int) ]
+   * Default: false
+   */
+  promptOutput: boolean;
 
-    /**
-     * Number of spaces used for indentation.
-     * Default: 2
-     */
-    indent: number;
+  /**
+   * Number of spaces used for indentation.
+   * Default: 2
+   */
+  indent: number;
 
-    /**
-     * Initial indentation offset (level).
-     * Default: 0
-     */
-    startIndent: number;
+  /**
+   * Initial indentation offset (level).
+   * Default: 0
+   */
+  startIndent: number;
 
-    /**
-     * Enable compact formatting. Removes unnecessary spaces and newlines.
-     * Default: false
-     */
-    compact: boolean;
+  /**
+   * Enable compact formatting. Removes unnecessary spaces and newlines.
+   * Default: false
+   */
+  compact: boolean;
 
-    /**
-     * Escape newline characters in strings as literal \n and \r.
-     * Default: false
-     */
-    escapeNewLines: boolean;
+  /**
+   * Escape newline characters in strings as literal \n and \r.
+   * Default: false
+   */
+  escapeNewLines: boolean;
 
-    /**
-     * purely removes new lines from strings.
-     * Default: false
-     */
-    removeNewLines: boolean;
+  /**
+   * purely removes new lines from strings.
+   * Default: false
+   */
+  removeNewLines: boolean;
 
-    /**
-     * Enable ANSI colorized output for terminal debugging.
-     * Default: false
-     */
-    colorize: boolean;
+  /**
+   * Enable ANSI colorized output for terminal debugging.
+   * Default: false
+   */
+  colorize: boolean;
 
-    /**
-     * Include comments in the output ).
-     * Default: true
-     */
-    includeComments: boolean;
+  /**
+   * Include comments in the output ).
+   * Default: true
+   */
+  includeComments: boolean;
 
-    /**
-     * Include array size information (e.g. [ $size=5 : ... ]).
-     * Default: false
-     */
-    includeArraySize: boolean;
+  /**
+   * Include array size information (e.g. [ $size=5 : ... ]).
+   * Default: false
+   */
+  includeArraySize: boolean;
 
-    /**
-     * Include the schema definition header (e.g. <name: string>).
-     * Default: true
-     */
-    includeSchema: boolean;
+  /**
+   * Include the schema definition header (e.g. <name: string>).
+   * Default: true
+   */
+  includeSchema: boolean;
 
-    /**
-     * Include metadata attributes and tags ($attr=1 #tag).
-     * Default: true
-     */
-    includeMeta: boolean;
+  /**
+   * Include metadata attributes and tags ($attr=1 #tag).
+   * Default: true
+   */
+  includeMeta: boolean;
 
-    /**
-     * Include type signature after field names (e.g. name: string vs name).
-     * Default: true
-     */
-    includeType: boolean;
+  /**
+   * Include type signature after field names (e.g. name: string vs name).
+   * Default: true
+   */
+  includeType: boolean;
 }
 
 /**
  * Default configuration values.
  */
 export const DEFAULT_CONFIG: EncoderConfig = {
-    indent: 2,
-    startIndent: 0,
-    compact: false,
-    escapeNewLines: false,
-    removeNewLines: false,
-    colorize: false,
-    includeComments: true,
-    includeArraySize: false,
-    includeSchema: true,
-    includeMeta: true,
-    includeType: true,
-    promptOutput: false,
+  indent: 2,
+  startIndent: 0,
+  compact: false,
+  escapeNewLines: false,
+  removeNewLines: false,
+  colorize: false,
+  includeComments: true,
+  includeArraySize: false,
+  includeSchema: true,
+  includeMeta: true,
+  includeType: true,
+  promptOutput: false,
 };
 
 /**
  * Helper to merge partial user config with defaults.
  */
 export function resolveConfig(config?: Partial<EncoderConfig>): EncoderConfig {
-    return { ...DEFAULT_CONFIG, ...config };
-}
+  return { ...DEFAULT_CONFIG, ...config };
+}