@object-ui/create-plugin 0.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ObjectQL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# @object-ui/create-plugin
+
+CLI tool to quickly scaffold new ObjectUI plugins with best practices.
+
+## Usage
+
+```bash
+# Using pnpm
+pnpm create @object-ui/plugin my-plugin
+
+# Using npm
+npm create @object-ui/plugin my-plugin
+
+# Using npx
+npx @object-ui/create-plugin my-plugin
+```
+
+## What Gets Generated
+
+The tool creates a complete plugin package structure:
+
+```
+packages/plugin-my-plugin/
+├── src/
+│   ├── index.tsx           # Plugin export & registration
+│   ├── MyPluginImpl.tsx    # Component implementation
+│   ├── MyPluginImpl.test.tsx # Tests
+│   └── types.ts            # Schema definitions
+├── package.json
+├── tsconfig.json
+├── vite.config.ts
+└── README.md
+```
+
+## Features
+
+- ✅ TypeScript support out of the box
+- ✅ Vite build configuration
+- ✅ Component registration with ComponentRegistry
+- ✅ Test setup with Vitest
+- ✅ Proper package.json with workspace dependencies
+- ✅ README template
+- ✅ Type definitions
+
+## Interactive Mode
+
+Run without arguments for interactive prompts:
+
+```bash
+pnpm create @object-ui/plugin
+```
+
+You'll be prompted for:
+- Plugin name
+- Description
+- Author name
+
+## Options
+
+```bash
+pnpm create @object-ui/plugin my-plugin --description "My awesome plugin" --author "Your Name"
+```
+
+## After Creation
+
+1. Navigate to the plugin directory:
+   ```bash
+   cd packages/plugin-my-plugin
+   ```
+
+2. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+3. Build the plugin:
+   ```bash
+   pnpm build
+   ```
+
+4. Run tests:
+   ```bash
+   pnpm test
+   ```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/index.js

@@ -0,0 +1,331 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import { Command } from "commander";
+import chalk from "chalk";
+import prompts from "prompts";
+import * as path from "path";
+import fs from "fs-extra";
+import { fileURLToPath } from "url";
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = path.dirname(__filename);
+var program = new Command();
+async function createPlugin(pluginName, options = {}) {
+  console.log(chalk.blue("\n\u{1F680} ObjectUI Plugin Generator\n"));
+  if (!pluginName) {
+    const response = await prompts({
+      type: "text",
+      name: "name",
+      message: "Plugin name (without prefix):",
+      validate: (value) => {
+        if (value.length === 0) return "Plugin name is required";
+        if (!/^[a-z0-9-]+$/.test(value)) {
+          return "Plugin name must contain only lowercase letters, numbers, and hyphens";
+        }
+        if (value.includes("..") || value.includes("/") || value.includes("\\")) {
+          return 'Plugin name cannot contain path separators or ".."';
+        }
+        return true;
+      }
+    });
+    pluginName = response.name;
+    if (!pluginName) {
+      console.log(chalk.red("\n\u274C Plugin name is required"));
+      process.exit(1);
+    }
+  }
+  if (!/^[a-z0-9-]+$/.test(pluginName)) {
+    console.log(chalk.red("\n\u274C Plugin name must contain only lowercase letters, numbers, and hyphens"));
+    process.exit(1);
+  }
+  if (pluginName.includes("..") || pluginName.includes("/") || pluginName.includes("\\") || path.isAbsolute(pluginName)) {
+    console.log(chalk.red("\n\u274C Invalid plugin name: path traversal detected"));
+    process.exit(1);
+  }
+  const cleanName = pluginName.replace(/^plugin-/, "").replace(/^-+|-+$/g, "").replace(/-{2,}/g, "-");
+  if (cleanName.length === 0) {
+    console.log(chalk.red("\n\u274C Plugin name cannot be empty after sanitization"));
+    process.exit(1);
+  }
+  const fullPackageName = `plugin-${cleanName}`;
+  const pascalCaseName = cleanName.split("-").filter((part) => part.length > 0).map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join("");
+  const answers = await prompts([
+    {
+      type: "text",
+      name: "description",
+      message: "Plugin description:",
+      initial: options.description || `${pascalCaseName} plugin for ObjectUI`
+    },
+    {
+      type: "text",
+      name: "author",
+      message: "Author name:",
+      initial: options.author || ""
+    }
+  ]);
+  const targetDir = path.join(process.cwd(), "packages", fullPackageName);
+  if (fs.existsSync(targetDir)) {
+    console.log(chalk.red(`
+\u274C Directory already exists: ${targetDir}`));
+    process.exit(1);
+  }
+  console.log(chalk.green(`
+\u2728 Creating plugin: ${fullPackageName}...
+`));
+  fs.mkdirpSync(targetDir);
+  fs.mkdirpSync(path.join(targetDir, "src"));
+  const templateDir = path.join(__dirname, "..", "templates", "plugin");
+  const vars = {
+    PACKAGE_NAME: `@object-ui/${fullPackageName}`,
+    PLUGIN_NAME: cleanName,
+    PASCAL_NAME: pascalCaseName,
+    DESCRIPTION: answers.description,
+    AUTHOR: answers.author,
+    VERSION: "0.1.0",
+    YEAR: (/* @__PURE__ */ new Date()).getFullYear()
+  };
+  const packageJson = {
+    name: vars.PACKAGE_NAME,
+    version: vars.VERSION,
+    type: "module",
+    license: "MIT",
+    description: vars.DESCRIPTION,
+    main: "dist/index.umd.cjs",
+    module: "dist/index.js",
+    types: "dist/index.d.ts",
+    exports: {
+      ".": {
+        types: "./dist/index.d.ts",
+        import: "./dist/index.js",
+        require: "./dist/index.umd.cjs"
+      }
+    },
+    scripts: {
+      build: "vite build",
+      test: "vitest run",
+      lint: "eslint ."
+    },
+    dependencies: {
+      "@object-ui/components": "workspace:*",
+      "@object-ui/core": "workspace:*",
+      "@object-ui/react": "workspace:*",
+      "@object-ui/types": "workspace:*",
+      "lucide-react": "^0.563.0"
+    },
+    peerDependencies: {
+      react: "^18.0.0 || ^19.0.0",
+      "react-dom": "^18.0.0 || ^19.0.0"
+    },
+    devDependencies: {
+      "@vitejs/plugin-react": "^4.2.1",
+      typescript: "^5.9.3",
+      vite: "^7.3.1",
+      "vite-plugin-dts": "^4.5.4",
+      vitest: "^4.0.18"
+    }
+  };
+  fs.writeFileSync(
+    path.join(targetDir, "package.json"),
+    JSON.stringify(packageJson, null, 2)
+  );
+  const tsconfig = {
+    extends: "../../tsconfig.json",
+    compilerOptions: {
+      outDir: "./dist",
+      rootDir: "./src",
+      declaration: true,
+      declarationMap: true
+    },
+    include: ["src/**/*"],
+    exclude: ["node_modules", "dist", "**/*.test.ts", "**/*.test.tsx"]
+  };
+  fs.writeFileSync(
+    path.join(targetDir, "tsconfig.json"),
+    JSON.stringify(tsconfig, null, 2)
+  );
+  const viteConfig = `import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+import dts from 'vite-plugin-dts';
+import * as path from 'path';
+
+export default defineConfig({
+  plugins: [
+    react(),
+    dts({
+      insertTypesEntry: true,
+    }),
+  ],
+  build: {
+    lib: {
+      entry: path.resolve(__dirname, 'src/index.tsx'),
+      name: '${pascalCaseName}',
+      formats: ['es', 'umd'],
+      fileName: (format) => \`index.\${format === 'es' ? 'js' : 'umd.cjs'}\`,
+    },
+    rollupOptions: {
+      external: ['react', 'react-dom', 'react/jsx-runtime'],
+      output: {
+        globals: {
+          react: 'React',
+          'react-dom': 'ReactDOM',
+        },
+      },
+    },
+  },
+});
+`;
+  fs.writeFileSync(path.join(targetDir, "vite.config.ts"), viteConfig);
+  const readme = `# ${vars.PACKAGE_NAME}
+
+${vars.DESCRIPTION}
+
+## Installation
+
+\`\`\`bash
+pnpm add ${vars.PACKAGE_NAME}
+\`\`\`
+
+## Usage
+
+\`\`\`tsx
+import { ${pascalCaseName} } from '${vars.PACKAGE_NAME}';
+
+// Use the component
+<${pascalCaseName} />
+\`\`\`
+
+## Development
+
+\`\`\`bash
+# Build the plugin
+pnpm build
+
+# Run tests
+pnpm test
+
+# Lint code
+pnpm lint
+\`\`\`
+
+## License
+
+MIT \xA9 ${vars.AUTHOR}
+`;
+  fs.writeFileSync(path.join(targetDir, "README.md"), readme);
+  const indexFile = `/**
+ * ObjectUI
+ * Copyright (c) ${vars.YEAR}-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import React from 'react';
+import { ComponentRegistry } from '@object-ui/core';
+import { ${pascalCaseName} } from './${pascalCaseName}Impl';
+
+export { ${pascalCaseName} };
+export type { ${pascalCaseName}Props } from './${pascalCaseName}Impl';
+
+// Register component with ComponentRegistry
+const ${pascalCaseName}Renderer: React.FC<{ schema: any }> = ({ schema }) => {
+  return <${pascalCaseName} {...schema} />;
+};
+
+ComponentRegistry.register('${cleanName}', ${pascalCaseName}Renderer, {
+  label: '${pascalCaseName}',
+  category: 'plugin',
+  inputs: [
+    // Define your component inputs here
+  ],
+  defaultProps: {
+    // Define default props here
+  }
+});
+`;
+  fs.writeFileSync(path.join(targetDir, "src", "index.tsx"), indexFile);
+  const implFile = `/**
+ * ObjectUI
+ * Copyright (c) ${vars.YEAR}-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import React from 'react';
+
+export interface ${pascalCaseName}Props {
+  // Define your props here
+  className?: string;
+}
+
+/**
+ * ${pascalCaseName} component
+ */
+export const ${pascalCaseName}: React.FC<${pascalCaseName}Props> = ({ className }) => {
+  return (
+    <div className={className}>
+      <h2>${pascalCaseName} Plugin</h2>
+      <p>Implement your plugin logic here.</p>
+    </div>
+  );
+};
+`;
+  fs.writeFileSync(
+    path.join(targetDir, "src", `${pascalCaseName}Impl.tsx`),
+    implFile
+  );
+  const typesFile = `/**
+ * ObjectUI
+ * Copyright (c) ${vars.YEAR}-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * Schema definition for ${pascalCaseName}
+ */
+export interface ${pascalCaseName}Schema {
+  type: '${cleanName}';
+  id?: string;
+  className?: string;
+  // Add schema properties here
+}
+`;
+  fs.writeFileSync(path.join(targetDir, "src", "types.ts"), typesFile);
+  const testFile = `/**
+ * ObjectUI
+ * Copyright (c) ${vars.YEAR}-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { describe, it, expect } from 'vitest';
+import { render, screen } from '@testing-library/react';
+import React from 'react';
+import { ${pascalCaseName} } from './${pascalCaseName}Impl';
+
+describe('${pascalCaseName}', () => {
+  it('should render', () => {
+    render(<${pascalCaseName} />);
+    expect(screen.getByText('${pascalCaseName} Plugin')).toBeInTheDocument();
+  });
+});
+`;
+  fs.writeFileSync(
+    path.join(targetDir, "src", `${pascalCaseName}Impl.test.tsx`),
+    testFile
+  );
+  console.log(chalk.green("\u2705 Plugin created successfully!\n"));
+  console.log(chalk.blue("Next steps:\n"));
+  console.log(chalk.gray(`  cd packages/${fullPackageName}`));
+  console.log(chalk.gray("  pnpm install"));
+  console.log(chalk.gray("  pnpm build\n"));
+  console.log(chalk.blue("To use the plugin:\n"));
+  console.log(chalk.gray(`  import { ${pascalCaseName} } from '${vars.PACKAGE_NAME}';
+`));
+}
+program.name("create-plugin").description("Create a new ObjectUI plugin").argument("[plugin-name]", "Name of the plugin (without plugin- prefix)").option("-d, --description <description>", "Plugin description").option("-a, --author <author>", "Author name").action(createPlugin);
+program.parse();

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@object-ui/create-plugin",
+  "version": "0.3.1",
+  "description": "CLI tool to scaffold ObjectUI plugins",
+  "type": "module",
+  "license": "MIT",
+  "bin": {
+    "create-plugin": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^14.0.2",
+    "fs-extra": "^11.2.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^25.0.10",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "lint": "eslint ."
+  }
+}