68ba24d91f
### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
116 lines
3.4 KiB
JSON
116 lines
3.4 KiB
JSON
{
|
|
"name": "plugin-package-name-placeholder",
|
|
"version": "1.0.0",
|
|
"description": "A blank template to get started with Payload 3.0",
|
|
"license": "MIT",
|
|
"type": "module",
|
|
"exports": {
|
|
".": {
|
|
"import": "./src/exports/index.ts",
|
|
"types": "./src/exports/index.ts",
|
|
"default": "./src/exports/index.ts"
|
|
},
|
|
"./client": {
|
|
"import": "./src/exports/client.ts",
|
|
"types": "./src/exports/client.ts",
|
|
"default": "./src/exports/client.ts"
|
|
},
|
|
"./rsc": {
|
|
"import": "./src/exports/rsc.ts",
|
|
"types": "./src/exports/rsc.ts",
|
|
"default": "./src/exports/rsc.ts"
|
|
}
|
|
},
|
|
"main": "./src/exports/index.ts",
|
|
"types": "./src/exports/index.ts",
|
|
"files": [
|
|
"dist"
|
|
],
|
|
"scripts": {
|
|
"build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
|
|
"build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
|
|
"build:types": "tsc --outDir dist --rootDir ./src",
|
|
"clean": "rimraf {dist,*.tsbuildinfo}",
|
|
"copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
|
|
"dev": "next dev dev --turbo",
|
|
"dev:generate-importmap": "pnpm dev:payload generate:importmap",
|
|
"dev:generate-types": "pnpm dev:payload generate:types",
|
|
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
|
|
"lint": "eslint",
|
|
"lint:fix": "eslint ./src --fix",
|
|
"prepublishOnly": "pnpm clean && pnpm build",
|
|
"test": "pnpm test:int && pnpm test:e2e",
|
|
"test:e2e": "playwright test",
|
|
"test:int": "vitest"
|
|
},
|
|
"devDependencies": {
|
|
"@eslint/eslintrc": "^3.2.0",
|
|
"@payloadcms/db-mongodb": "3.37.0",
|
|
"@payloadcms/db-postgres": "3.37.0",
|
|
"@payloadcms/db-sqlite": "3.37.0",
|
|
"@payloadcms/eslint-config": "3.9.0",
|
|
"@payloadcms/next": "3.37.0",
|
|
"@payloadcms/richtext-lexical": "3.37.0",
|
|
"@payloadcms/ui": "3.37.0",
|
|
"@playwright/test": "^1.52.0",
|
|
"@swc-node/register": "1.10.9",
|
|
"@swc/cli": "0.6.0",
|
|
"@types/node": "^22.5.4",
|
|
"@types/react": "19.1.0",
|
|
"@types/react-dom": "19.1.2",
|
|
"copyfiles": "2.4.1",
|
|
"cross-env": "^7.0.3",
|
|
"eslint": "^9.23.0",
|
|
"eslint-config-next": "15.3.0",
|
|
"graphql": "^16.8.1",
|
|
"mongodb-memory-server": "^10.1.2",
|
|
"next": "15.3.0",
|
|
"open": "^10.1.0",
|
|
"payload": "3.37.0",
|
|
"prettier": "^3.4.2",
|
|
"qs-esm": "7.0.2",
|
|
"react": "19.1.0",
|
|
"react-dom": "19.1.0",
|
|
"rimraf": "3.0.2",
|
|
"sharp": "0.32.6",
|
|
"sort-package-json": "^2.10.0",
|
|
"typescript": "5.7.3",
|
|
"vite-tsconfig-paths": "^5.1.4",
|
|
"vitest": "^3.1.2"
|
|
},
|
|
"peerDependencies": {
|
|
"payload": "^3.37.0"
|
|
},
|
|
"engines": {
|
|
"node": "^18.20.2 || >=20.9.0",
|
|
"pnpm": "^9 || ^10"
|
|
},
|
|
"publishConfig": {
|
|
"exports": {
|
|
".": {
|
|
"import": "./dist/exports/index.js",
|
|
"types": "./dist/exports/index.d.ts",
|
|
"default": "./dist/exports/index.js"
|
|
},
|
|
"./client": {
|
|
"import": "./dist/exports/client.js",
|
|
"types": "./dist/exports/client.d.ts",
|
|
"default": "./dist/exports/client.js"
|
|
},
|
|
"./rsc": {
|
|
"import": "./dist/exports/rsc.js",
|
|
"types": "./dist/exports/rsc.d.ts",
|
|
"default": "./dist/exports/rsc.js"
|
|
}
|
|
},
|
|
"main": "./dist/exports/index.js",
|
|
"types": "./dist/exports/index.d.ts"
|
|
},
|
|
"pnpm": {
|
|
"onlyBuiltDependencies": [
|
|
"sharp"
|
|
]
|
|
},
|
|
"registry": "https://registry.npmjs.org/"
|
|
}
|