pkg-scaffold 3.1.3 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkg-scaffold",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "The ultimate enterprise-grade codebase janitor. Faster than Knip v6 with OXC integration, type-aware analysis, and self-healing capabilities.",
   "type": "module",
   "main": "index.js",
@@ -13,7 +13,7 @@
     "test": "echo \"Error: no test specified\" && exit 0",
     "test:stability": "npm run test",
     "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
+    "docs:build": "vitepress build docs && cp docs/sitemap.xml docs/.vitepress/dist/ && cp docs/robots.txt docs/.vitepress/dist",
     "docs:preview": "vitepress preview docs"
   },
   "keywords": [

package/pkg-scaffold/config.json

@@ -20,6 +20,7 @@
     "nuxt",
     "remix",
     "sveltekit",
-    "astro"
+    "astro",
+    "typescript"
   ]
 }

package/src/plugins/BasePlugin.js

@@ -1,53 +1,71 @@
+import fs from 'fs/promises';
+import path from 'path';
+
 /**
  * Base class for all pkg-scaffold plugins.
  * Defines the contract for ecosystem detection and entry point mapping.
+ * Version 3.2.0: Added support for dynamic custom getters.
  */
 export class BasePlugin {
-  constructor(context) {
-    this.context = context;
-  }
+    constructor(context) {
+        this.context = context;
+        this.customGetters = new Map();
+    }
+
+    /**
+     * Unique identifier for the plugin (e.g., 'nextjs').
+     */
+    get name() {
+        throw new Error('Plugin must implement name getter');
+    }
 
-  /**
-   * Unique identifier for the plugin (e.g., 'nextjs').
-   */
-  get name() {
-    throw new Error('Plugin must implement name getter');
-  }
+    /**
+     * Returns a list of configuration files that indicate this ecosystem is active.
+     */
+    getConfigFiles() {
+        return [];
+    }
 
-  /**
-   * Returns a list of configuration files that indicate this ecosystem is active.
-   */
-  getConfigFiles() {
-    return [];
-  }
+    /**
+     * Returns regex patterns for files that should be treated as entry points.
+     */
+    getRoutePatterns() {
+        return [];
+    }
 
-  /**
-   * Returns regex patterns for files that should be treated as entry points.
-   */
-  getRoutePatterns() {
-    return [];
-  }
+    /**
+     * Returns symbols that are implicitly required/exported by the framework.
+     */
+    getRequiredSystemContracts() {
+        return ['default'];
+    }
 
-  /**
-   * Returns symbols that are implicitly required/exported by the framework.
-   */
-  getRequiredSystemContracts() {
-    return ['default'];
-  }
+    /**
+     * Version 3.2.0: Dynamic getter for custom plugin properties.
+     * @param {string} key - The property key to retrieve
+     * @returns {any} The value of the custom property
+     */
+    get(key) {
+        const methodName = `get${key.charAt(0).toUpperCase() + key.slice(1)}`;
+        if (typeof this[methodName] === 'function') {
+            return this[methodName]();
+        }
+        return this.customGetters.get(key);
+    }
 
-  /**
-   * Optional: Logic to detect if the plugin should be active in the given directory.
-   */
-  async isActive(baseDir) {
-    const configFiles = this.getConfigFiles();
-    for (const file of configFiles) {
-      try {
-        await fs.access(path.join(baseDir, file));
-        return true;
-      } catch {
-        continue;
-      }
+    /**
+     * Optional: Logic to detect if the plugin should be active in the given directory.
+     */
+    async isActive(baseDir) {
+        const configFiles = this.getConfigFiles();
+        for (const file of configFiles) {
+            try {
+                await fs.access(path.join(baseDir, file));
+                return true;
+            } catch {
+                continue;
+            }
+        }
+        return false;
     }
-    return false;
-  }
 }

package/src/plugins/PluginRegistry.js

@@ -4,92 +4,107 @@ import { pathToFileURL } from 'url';
 
 /**
  * Advanced Plugin Registry supporting Builtin, Custom, and Knip-style plugins.
+ * Version 3.2.0: Enhanced with support for dynamic custom getters.
  */
 export class PluginRegistry {
-  constructor(context) {
-    this.context = context;
-    this.plugins = new Map();
-    this.config = null;
-  }
-
-  async init(projectRoot) {
-    const configPath = path.join(projectRoot, 'pkg-scaffold', 'config.json');
-    try {
-      const configRaw = await fs.readFile(configPath, 'utf8');
-      this.config = JSON.parse(configRaw);
-    } catch (e) {
-      this.config = { useBuiltinPlugins: true, useCustomPlugins: true, supportKnipPlugins: true };
+    constructor(context) {
+        this.context = context;
+        this.plugins = new Map();
+        this.config = null;
     }
 
-    if (this.config.useBuiltinPlugins) {
-      await this.loadBuiltinPlugins();
-    }
+    async init(projectRoot) {
+        const configPath = path.join(projectRoot, 'pkg-scaffold', 'config.json');
+        try {
+            const configRaw = await fs.readFile(configPath, 'utf8');
+            this.config = JSON.parse(configRaw);
+        } catch (e) {
+            this.config = {
+                useBuiltinPlugins: true,
+                useCustomPlugins: true,
+                supportKnipPlugins: true
+            };
+        }
 
-    if (this.config.useCustomPlugins) {
-      await this.loadCustomPlugins(projectRoot);
-    }
+        if (this.config.useBuiltinPlugins) {
+            await this.loadBuiltinPlugins();
+        }
+
+        if (this.config.useCustomPlugins) {
+            await this.loadCustomPlugins(projectRoot);
+        }
 
-    if (this.config.supportKnipPlugins) {
-      await this.initKnipAdapter();
+        if (this.config.supportKnipPlugins) {
+            await this.initKnipAdapter();
+        }
     }
-  }
 
-  async loadBuiltinPlugins() {
-    const { NextJsPlugin } = await import('./ecosystems/NextJsPlugin.js');
-    const { NuxtPlugin, RemixPlugin, SvelteKitPlugin, AstroPlugin } = await import('./ecosystems/GenericPlugins.js');
+    async loadBuiltinPlugins() {
+        const { NextJsPlugin } = await import('./ecosystems/NextJsPlugin.js');
+        const { NuxtPlugin, RemixPlugin, SvelteKitPlugin, AstroPlugin } = await import('./ecosystems/GenericPlugins.js');
+        const { TypeScriptPlugin } = await import('./ecosystems/TypeScriptPlugin.js');
 
-    const builtins = [
-      new NextJsPlugin(this.context),
-      new NuxtPlugin(this.context),
-      new RemixPlugin(this.context),
-      new SvelteKitPlugin(this.context),
-      new AstroPlugin(this.context)
-    ];
+        const builtins = [
+            new NextJsPlugin(this.context),
+            new NuxtPlugin(this.context),
+            new RemixPlugin(this.context),
+            new SvelteKitPlugin(this.context),
+            new AstroPlugin(this.context),
+            new TypeScriptPlugin(this.context)
+        ];
 
-    builtins.forEach(p => {
-      if (!this.config.enabledPlugins || this.config.enabledPlugins.includes(p.name)) {
-        this.register(p);
-      }
-    });
-  }
+        builtins.forEach(p => {
+            if (!this.config.enabledPlugins || this.config.enabledPlugins.includes(p.name)) {
+                this.register(p);
+            }
+        });
+    }
+
+    async loadCustomPlugins(projectRoot) {
+        const pluginsDir = path.join(projectRoot, 'pkg-scaffold', 'plugins');
+        try {
+            const files = await fs.readdir(pluginsDir);
+            for (const file of files) {
+                if (file.endsWith('.js') || file.endsWith('.mjs')) {
+                    const pluginModule = await import(pathToFileURL(path.join(pluginsDir, file)).href);
+                    const PluginClass = pluginModule.default || pluginModule;
+                    const pluginInstance = new PluginClass(this.context);
 
-  async loadCustomPlugins(projectRoot) {
-    const pluginsDir = path.join(projectRoot, 'pkg-scaffold', 'plugins');
-    try {
-      const files = await fs.readdir(pluginsDir);
-      for (const file of files) {
-        if (file.endsWith('.js') || file.endsWith('.mjs')) {
-          const pluginModule = await import(pathToFileURL(path.join(pluginsDir, file)).href);
-          const PluginClass = pluginModule.default || pluginModule;
-          this.register(new PluginClass(this.context));
+                    const version = pluginInstance.get('version');
+                    if (version && this.context.verbose) {
+                        console.log(`[PluginRegistry] Loaded ${pluginInstance.name} v${version}`);
+                    }
+                    this.register(pluginInstance);
+                }
+            }
+        } catch (e) {
+            // No custom plugins or dir missing
         }
-      }
-    } catch (e) {
-      // No custom plugins or dir missing
     }
-  }
 
-  async initKnipAdapter() {
-    // This adapter allows running Knip-style plugins by wrapping them
-    // In a real scenario, this would interface with knip's plugin API
-    this.context.knipCompatible = true;
-  }
+    async initKnipAdapter() {
+        this.context.knipCompatible = true;
+    }
+
+    register(plugin) {
+        this.plugins.set(plugin.name, plugin);
+    }
 
-  register(plugin) {
-    this.plugins.set(plugin.name, plugin);
-  }
+    getPlugins() {
+        return Array.from(this.plugins.values());
+    }
 
-  getPlugins() {
-    return Array.from(this.plugins.values());
-  }
+    getPlugin(name) {
+        return this.plugins.get(name);
+    }
 
-  async getActivePlugins(baseDir) {
-    const active = [];
-    for (const plugin of this.plugins.values()) {
-      if (await plugin.isActive(baseDir)) {
-        active.push(plugin);
-      }
+    async getActivePlugins(baseDir) {
+        const active = [];
+        for (const plugin of this.plugins.values()) {
+            if (await plugin.isActive(baseDir)) {
+                active.push(plugin);
+            }
+        }
+        return active;
     }
-    return active;
-  }
 }

package/src/plugins/ecosystems/TypeScriptPlugin.js

@@ -0,0 +1,56 @@
+import path from 'path';
+import fs from 'fs/promises';
+import { BasePlugin } from '../BasePlugin.js';
+
+/**
+ * TypeScript Plugin for pkg-scaffold.
+ * Handles tsconfig.json detection and TypeScript-specific entry points.
+ */
+export class TypeScriptPlugin extends BasePlugin {
+    get name() {
+        return 'typescript';
+    }
+
+    getConfigFiles() {
+        return ['tsconfig.json', 'tsconfig.base.json', 'tsconfig.eslint.json'];
+    }
+
+    getRoutePatterns() {
+        // Common TypeScript entry points and declaration files
+        return [
+            /src\/index\.ts$/,
+            /src\/main\.ts$/,
+            /src\/lib\.ts$/,
+            /.*\.d\.ts$/
+        ];
+    }
+
+    getRequiredSystemContracts() {
+        // TypeScript specific implicit exports or requirements
+        return ['default'];
+    }
+
+    /**
+     * Custom Getter for v3.2.0: Get the compiler version from the project.
+     */
+    async getCompilerVersion() {
+        try {
+            const packageJsonPath = path.join(this.context.cwd, 'package.json');
+            const content = await fs.readFile(packageJsonPath, 'utf8');
+            const pkg = JSON.parse(content);
+            return pkg.devDependencies?.typescript || pkg.dependencies?.typescript || 'unknown';
+        } catch {
+            return 'not installed';
+        }
+    }
+
+    async isActive(baseDir) {
+        for (const file of this.getConfigFiles()) {
+            try {
+                await fs.access(path.join(baseDir, file));
+                return true;
+            } catch {}
+        }
+        return false;
+    }
+}