create-ngis-plugin 0.1.0

package/dist/templates/plugin-starter/src/plugin.ts

@@ -0,0 +1,65 @@
+/**
+ * `org.example.my-plugin` — the NGIS plugin-starter template's example plugin
+ * (Stage 11 E3, DevKit). Rename `manifest.id` (and this file's contents) to
+ * build your own; see `../README.md` for the full authoring walkthrough.
+ *
+ * Kept dependency-free on purpose (no React, no map-mount, one file) so
+ * `npm run package` and `npm test` both work with nothing but
+ * the bundled authoring declarations — the same "framework-agnostic, node-testable"
+ * discipline the first-party `ngis.sample-coordinate-pin` demo plugin follows
+ * in the main `ngis-frontend` repo.
+ */
+
+import { defineNgisPlugin, type NgisPlugin } from "@ngis/plugin-sdk";
+
+export const PANEL_ID = "org.example.my-plugin.main";
+export const OPEN_PANEL_TOOL_ID = "org.example.my-plugin.open";
+
+const plugin: NgisPlugin = defineNgisPlugin({
+  manifest: {
+    // Must contain a "." (namespaced) — the server enforces
+    // `^[a-z0-9-]+(\.[a-z0-9-]+)+$`; `ngis.*` is reserved for first-party.
+    id: "org.example.my-plugin",
+    name: "My NGIS Plugin",
+    version: "0.1.0",
+    // The lowest NGIS_MAP_API_VERSION your plugin needs. Read it from
+    // `@ngis/plugin-sdk`'s own `NGIS_MAP_API_VERSION` at authoring time if
+    // you want "whatever this SDK version was built against"; hardcoding a
+    // lower value here is fine (and often correct) if you only use an older
+    // facet surface.
+    minNgisVersion: "0.4.0",
+    capabilities: {
+      panels: [
+        {
+          id: PANEL_ID,
+          slot: "right",
+          label: "My NGIS Plugin",
+          render: (container) => {
+            container.replaceChildren();
+            const content = document.createElement("div");
+            content.style.padding = "16px";
+            content.textContent = "Your UI plugin panel is running.";
+            container.appendChild(content);
+            return () => container.replaceChildren();
+          },
+        },
+      ],
+      railTools: [
+        {
+          id: OPEN_PANEL_TOOL_ID,
+          // Literal string, not an i18n key — third-party plugins have no
+          // message catalog to point at.
+          label: "Open My NGIS Plugin",
+          kind: "action",
+          invoke: (ctx) => {
+            ctx.api.panels.open("right", PANEL_ID);
+          },
+        },
+      ],
+    },
+  },
+});
+
+// The bundle contract (ED16c) requires a default export — the loader's
+// `import()` reads `module.default` as the `NgisPlugin`.
+export default plugin;

package/dist/templates/plugin-starter/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["ES2020", "DOM"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "include": ["src"]
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "create-ngis-plugin",
+  "version": "0.1.0",
+  "description": "Create a buildable NeoGIS plugin from an official starter template.",
+  "license": "Apache-2.0",
+  "private": false,
+  "type": "module",
+  "bin": {
+    "create-ngis-plugin": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GeoScenarioScripter/NeoGIS-Frontend.git",
+    "directory": "packages/create-ngis-plugin"
+  },
+  "homepage": "https://github.com/GeoScenarioScripter/NeoGIS-Frontend#readme",
+  "bugs": {
+    "url": "https://github.com/GeoScenarioScripter/NeoGIS-Frontend/issues"
+  },
+  "keywords": [
+    "neogis",
+    "plugin",
+    "scaffold",
+    "cli"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "prepack": "npm run build",
+    "test": "node --test test/cli-core.test.mjs test/generate.test.mjs test/package.test.mjs test/e2e-tarballs.test.mjs"
+  }
+}