@rock555/frontend-core 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,24 +9,18 @@
9
9
  Публічний пакет на npmjs.com, токен для встановлення не потрібен. У `package.json`:
10
10
 
11
11
  ```json
12
- "@rock555/frontend-core": "^3.0.0"
12
+ "@rock555/frontend-core": "^3.1.0"
13
13
  ```
14
14
 
15
- Імпорти `@/_shared/...` міняти не треба, досить аліаса. У `vite.config`:
15
+ Імпорти `@/_shared/...` міняти не треба. У `vite.config` один плагін, він дає аліас і все інше, без чого dev-сервер падає на старті:
16
16
 
17
17
  ```ts
18
- resolve: {
19
- alias: {
20
- '@/_shared': fileURLToPath(new URL('./node_modules/@rock555/frontend-core/src', import.meta.url)),
21
- '@': fileURLToPath(new URL('./resources/js', import.meta.url)),
22
- },
23
- dedupe: ['vue'],
24
- },
25
- // Без цього dev-сервер збирає ядро окремою копією, і застосунок падає на старті.
26
- optimizeDeps: { exclude: ['@/_shared'] },
18
+ import { frontendCore } from '@rock555/frontend-core/vite'
19
+
20
+ plugins: [frontendCore(), /* ... */],
27
21
  ```
28
22
 
29
- Аліас `@/_shared` має стояти раніше за `@`. У `tsconfig.json`:
23
+ У `tsconfig.json`:
30
24
 
31
25
  ```json
32
26
  "paths": {
@@ -69,19 +63,31 @@ optimizeDeps: { exclude: ['@/_shared'] },
69
63
 
70
64
  ## Як змінювати ядро
71
65
 
72
- 1. Правка йде PR-ом сюди, а не в папку проєкту. Перевірити її в себе: `npm link` або `"file:../frontend-core"` замість версії, у PR проєкту це не потрапляє.
73
- 2. CI ганяє типи, лінт і межі ядра. Локально те саме: `npm run check`.
74
- 3. Після вливання піднімаємо `version` у `package.json`, пишемо в [CHANGES.md](CHANGES.md) і ставимо тег `v…`: CI сам публікує пакет через trusted publishing, без токена.
75
- - патч `1.0.1`: виправлення, проєктам нічого робити не треба;
76
- - мінор `1.1.0`: нова можливість, зі значенням за замовчуванням, старе працює як було;
77
- - мажор `2.0.0`: ламає проєкти (новий обов'язковий токен чи підпис, видалення, зміна поведінки), у `CHANGES.md` пишемо, що зробити проєкту.
78
- 4. Проєкт піднімає версію у себе звичайним PR, коли йому зручно: його CI перевіряє, відповідальний вливає.
66
+ Коду ядра в проєктах немає, тому правити його там нема де. Будь-яка правка йде сюди.
67
+
68
+ 1. Запустіть проєкт на ядрі з папки, правки видно одразу, публікувати нічого не треба:
69
+
70
+ ```bash
71
+ CORE_PATH=../frontend-core npm run dev
72
+ ```
73
+
74
+ У PowerShell: `$env:CORE_PATH="../frontend-core"; npm run dev`. Шлях рахується від папки, де запускаєте, тож де фронт лежить глибше, це `../../frontend-core`.
75
+
76
+ 2. Відкрийте PR: у ньому нова `version` у `package.json` і запис у [CHANGES.md](CHANGES.md).
77
+ - патч `3.1.1`: виправлення, проєктам нічого робити не треба;
78
+ - мінор `3.2.0`: нова можливість зі значенням за замовчуванням, старе працює як було;
79
+ - мажор `4.0.0`: ламає проєкти (новий обов'язковий токен чи підпис, видалення, зміна поведінки), у `CHANGES.md` пишемо, що зробити проєкту.
80
+ 3. CI перевіряє типи, лінт, межі ядра, нову версію, а тоді ставить правку в чисті копії всіх проєктів. Червоне в проєкті означає, що правка його ламає. Для мажора це очікувано: перед вами список того, що зробити. Локально те саме: `npm run check` і `npm run check:projects`.
81
+ 4. Після вливання в `main` пакет і тег з'являються самі, руками нічого не ставимо.
82
+ 5. Проєкти піднімають версію звичайним PR одразу після виходу:
79
83
 
80
- ## Як оновлення доходить до проєктів
84
+ ```bash
85
+ npm install @rock555/frontend-core@latest
86
+ ```
81
87
 
82
- Само нічого не приїде: версія зафіксована в `package-lock.json` проєкту. Щоб оновитись: `npm install @rock555/frontend-core@latest` і звичайний PR.
88
+ Само в проєкт нічого не приїде: версія зафіксована в `package-lock.json`, тож невдала публікація нічого не зламає. Відкотитись можна так само, вказавши номер попередньої версії.
83
89
 
84
- Відставати на мажор і більше дуже небажано, хоч і не заборонено: чим більший розрив, тим дорожче потім наздоганяти.
90
+ Публікація йде лише з CI, без токена. На npm для пакета ввімкнено двофакторну перевірку без обхідних токенів. Назву `release.yml` не міняємо: npm довіряє саме цьому файлу.
85
91
 
86
92
  ## Чого в ядрі бути не може
87
93
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rock555/frontend-core",
3
- "version": "3.0.0",
3
+ "version": "3.1.0",
4
4
  "description": "Спільне фронтове ядро: API-клієнт, таблиці, форми, модалки, хелпери",
5
5
  "license": "UNLICENSED",
6
6
  "repository": {
@@ -13,16 +13,23 @@
13
13
  },
14
14
  "type": "module",
15
15
  "files": [
16
- "src"
16
+ "src",
17
+ "vite-plugin.js",
18
+ "vite-plugin.d.ts"
17
19
  ],
18
20
  "exports": {
21
+ "./vite": {
22
+ "types": "./vite-plugin.d.ts",
23
+ "default": "./vite-plugin.js"
24
+ },
19
25
  "./*": "./src/*"
20
26
  },
21
27
  "scripts": {
22
28
  "typecheck": "vue-tsc --noEmit",
23
29
  "lint": "eslint .",
24
30
  "test": "vitest run",
25
- "check": "npm run typecheck && npm run lint && npm run test"
31
+ "check": "npm run typecheck && npm run lint && npm run test",
32
+ "check:projects": "node scripts/check-projects.mjs"
26
33
  },
27
34
  "peerDependencies": {
28
35
  "@internationalized/date": "^3.11.0",
@@ -0,0 +1,3 @@
1
+ import type { Plugin } from 'vite'
2
+
3
+ export function frontendCore(): Plugin
package/vite-plugin.js ADDED
@@ -0,0 +1,36 @@
1
+ // Усе, що проєкту треба від Vite, щоб жити на ядрі. Один виклик замість аліаса й
2
+ // optimizeDeps у кожному vite.config: забути щось із цього дорого, dev-сервер падає на старті.
3
+ //
4
+ // CORE_PATH=../frontend-core npm run dev бере ядро з папки: правки видно одразу, без публікації.
5
+
6
+ import { existsSync, readFileSync } from 'node:fs'
7
+ import { dirname, join, resolve } from 'node:path'
8
+ import { fileURLToPath } from 'node:url'
9
+
10
+ const INSTALLED = dirname(fileURLToPath(import.meta.url))
11
+
12
+ export function frontendCore() {
13
+ return {
14
+ name: 'frontend-core',
15
+ enforce: 'pre',
16
+ config() {
17
+ const root = process.env.CORE_PATH ? resolve(process.env.CORE_PATH) : INSTALLED
18
+ if (!existsSync(join(root, 'src/config.ts'))) {
19
+ throw new Error(`CORE_PATH не вказує на репозиторій ядра: ${root}`)
20
+ }
21
+ const { peerDependencies } = JSON.parse(readFileSync(join(root, 'package.json'), 'utf8'))
22
+
23
+ return {
24
+ resolve: {
25
+ alias: [{ find: '@/_shared', replacement: join(root, 'src') }],
26
+ // Ядро з папки інакше брало б vue та інші залежності зі своїх node_modules: дві копії.
27
+ dedupe: Object.keys(peerDependencies),
28
+ },
29
+ // Без цього dev-сервер збирає ядро окремою копією, і SharedConfig.configure()
30
+ // налаштовує не той екземпляр, що читають компоненти.
31
+ optimizeDeps: { exclude: ['@/_shared'] },
32
+ server: { fs: { allow: [process.cwd(), root] } },
33
+ }
34
+ },
35
+ }
36
+ }