Codify
Plugin Development

Project structure

Organize your plugin project

Project Structure

my-plugin/
├── src/
│   ├── index.ts                 # Plugin entry point
│   ├── resources/
│   │   ├── my-resource/
│   │   │   ├── my-resource.ts
│   │   │   └── my-resource-schema.json
│   │   └── ...
│   └── utils/
├── test/
│   └── my-resource.test.ts
├── package.json
├── tsconfig.json
└── vitest.config.ts

package.json

{
  "name": "my-codify-plugin",
  "version": "1.0.0",
  "type": "module",
  "main": "dist/index.js",
  "dependencies": {
    "@codifycli/plugin-core": "^1.0.0",
    "@codifycli/schemas": "^1.0.0"
  },
  "devDependencies": {
    "@codifycli/plugin-test": "^1.0.0",
    "typescript": "^5.0.0",
    "vitest": "^2.0.0"
  }
}

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "Node16",
    "moduleResolution": "Node16",
    "outDir": "dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist", "test"]
}

On this page