IntecionSoftware/ipal-kit
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Admin
2026-08-02 21:34:35 +00:00
parent 2f52349d63
commit af8cc91a6b
1 changed files with 122 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+123 -181
View File
@@ -1,218 +1,160 @@
# Payload Plugin Template # @intecion/ipal-kit
A template repo to create a [Payload CMS](https://payloadcms.com) plugin. Intecion Payload Advanced Library — plugin do Payload CMS 3. Dostarcza i18n
(routing per-locale, hreflang, przełącznik języka), SEO (metadane, canonical,
sitemapa, robots), formularze (Turnstile, rate limit, walidacja), consent mode,
analytics (GA4/GTM), oraz system bloga/archiwów (kolekcje pod stroną-archiwum,
listing, paginacja).
Payload is built with a robust infrastructure intended to support Plugins with ease. This provides a simple, modular, and reusable way for developers to extend the core capabilities of Payload. Repozytorium: https://git.intecion.net/IntecionSoftware/ipal-kit
(dostęp tylko dla zalogowanych pracowników Intecion).
To build your own Payload plugin, all you need is: ---
- An understanding of the basic Payload concepts ## Instalacja
- And some JavaScript/Typescript experience
## Background > **Serwer jest prywatny.** Zarówno kod, jak i pakiet w Gitea są widoczne tylko
> po zalogowaniu. Każdy sposób instalacji wymaga tokenu dostępu (PAT) z konta
> pracownika. Bez niego instalacja zwróci 404 albo błąd autoryzacji.
Here is a short recap on how to integrate plugins with Payload, to learn more visit the [plugin overview page](https://payloadcms.com/docs/plugins/overview). ### Krok 1 — token dostępu (raz na osobę)
### How to install a plugin W Gitea: **Ustawienia → Aplikacje → Wygeneruj token dostępu**. Nadaj zakresy:
- `read:package` — do instalacji (wystarczy pracownikowi)
- `write:package` — dodatkowo, jeśli będziesz publikować wydania
To install any plugin, simply add it to your payload.config() in the Plugin array. Skopiuj token (pokazuje się raz).
```ts ### Krok 2 — wybierz drogę instalacji
import myPlugin from 'my-plugin'
export const config = buildConfig({ Dwie drogi. **A (rejestr Gitea)** jest zalecana dla zespołu — daje wersjonowanie
plugins: [ i szybką instalację gotowego builda. **B (bezpośrednio z git)** nie wymaga
// You can pass options to the plugin publikowania, ale buduje/pobiera z repo.
myPlugin({
enabled: true, ---
}),
], ## Droga A — rejestr npm w Gitea (zalecana)
})
Gitea ma wbudowany rejestr npm. Publikujesz zbudowany pakiet, pracownicy pobierają
gotowy `dist` — bez budowania u siebie.
### Konfiguracja u pracownika (instalacja)
`.npmrc` w projekcie **albo** globalnie (`~/.npmrc`):
```
@intecion:registry=https://git.intecion.net/api/packages/IntecionSoftware/npm/
//git.intecion.net/api/packages/IntecionSoftware/npm/:_authToken=${GITEA_TOKEN}
``` ```
### Initialization Token w zmiennej środowiskowej (bezpieczniej niż wpisany wprost — `.npmrc` można
wtedy nawet zacommitować):
The initialization process goes in the following order: ```bash
# ~/.zshrc
1. Incoming config is validated export GITEA_TOKEN=twój_token_z_gitea
2. **Plugins execute**
3. Default options are integrated
4. Sanitization cleans and validates data
5. Final config gets initialized
## Building the Plugin
When you build a plugin, you are purely building a feature for your project and then abstracting it outside of the project.
### Template Files
In the Payload [plugin template](https://github.com/payloadcms/payload/tree/3.x/templates/plugin), you will see a common file structure that is used across all plugins:
1. root folder
2. /src folder
3. /dev folder
#### Root
In the root folder, you will see various files that relate to the configuration of the plugin. We set up our environment in a similar manner in Payload core and across other projects, so hopefully these will look familiar:
- **README**.md\* - This contains instructions on how to use the template. When you are ready, update this to contain instructions on how to use your Plugin.
- **package**.json\* - Contains necessary scripts and dependencies. Overwrite the metadata in this file to describe your Plugin.
- .**eslint**.config.js - Eslint configuration for reporting on problematic patterns.
- .**gitignore** - List specific untracked files to omit from Git.
- .**prettierrc**.json - Configuration for Prettier code formatting.
- **tsconfig**.json - Configures the compiler options for TypeScript
- .**swcrc** - Configuration for SWC, a fast compiler that transpiles and bundles TypeScript.
- **vitest**.config.js - Config file for Vitest, defining how tests are run and how modules are resolved
**IMPORTANT\***: You will need to modify these files.
#### Dev
In the dev folder, you’ll find a basic payload project, created with `npx create-payload-app` and the blank template.
**IMPORTANT**: Make a copy of the `.env.example` file and rename it to `.env`. Update the `DATABASE_URL` to match the database you are using and your plugin name. Update `PAYLOAD_SECRET` to a unique string.
**You will not be able to run `pnpm/yarn dev` until you have created this `.env` file.**
`myPlugin` has already been added to the `payload.config()` file in this project.
```ts
plugins: [
myPlugin({
collections: {
posts: true,
},
}),
]
``` ```
Later when you rename the plugin or add additional options, **make sure to update it here**. Instalacja:
You may wish to add collections or expand the test project depending on the purpose of your plugin. Just make sure to keep this dev environment as simplified as possible - users should be able to install your plugin without additional configuration required. ```bash
pnpm add @intecion/ipal-kit
```
When you’re ready to start development, initiate the project with `pnpm/npm/yarn dev` and pull up [http://localhost:3000](http://localhost:3000) in your browser. ### Publikacja (osoba wydająca)
#### Src W `package.json` pluginu (jest już ustawione):
```json
Now that we have our environment setup and we have a dev project ready to - it’s time to build the plugin! "publishConfig": {
"registry": "https://git.intecion.net/api/packages/IntecionSoftware/npm/"
**index.ts**
The essence of a Payload plugin is simply to extend the payload config - and that is exactly what we are doing in this file.
```ts
export const myPlugin =
(pluginOptions: MyPluginConfig) =>
(config: Config): Config => {
// do cool stuff with the config here
return config
} }
``` ```
First, we receive the existing payload config along with any plugin options. `~/.npmrc` z tokenem `write:package`:
```
From here, you can extend the config as you wish. //git.intecion.net/api/packages/IntecionSoftware/npm/:_authToken=${GITEA_TOKEN}
Finally, you return the config and that is it!
##### Spread Syntax
Spread syntax (or the spread operator) is a feature in JavaScript that uses the dot notation **(...)** to spread elements from arrays, strings, or objects into various contexts.
We are going to use spread syntax to allow us to add data to existing arrays without losing the existing data. It is crucial to spread the existing data correctly – else this can cause adverse behavior and conflicts with Payload config and other plugins.
Let’s say you want to build a plugin that adds a new collection:
```ts
config.collections = [
...(config.collections || []),
// Add additional collections here
]
``` ```
First we spread the `config.collections` to ensure that we don’t lose the existing collections, then you can add any additional collections just as you would in a regular payload config. Wydanie:
```bash
This same logic is applied to other properties like admin, hooks, globals: pnpm clean && pnpm build
npm version patch # 1.0.0 → 1.0.1
```ts npm publish
config.globals = [
...(config.globals || []),
// Add additional globals here
]
config.hooks = {
...(incomingConfig.hooks || {}),
// Add additional hooks here
}
``` ```
Some properties will be slightly different to extend, for instance the onInit property: Zaleta rejestru: semver — pnpm zawsze widzi nową wersję, koniec z ręcznym
czyszczeniem cache. `publishConfig` działa poprawnie (exports z dist), nie musisz
ruszać głównego `exports`.
```ts ---
import { onInitExtension } from './onInitExtension' // example file
config.onInit = async (payload) => { ## Droga B — bezpośrednio z repozytorium git
if (incomingConfig.onInit) await incomingConfig.onInit(payload)
// Add additional onInit code by defining an onInitExtension function Bez publikowania. pnpm klonuje repo i bierze zacommitowany `dist`.
onInitExtension(pluginOptions, payload)
} ### Uwierzytelnienie
Serwer prywatny, więc git musi mieć dostęp. Dwie opcje:
**SSH** (jeśli masz klucz w Gitea):
```bash
pnpm add git+ssh://[email protected]:IntecionSoftware/ipal-kit.git
``` ```
If you wish to add to the onInit, you must include the **async/await**. We don’t use spread syntax in this case, instead you must await the existing `onInit` before running additional functionality. **HTTPS z tokenem**:
```bash
In the template, we have stubbed out some addition `onInit` actions that seeds in a document to the `plugin-collection`, you can use this as a base point to add more actions - and if not needed, feel free to delete it. pnpm add git+https://TWÓ[email protected]ecion.net/IntecionSoftware/ipal-kit.git
##### Types.ts
If your plugin has options, you should define and provide types for these options.
```ts
export type MyPluginConfig = {
/**
* List of collections to add a custom field
*/
collections?: Partial<Record<CollectionSlug, true>>
/**
* Disable the plugin
*/
disabled?: boolean
}
``` ```
If possible, include JSDoc comments to describe the options and their types. This allows a developer to see details about the options in their editor. Konkretny tag (stabilniej niż główny branch):
```bash
##### Testing pnpm add git+https://TWÓ[email protected]/IntecionSoftware/ipal-kit.git#v1.0.0
Having a test suite for your plugin is essential to ensure quality and stability. **Vitest** is a fast, modern testing framework that works seamlessly with Vite and supports TypeScript out of the box.
Vitest organizes tests into test suites and cases, similar to other testing frameworks. We recommend creating individual tests based on the expected behavior of your plugin from start to finish.
Writing tests with Vitest is very straightforward, and you can learn more about how it works in the [Vitest documentation.](https://vitest.dev/)
For this template, we stubbed out `int.spec.ts` in the `dev` folder where you can write your tests.
```ts
describe('Plugin tests', () => {
// Create tests to ensure expected behavior from the plugin
it('some condition that must be met', () => {
// Write your test logic here
expect(...)
})
})
``` ```
## Best practices > Nie ma skrótu `gitea:` (jak `github:`). Zawsze pełny URL `git+https://` lub
> `git+ssh://`.
With this tutorial and the plugin template, you should have everything you need to start building your own plugin. ### Wymagania po stronie repo (dla wydającego)
In addition to the setup, here are other best practices aim we follow:
- **Providing an enable / disable option:** For a better user experience, provide a way to disable the plugin without uninstalling it. This is especially important if your plugin adds additional webpack aliases, this will allow you to still let the webpack run to prevent errors. Instalacja z git NIE buduje pakietu, więc:
- **Include tests in your GitHub CI workflow**: If you’ve configured tests for your package, integrate them into your workflow to run the tests each time you commit to the plugin repository. Learn more about [how to configure tests into your GitHub CI workflow.](https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs) - **`dist/` musi być zacommitowany** — zbuduj i zacommituj przed każdym wydaniem
- **Publish your finished plugin to NPM**: The best way to share and allow others to use your plugin once it is complete is to publish an NPM package. This process is straightforward and well documented, find out more [creating and publishing a NPM package here.](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages/). - **BRAK `prepare: pnpm build`** w package.json — inaczej pnpm próbuje budować
- **Add payload-plugin topic tag**: Apply the tag **payload-plugin **to your GitHub repository. This will boost the visibility of your plugin and ensure it gets listed with [existing payload plugins](https://github.com/topics/payload-plugin). i żąda `onlyBuiltDependencies`
- **Use [Semantic Versioning](https://semver.org/) (SemVar)** - With the SemVar system you release version numbers that reflect the nature of changes (major, minor, patch). Ensure all major versions reference their Payload compatibility. - **główny `exports` wskazuje `dist`** (nie `src`) — instalacja z git czyta
główny exports, `publishConfig` jest ignorowane przy git
# Questions ---
Please contact [Payload](mailto:[email protected]) with any questions about using this plugin template. ## Po instalacji (obie drogi)
Dodaj peer-zależności — plugin ich nie zaciąga:
```bash
pnpm add @payloadcms/[email protected] @payloadcms/[email protected] \
nodemailer lucide-react slugify server-only
```
Konfiguracja pluginu, krok po kroku: [docs/getting-started.md](./docs/getting-started.md).
---
## Dokumentacja
Pełna dokumentacja w [docs/](./docs). Start:
- [docs/getting-started.md](./docs/getting-started.md) — od zera do działającego projektu
- [docs/install.md](./docs/install.md) — szczegóły instalacji i diagnostyka
- [docs/README.md](./docs/README.md) — spis modułów
---
## Diagnostyka instalacji
| Objaw | Przyczyna |
|---|---|
| `404` / `Unauthorized` przy `pnpm add @intecion/...` | brak/zły token w `.npmrc`, albo brak dostępu do organizacji w Gitea |
| `404` na `git.intecion.net/.../ipal-kit.git` | nie zalogowany / brak tokenu w URL / brak uprawnień do repo |
| `ERR_PNPM_GIT_DEP_PREPARE_NOT_ALLOWED` | `prepare` w package.json (Droga B) — usuń, `dist` jest w repo |
| `Cannot find module .../src/...ts` | główny `exports` wskazuje src zamiast dist |
| stary kod mimo reinstall | cache; `pnpm store prune && rm -rf .next node_modules/@intecion` |
Więcej: [docs/install.md](./docs/install.md).