add plugin template

Author: yuval-hazaz

plugin-templates/blueprint/README.md

@@ -0,0 +1,9 @@
+# {{PLUGIN_DISPLAY_NAME}}
+
+## Overview
+
+{{PLUGIN_DESCRIPTION}}
+
+## Domain
+
+{{PLUGIN_DOMAIN}}

plugin-templates/blueprint/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@amplication/plugin-{{PLUGIN_KEBAB_CASE_NAME}}",
+  "version": "0.0.1",
+  "description": "{{PLUGIN_DESCRIPTION}}",
+  "main": "dist/index.js",
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "dev": "webpack --watch",
+    "build": "webpack",
+    "prebuild": "rimraf dist",
+    "lint": "eslint . --ext .ts,.js",
+    "lint:fix": "eslint . --ext .ts,.js --fix",
+    "format": "prettier --write \"src/**/*.{ts,js,json,md}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,js,json,md}\""
+  },
+  "author": "{{PLUGIN_AUTHOR}}",
+  "license": "{{PLUGIN_LICENSE}}",
+  "devDependencies": {
+    "@amplication/code-gen-types": "^3.2.1",
+    "@amplication/code-gen-utils": "^0.0.9",
+    "@amplication/csharp-ast": "^0.0.7",
+    "@babel/parser": "^7.23.0",
+    "@babel/types": "^7.23.0",
+    "@types/lodash": "^4.14.200",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "copy-webpack-plugin": "^12.0.2",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "jest-mock-extended": "^3.0.5",
+    "lodash": "^4.17.21",
+    "prettier": "^3.3.3",
+    "rimraf": "^5.0.5",
+    "ts-loader": "^9.5.0",
+    "typescript": "^5.2.2",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4",
+    "pascal-case": "^3.1.2"
+  }
+}

plugin-templates/blueprint/src/constants.ts

@@ -0,0 +1 @@
+export const PLUGIN_ID = "{{PLUGIN_KEBAB_CASE_NAME}}";

plugin-templates/blueprint/src/index.ts

@@ -0,0 +1,69 @@
+import {
+  blueprintPluginEventsParams as blueprint,
+  blueprintPluginEventsTypes,
+  blueprintTypes,
+  IFile,
+} from "@amplication/code-gen-types";
+import { CodeBlock } from "@amplication/csharp-ast";
+import { resolve } from "path";
+import { pascalCase } from "pascal-case";
+
+class PluginName implements blueprintTypes.AmplicationPlugin {
+  register(): blueprintPluginEventsTypes.BlueprintEvents {
+    return {
+      createBlueprint: {
+        before: this.beforeCreateBlueprint,
+      },
+    };
+  }
+  async beforeCreateBlueprint(
+    context: blueprintTypes.DsgContext,
+    eventParams: blueprint.CreateBlueprintParams,
+  ): Promise<blueprint.CreateBlueprintParams> {
+    context.logger.info("Generating Files from PluginName...");
+
+    const params = {} as Record<string, string>;
+
+    params.SERVICE_DISPLAY_NAME = context.resourceInfo?.name || "Service Name";
+    params.SERVICE_NAME = pascalCase(params.SERVICE_DISPLAY_NAME);
+
+    //resource catalog properties
+    const resourceCatalogProperties = (context.resourceInfo?.properties ||
+      {}) as Record<string, string>;
+    const resourceSetting = (context.resourceSettings?.properties ||
+      ({} as Record<string, string>)) as Record<string, string>;
+
+    //all catalog and resource settings are available for use in the template
+    const placeholders = {
+      ...params,
+      ...resourceCatalogProperties,
+      ...resourceSetting,
+    };
+
+    const stringReplacements = {
+      ServiceName: params.SERVICE_NAME,
+    };
+
+    // set the path to the static files and fetch them for manipulation
+    const staticPath = resolve(__dirname, "./static");
+    const files = await context.utils.importStaticFilesWithReplacements(
+      staticPath,
+      ".",
+      placeholders,
+      stringReplacements,
+    );
+
+    for (const file of files.getAll()) {
+      const codeBlock: IFile<CodeBlock> = {
+        path: file.path,
+        code: new CodeBlock({
+          code: file.code,
+        }),
+      };
+      context.files.set(codeBlock);
+    }
+    return eventParams;
+  }
+}
+
+export default PluginName;

plugin-templates/blueprint/src/tests/.keep

@@ -0,0 +1 @@
+export interface Settings {}

plugin-templates/blueprint/src/types.ts

@@ -0,0 +1,21 @@
+import { PluginInstallation } from "@amplication/code-gen-types";
+import { Settings } from "./types";
+import defaultSettings from "../.amplicationrc.json";
+import { PLUGIN_ID } from "./constants";
+
+export const getPluginSettings = (
+  pluginInstallations: PluginInstallation[],
+): Settings => {
+  const plugin = pluginInstallations.find(
+    (plugin) => plugin.pluginId === PLUGIN_ID,
+  );
+
+  const userSettings = plugin?.settings ?? {};
+
+  const settings: Settings = {
+    ...defaultSettings.settings,
+    ...userSettings,
+  };
+
+  return settings;
+};

plugin-templates/blueprint/src/utils.ts

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2021", // Latest features supported by Node.js
+    "module": "CommonJS", // CommonJS for Node.js compatibility
+    "lib": ["ES2021"], // Use modern ECMAScript features
+    "strict": true, // Enable strict type-checking
+    "esModuleInterop": true, // Allow default imports from CommonJS modules
+    "skipLibCheck": true, // Skip type checks for declaration files
+    "forceConsistentCasingInFileNames": true, // Enforce consistent casing
+    "outDir": "dist", // Output directory for compiled files
+    "rootDir": "src", // Root directory for source files
+    "declaration": true, // Generate .d.ts files for TypeScript definitions
+    "moduleResolution": "node", // Resolve modules in Node.js style
+    "resolveJsonModule": true, // Support importing JSON files
+    "allowSyntheticDefaultImports": true, // Allow default imports with interop
+    "noImplicitAny": true, // Disallow `any` unless explicitly stated
+    "noUnusedLocals": true, // Warn about unused local variables
+    "noFallthroughCasesInSwitch": true // Prevent fallthrough in switch statements
+  },
+  "include": ["src/**/*"], // Include all files in the src directory
+  "exclude": ["node_modules", "dist", "src/static", "static"] // Exclude unnecessary and template files
+}

plugin-templates/blueprint/static/.keep

@@ -0,0 +1,44 @@
+const path = require("path");
+const webpack = require("webpack");
+const CopyWebpackPlugin = require("copy-webpack-plugin");
+
+/** @type {import("webpack").Configuration} */
+module.exports = {
+  mode: "production",
+  target: "node",
+  entry: "./src/index.ts",
+  externals: ["@amplication/code-gen-utils"],
+  plugins: [
+    new webpack.SourceMapDevToolPlugin({
+      filename: "[name].js.map",
+    }),
+    new CopyWebpackPlugin({
+      patterns: [
+        { from: "static", to: "static", noErrorOnMissing: true },
+        { from: "src/static", to: "static", noErrorOnMissing: true },
+        { from: "src/templates", to: "templates", noErrorOnMissing: true },
+      ],
+    }),
+  ],
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: "ts-loader",
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: [".ts", ".js", ".json"],
+  },
+  optimization: {
+    minimize: false,
+  },
+  output: {
+    filename: "index.js",
+    path: path.resolve(__dirname, "dist"),
+    libraryTarget: "commonjs2",
+    clean: true,
+  },
+};