create-ampless 1.0.0-alpha.78 → 1.0.0-alpha.80

package/dist/templates/plugin-standalone/README.md

@@ -0,0 +1,43 @@
+> 日本語版: [README.ja.md](./README.ja.md)
+
+# {{packageName}}
+
+> [Pre-release / alpha] {{description}}
+
+## Install
+
+```bash
+npm install {{packageName}}@alpha
+```
+
+## Configure
+
+```typescript
+// cms.config.ts
+import { defineConfig } from 'ampless'
+import {{nameCamelCase}}Plugin from '{{packageName}}'
+
+export default defineConfig({
+  // ...
+  plugins: [
+    {{nameCamelCase}}Plugin(),
+  ],
+})
+```
+
+Then go to `/admin/plugins` to configure.
+
+## Trust level
+
+`{{trustLevel}}`. Capabilities: `{{capabilitiesList}}`.
+
+## Publishing
+
+```bash
+pnpm install
+pnpm test
+pnpm build
+pnpm publish --access public --tag alpha
+```
+
+See the [ampless plugin author guide](https://github.com/heavymoons/ampless/blob/main/packages/ampless/docs/plugin-author-guide.md) for the full API.

package/dist/templates/plugin-standalone/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "{{packageName}}",
+  "version": "0.1.0",
+  "description": {{descriptionJson}},
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests"
+  },
+  "dependencies": {
+    "ampless": "^{{amplessVersion}}"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.7.0",
+    "vitest": "^4.1.7"
+  },
+  "keywords": [
+    "ampless",
+    "plugin",
+    "ampless-plugin"
+  ],
+  "amplessPlugin": {
+    "apiVersion": 1,
+    "name": "{{nameKebab}}",
+    "trustLevel": "{{trustLevel}}",
+    "capabilities": [{{capabilitiesJsonArray}}],
+    "displayName": { "en": "{{DisplayName}}", "ja": "{{displayNameJa}}" }
+  }
+}

package/dist/templates/plugin-standalone/src/index.test.ts

@@ -0,0 +1,16 @@
+import { describe, it, expect } from 'vitest'
+import {{nameCamelCase}}Plugin from './index.js'
+
+describe('{{nameCamelCase}}Plugin', () => {
+  it('returns a plugin with the declared name + apiVersion', () => {
+    const plugin = {{nameCamelCase}}Plugin()
+    expect(plugin.name).toBe('{{nameKebab}}')
+    expect(plugin.apiVersion).toBe(1)
+    expect(plugin.trust_level).toBe('{{trustLevel}}')
+  })
+
+  it('honors an explicit instanceId', () => {
+    const plugin = {{nameCamelCase}}Plugin({ instanceId: 'custom-instance' })
+    expect(plugin.instanceId).toBe('custom-instance')
+  })
+})

package/dist/templates/plugin-standalone/src/index.ts

@@ -0,0 +1,29 @@
+import { definePlugin, type AmplessPlugin } from 'ampless'
+
+export interface {{NameCamelCase}}Options {
+  /** Optional namespace when registering multiple instances. */
+  instanceId?: string
+  // TODO: add the constructor options your plugin needs.
+}
+
+/**
+ * {{description}}
+ */
+export default function {{nameCamelCase}}Plugin(
+  options: {{NameCamelCase}}Options = {}
+): AmplessPlugin {
+  const instanceId = options.instanceId ?? '{{nameKebab}}'
+  return definePlugin({
+    name: '{{nameKebab}}',
+    packageName: '{{packageName}}',
+    instanceId,
+    apiVersion: 1,
+    trust_level: '{{trustLevel}}',
+    displayName: { en: '{{DisplayName}}', ja: '{{displayNameJa}}' },
+    capabilities: [{{capabilitiesList}}],
+    // TODO: implement the surfaces declared in `capabilities`. The
+    // most common starting point is `publicHead(ctx)` returning a
+    // descriptor array. See:
+    //   https://github.com/heavymoons/ampless/blob/main/packages/ampless/docs/plugin-author-guide.md
+  })
+}

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

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2022", "DOM"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "verbatimModuleSyntax": true
+  },
+  "include": ["src"]
+}

package/dist/templates/plugin-standalone/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  format: ['esm'],
+  dts: true,
+  clean: true,
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ampless",
-  "version": "1.0.0-alpha.78",
+  "version": "1.0.0-alpha.80",
   "description": "Create a new ampless project",
   "license": "MIT",
   "type": "module",