@matizze/prumo-cli 0.0.0-stage → 0.5.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.
Files changed (124) hide show
  1. package/README.md +120 -2
  2. package/dist/api.d.ts +10 -0
  3. package/dist/api.js +9 -0
  4. package/dist/args.d.ts +11 -0
  5. package/dist/args.js +61 -0
  6. package/dist/bin.d.ts +2 -0
  7. package/dist/bin.js +11 -0
  8. package/dist/codemod/add-route.d.ts +66 -0
  9. package/dist/codemod/add-route.js +435 -0
  10. package/dist/codemod/edit.d.ts +35 -0
  11. package/dist/codemod/edit.js +51 -0
  12. package/dist/codemod/index.d.ts +8 -0
  13. package/dist/codemod/index.js +8 -0
  14. package/dist/codemod/merge-barrel.d.ts +9 -0
  15. package/dist/codemod/merge-barrel.js +49 -0
  16. package/dist/codemod/messages.d.ts +11 -0
  17. package/dist/codemod/messages.js +46 -0
  18. package/dist/codemod/names.d.ts +62 -0
  19. package/dist/codemod/names.js +204 -0
  20. package/dist/codemod/plan.d.ts +45 -0
  21. package/dist/codemod/plan.js +147 -0
  22. package/dist/codemod/register-domain.d.ts +51 -0
  23. package/dist/codemod/register-domain.js +237 -0
  24. package/dist/codemod/register-messages.d.ts +11 -0
  25. package/dist/codemod/register-messages.js +112 -0
  26. package/dist/codemod/route-elements.d.ts +25 -0
  27. package/dist/codemod/route-elements.js +72 -0
  28. package/dist/commands/check.d.ts +16 -0
  29. package/dist/commands/check.js +47 -0
  30. package/dist/commands/doctor.d.ts +20 -0
  31. package/dist/commands/doctor.js +104 -0
  32. package/dist/commands/make-component.d.ts +33 -0
  33. package/dist/commands/make-component.js +85 -0
  34. package/dist/commands/make-domain.d.ts +30 -0
  35. package/dist/commands/make-domain.js +83 -0
  36. package/dist/commands/make-page.d.ts +30 -0
  37. package/dist/commands/make-page.js +73 -0
  38. package/dist/commands/new.d.ts +33 -0
  39. package/dist/commands/new.js +179 -0
  40. package/dist/commands/shared.d.ts +43 -0
  41. package/dist/commands/shared.js +83 -0
  42. package/dist/describe.d.ts +63 -0
  43. package/dist/describe.js +134 -0
  44. package/dist/doctor/checks.d.ts +35 -0
  45. package/dist/doctor/checks.js +283 -0
  46. package/dist/doctor/ranges.d.ts +16 -0
  47. package/dist/doctor/ranges.js +27 -0
  48. package/dist/doctor/versions.d.ts +33 -0
  49. package/dist/doctor/versions.js +44 -0
  50. package/dist/errors.d.ts +12 -0
  51. package/dist/errors.js +19 -0
  52. package/dist/generate/app.d.ts +27 -0
  53. package/dist/generate/app.js +136 -0
  54. package/dist/generate/component.d.ts +36 -0
  55. package/dist/generate/component.js +48 -0
  56. package/dist/generate/domain.d.ts +31 -0
  57. package/dist/generate/domain.js +63 -0
  58. package/dist/generate/page.d.ts +45 -0
  59. package/dist/generate/page.js +100 -0
  60. package/dist/help.d.ts +19 -0
  61. package/dist/help.js +97 -0
  62. package/dist/in-process.d.ts +26 -0
  63. package/dist/in-process.js +23 -0
  64. package/dist/index.d.ts +9 -0
  65. package/dist/index.js +9 -0
  66. package/dist/new/name.d.ts +7 -0
  67. package/dist/new/name.js +24 -0
  68. package/dist/new/packages.d.ts +6 -0
  69. package/dist/new/packages.js +40 -0
  70. package/dist/new/versions.d.ts +7 -0
  71. package/dist/new/versions.js +13 -0
  72. package/dist/process.d.ts +22 -0
  73. package/dist/process.js +45 -0
  74. package/dist/project.d.ts +22 -0
  75. package/dist/project.js +42 -0
  76. package/dist/root.d.ts +3 -0
  77. package/dist/root.js +24 -0
  78. package/dist/run.d.ts +13 -0
  79. package/dist/run.js +72 -0
  80. package/dist/runtime.d.ts +19 -0
  81. package/dist/runtime.js +1 -0
  82. package/dist/templates.d.ts +26 -0
  83. package/dist/templates.js +46 -0
  84. package/package.json +45 -3
  85. package/templates/app/AGENTS.md.tpl +50 -0
  86. package/templates/app/README.md.tpl +15 -0
  87. package/templates/app/eslint.config.js.tpl +19 -0
  88. package/templates/app/gitignore.tpl +22 -0
  89. package/templates/app/index.html.tpl +12 -0
  90. package/templates/app/mcp.json.tpl +8 -0
  91. package/templates/app/src/App.tsx.tpl +8 -0
  92. package/templates/app/src/i18n.ts.tpl +12 -0
  93. package/templates/app/src/main.tsx.tpl +12 -0
  94. package/templates/app/src/messages/index.ts.tpl +1 -0
  95. package/templates/app/src/providers/app.tsx.tpl +23 -0
  96. package/templates/app/src/providers/repository/index.ts.tpl +5 -0
  97. package/templates/app/src/queries-index.ts.tpl +1 -0
  98. package/templates/app/src/repositories/index.ts.tpl +18 -0
  99. package/templates/app/src/repositories/options.ts.tpl +8 -0
  100. package/templates/app/src/schemas-index.ts.tpl +1 -0
  101. package/templates/app/src/test/render.tsx.tpl +31 -0
  102. package/templates/app/src/test/setup.ts.tpl +4 -0
  103. package/templates/app/typescript.json.tpl +24 -0
  104. package/templates/app/vite.config.ts.tpl +16 -0
  105. package/templates/component/component-test.tsx.tpl +9 -0
  106. package/templates/component/component.tsx.tpl +11 -0
  107. package/templates/domain/queries.ts.tpl +62 -0
  108. package/templates/domain/repository-contract-test.ts.tpl +75 -0
  109. package/templates/domain/repository-contract.ts.tpl +13 -0
  110. package/templates/domain/repository-fixtures.ts.tpl +8 -0
  111. package/templates/domain/repository-index.ts.tpl +12 -0
  112. package/templates/domain/repository-mock.ts.tpl +69 -0
  113. package/templates/domain/schema.ts.tpl +23 -0
  114. package/templates/page/index-domain-test.tsx.tpl +11 -0
  115. package/templates/page/index-test.tsx.tpl +10 -0
  116. package/templates/page/index.tsx.tpl +7 -0
  117. package/templates/page/messages-domain.en.json.tpl +5 -0
  118. package/templates/page/messages-domain.pt-BR.json.tpl +5 -0
  119. package/templates/page/messages.en.json.tpl +3 -0
  120. package/templates/page/messages.pt-BR.json.tpl +3 -0
  121. package/templates/page/model-domain.ts.tpl +17 -0
  122. package/templates/page/model.ts.tpl +8 -0
  123. package/templates/page/view-domain.tsx.tpl +20 -0
  124. package/templates/page/view.tsx.tpl +9 -0
@@ -0,0 +1,33 @@
1
+ /** Uma versão `major.minor.patch`, sem pré-lançamento nem metadados (que o `doctor` ignora). */
2
+ export interface Version {
3
+ major: number;
4
+ minor: number;
5
+ patch: number;
6
+ }
7
+ /**
8
+ * Lê `1.2.3`, `v1.2.3`, `24` ou `24.1` (o que falta vira 0). Devolve `undefined` para o que não é
9
+ * versão (`lts/*`, `latest`, vazio). O que vem depois do patch (`-beta.1`, `+sha`) é descartado.
10
+ */
11
+ export declare function parseVersion(text: string): Version | undefined;
12
+ /** Negativo se `a < b`, zero se iguais, positivo se `a > b`. */
13
+ export declare function compareVersions(a: Version, b: Version): number;
14
+ export declare function formatVersion({ major, minor, patch }: Version): string;
15
+ /**
16
+ * Uma faixa compatível: do mínimo (inclusive) até o limite (exclusive). É o que a CLI diz esperar
17
+ * de cada pacote: `>=0.1.0 <0.2.0`.
18
+ */
19
+ export interface Range {
20
+ min: Version;
21
+ below: Version;
22
+ }
23
+ /** Lê uma faixa no formato `>=0.1.0 <0.2.0`; `undefined` se o texto é de outro formato. */
24
+ export declare function parseRange(text: string): Range | undefined;
25
+ /**
26
+ * A faixa que o `^` do npm daria: da versão até a próxima linha de compatibilidade. Antes da 1.0,
27
+ * a linha é a minor (`0.2.0` vai até `0.3.0`); a partir da 1.0, a major. Serve à própria CLI, que
28
+ * espera a linha da versão que ela tem.
29
+ */
30
+ export declare function caretRange(version: Version): Range;
31
+ /** Onde a versão fica em relação à faixa: abaixo do mínimo, dentro ou a partir do limite. */
32
+ export declare function positionIn(version: Version, range: Range): 'behind' | 'inside' | 'ahead';
33
+ export declare function formatRange({ min, below }: Range): string;
@@ -0,0 +1,44 @@
1
+ /**
2
+ * Lê `1.2.3`, `v1.2.3`, `24` ou `24.1` (o que falta vira 0). Devolve `undefined` para o que não é
3
+ * versão (`lts/*`, `latest`, vazio). O que vem depois do patch (`-beta.1`, `+sha`) é descartado.
4
+ */
5
+ export function parseVersion(text) {
6
+ const match = /^v?(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:[-+].*)?$/.exec(text.trim());
7
+ if (!match)
8
+ return undefined;
9
+ return { major: Number(match[1]), minor: Number(match[2] ?? 0), patch: Number(match[3] ?? 0) };
10
+ }
11
+ /** Negativo se `a < b`, zero se iguais, positivo se `a > b`. */
12
+ export function compareVersions(a, b) {
13
+ return a.major - b.major || a.minor - b.minor || a.patch - b.patch;
14
+ }
15
+ export function formatVersion({ major, minor, patch }) {
16
+ return `${major}.${minor}.${patch}`;
17
+ }
18
+ /** Lê uma faixa no formato `>=0.1.0 <0.2.0`; `undefined` se o texto é de outro formato. */
19
+ export function parseRange(text) {
20
+ const match = /^>=\s*(\S+)\s+<\s*(\S+)$/.exec(text.trim());
21
+ const min = match?.[1] ? parseVersion(match[1]) : undefined;
22
+ const below = match?.[2] ? parseVersion(match[2]) : undefined;
23
+ return min && below ? { min, below } : undefined;
24
+ }
25
+ /**
26
+ * A faixa que o `^` do npm daria: da versão até a próxima linha de compatibilidade. Antes da 1.0,
27
+ * a linha é a minor (`0.2.0` vai até `0.3.0`); a partir da 1.0, a major. Serve à própria CLI, que
28
+ * espera a linha da versão que ela tem.
29
+ */
30
+ export function caretRange(version) {
31
+ const below = version.major === 0
32
+ ? { major: 0, minor: version.minor + 1, patch: 0 }
33
+ : { major: version.major + 1, minor: 0, patch: 0 };
34
+ return { min: version, below };
35
+ }
36
+ /** Onde a versão fica em relação à faixa: abaixo do mínimo, dentro ou a partir do limite. */
37
+ export function positionIn(version, range) {
38
+ if (compareVersions(version, range.min) < 0)
39
+ return 'behind';
40
+ return compareVersions(version, range.below) >= 0 ? 'ahead' : 'inside';
41
+ }
42
+ export function formatRange({ min, below }) {
43
+ return `>=${formatVersion(min)} <${formatVersion(below)}`;
44
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Fim de comando com um código de saída. A mensagem, se houver, vai para o stderr; sem mensagem, o
3
+ * comando já escreveu o que tinha a dizer (como o `check`, que lista as violações).
4
+ */
5
+ export declare class ExitError extends Error {
6
+ readonly code: number;
7
+ constructor(code: number, message?: string);
8
+ }
9
+ /** Uso errado do comando: opção inexistente, argumento que falta, pasta que não é projeto. Sai com 2. */
10
+ export declare class UsageError extends ExitError {
11
+ constructor(message: string);
12
+ }
package/dist/errors.js ADDED
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Fim de comando com um código de saída. A mensagem, se houver, vai para o stderr; sem mensagem, o
3
+ * comando já escreveu o que tinha a dizer (como o `check`, que lista as violações).
4
+ */
5
+ export class ExitError extends Error {
6
+ code;
7
+ constructor(code, message = '') {
8
+ super(message);
9
+ this.name = 'ExitError';
10
+ this.code = code;
11
+ }
12
+ }
13
+ /** Uso errado do comando: opção inexistente, argumento que falta, pasta que não é projeto. Sai com 2. */
14
+ export class UsageError extends ExitError {
15
+ constructor(message) {
16
+ super(2, message);
17
+ this.name = 'UsageError';
18
+ }
19
+ }
@@ -0,0 +1,27 @@
1
+ /** Um arquivo do app: o modelo (em `templates/app/`) e onde ele cai, relativo à raiz do app. */
2
+ interface AppFile {
3
+ template: string;
4
+ to: string;
5
+ }
6
+ /** Os arquivos do app, além do `package.json` (que sai do código, com as versões) e da tela inicial. */
7
+ export declare const APP_FILES: readonly AppFile[];
8
+ /** O nome da tela inicial: o modelo do `make:page` gera a pasta, as mensagens e o teste dela. */
9
+ export declare const HOME_PAGE = "home";
10
+ export interface AppRequest {
11
+ /** O nome do app, em kebab-case (já validado). */
12
+ name: string;
13
+ /** Os tarballs do Prumo (nome do pacote -> `file:<caminho>`), que viram `pnpm.overrides`. */
14
+ overrides?: Readonly<Record<string, string>> | undefined;
15
+ }
16
+ /** O `package.json` do app: os scripts, as dependências e, com tarballs, os `pnpm.overrides`. */
17
+ export declare function appPackageJson({ name, overrides }: AppRequest): string;
18
+ /** Todos os arquivos de uma pasta, relativos a ela e com `/`, em ordem. */
19
+ export declare function listFiles(dir: string, base?: string): string[];
20
+ /**
21
+ * Escreve o app mínimo em `root` (uma pasta vazia ou que ainda não existe): os arquivos dos modelos,
22
+ * o `package.json` e a tela inicial, que sai do mesmo modelo do `make:page` (e registra a rota `/`
23
+ * e as mensagens como qualquer tela). Devolve os arquivos escritos. Quem chama escolhe a pasta: o
24
+ * `prumo new` monta o app numa pasta de rascunho e só o leva ao destino se tudo deu certo.
25
+ */
26
+ export declare function generateApp(root: string, request: AppRequest): string[];
27
+ export {};
@@ -0,0 +1,136 @@
1
+ import { existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';
2
+ import path from 'node:path';
3
+ import { deriveNames } from "../codemod/index.js";
4
+ import { titleOf } from "../new/name.js";
5
+ import { PRUMO_VERSIONS } from "../new/versions.js";
6
+ import { findProject } from "../project.js";
7
+ import { nameVars, renderTemplate, renderTemplateFile } from "../templates.js";
8
+ import { generatePage } from "./page.js";
9
+ /** Os arquivos do app, além do `package.json` (que sai do código, com as versões) e da tela inicial. */
10
+ export const APP_FILES = [
11
+ { template: 'app/AGENTS.md.tpl', to: 'AGENTS.md' },
12
+ { template: 'app/eslint.config.js.tpl', to: 'eslint.config.js' },
13
+ { template: 'app/gitignore.tpl', to: '.gitignore' },
14
+ { template: 'app/index.html.tpl', to: 'index.html' },
15
+ { template: 'app/mcp.json.tpl', to: '.mcp.json' },
16
+ { template: 'app/README.md.tpl', to: 'README.md' },
17
+ { template: 'app/typescript.json.tpl', to: 'tsconfig.json' },
18
+ { template: 'app/vite.config.ts.tpl', to: 'vite.config.ts' },
19
+ { template: 'app/src/App.tsx.tpl', to: 'src/App.tsx' },
20
+ { template: 'app/src/i18n.ts.tpl', to: 'src/i18n.ts' },
21
+ { template: 'app/src/main.tsx.tpl', to: 'src/main.tsx' },
22
+ { template: 'app/src/messages/index.ts.tpl', to: 'src/messages/pt-BR/index.ts' },
23
+ { template: 'app/src/messages/index.ts.tpl', to: 'src/messages/en/index.ts' },
24
+ { template: 'app/src/providers/app.tsx.tpl', to: 'src/providers/app.tsx' },
25
+ {
26
+ template: 'app/src/providers/repository/index.ts.tpl',
27
+ to: 'src/providers/repository/index.ts',
28
+ },
29
+ { template: 'app/src/queries-index.ts.tpl', to: 'src/queries/index.ts' },
30
+ { template: 'app/src/repositories/index.ts.tpl', to: 'src/repositories/index.ts' },
31
+ { template: 'app/src/repositories/options.ts.tpl', to: 'src/repositories/options.ts' },
32
+ { template: 'app/src/schemas-index.ts.tpl', to: 'src/schemas/index.ts' },
33
+ { template: 'app/src/test/render.tsx.tpl', to: 'src/test/render.tsx' },
34
+ { template: 'app/src/test/setup.ts.tpl', to: 'src/test/setup.ts' },
35
+ ];
36
+ /** O nome da tela inicial: o modelo do `make:page` gera a pasta, as mensagens e o teste dela. */
37
+ export const HOME_PAGE = 'home';
38
+ /**
39
+ * As dependências do app, só as bibliotecas e versões que o app de referência das fases anteriores
40
+ * já usava (React, wouter, TanStack Query, zod e i18next são o que o `@matizze/prumo-core` pede por
41
+ * peer). Os pacotes do Prumo entram à parte, com a versão deles.
42
+ */
43
+ const DEPENDENCIES = {
44
+ '@tanstack/react-query': '^5.105.0',
45
+ i18next: '^26.4.2',
46
+ 'i18next-browser-languagedetector': '^8.2.1',
47
+ 'i18next-icu': '^2.5.0',
48
+ react: '^19.3.1',
49
+ 'react-dom': '^19.3.1',
50
+ 'react-i18next': '^17.0.15',
51
+ wouter: '^3.13.0',
52
+ zod: '^4.6.7',
53
+ };
54
+ const DEV_DEPENDENCIES = {
55
+ '@eslint/js': '^10.0.1',
56
+ '@testing-library/dom': '^10.4.2',
57
+ '@testing-library/react': '^16.3.3',
58
+ '@types/node': '^24.19.2',
59
+ '@types/react': '^19.3.0',
60
+ '@types/react-dom': '^19.3.0',
61
+ '@vitejs/plugin-react': '^6.1.2',
62
+ eslint: '^10.13.0',
63
+ 'eslint-plugin-react-hooks': '^7.1.1',
64
+ globals: '^17.13.0',
65
+ jsdom: '^31.0.1',
66
+ typescript: '~6.0.3',
67
+ 'typescript-eslint': '^8.72.1',
68
+ vite: '^8.3.5',
69
+ vitest: '^5.1.0',
70
+ };
71
+ /** O pacote do Prumo que o app usa em tempo de execução; os outros são de desenvolvimento. */
72
+ const RUNTIME_PRUMO = '@matizze/prumo-core';
73
+ const sorted = (map) => Object.fromEntries(Object.entries(map).sort(([a], [b]) => a.localeCompare(b)));
74
+ /** O `package.json` do app: os scripts, as dependências e, com tarballs, os `pnpm.overrides`. */
75
+ export function appPackageJson({ name, overrides }) {
76
+ const prumo = Object.entries(PRUMO_VERSIONS).map(([pkg, version]) => [pkg, `^${version}`]);
77
+ const runtime = Object.fromEntries(prumo.filter(([pkg]) => pkg === RUNTIME_PRUMO));
78
+ const tools = Object.fromEntries(prumo.filter(([pkg]) => pkg !== RUNTIME_PRUMO));
79
+ const data = {
80
+ name,
81
+ private: true,
82
+ version: '0.0.0',
83
+ type: 'module',
84
+ engines: { node: '>=24' },
85
+ scripts: {
86
+ dev: 'vite',
87
+ build: 'tsc && vite build',
88
+ typecheck: 'tsc',
89
+ lint: 'eslint .',
90
+ check: 'prumo check',
91
+ test: 'vitest run',
92
+ verify: 'pnpm typecheck && pnpm lint && pnpm check && pnpm test',
93
+ },
94
+ dependencies: sorted({ ...DEPENDENCIES, ...runtime }),
95
+ devDependencies: sorted({ ...DEV_DEPENDENCIES, ...tools }),
96
+ ...(overrides && Object.keys(overrides).length > 0
97
+ ? { pnpm: { overrides: sorted({ ...overrides }) } }
98
+ : {}),
99
+ };
100
+ return `${JSON.stringify(data, null, 2)}\n`;
101
+ }
102
+ /** Todos os arquivos de uma pasta, relativos a ela e com `/`, em ordem. */
103
+ export function listFiles(dir, base = dir) {
104
+ return readdirSync(dir, { withFileTypes: true })
105
+ .flatMap((entry) => {
106
+ const file = path.join(dir, entry.name);
107
+ return entry.isDirectory()
108
+ ? listFiles(file, base)
109
+ : [path.relative(base, file).split(path.sep).join('/')];
110
+ })
111
+ .sort();
112
+ }
113
+ /**
114
+ * Escreve o app mínimo em `root` (uma pasta vazia ou que ainda não existe): os arquivos dos modelos,
115
+ * o `package.json` e a tela inicial, que sai do mesmo modelo do `make:page` (e registra a rota `/`
116
+ * e as mensagens como qualquer tela). Devolve os arquivos escritos. Quem chama escolhe a pasta: o
117
+ * `prumo new` monta o app numa pasta de rascunho e só o leva ao destino se tudo deu certo.
118
+ */
119
+ export function generateApp(root, request) {
120
+ const names = deriveNames(request.name);
121
+ const vars = { ...nameVars('app', names), 'app.title': titleOf(names.kebab) };
122
+ const write = (to, content) => {
123
+ const file = path.join(root, to);
124
+ if (existsSync(file))
125
+ throw new Error(`o arquivo '${to}' já existe em '${root}'.`);
126
+ mkdirSync(path.dirname(file), { recursive: true });
127
+ writeFileSync(file, content);
128
+ };
129
+ write('package.json', appPackageJson(request));
130
+ for (const { template, to } of APP_FILES) {
131
+ write(renderTemplate(to, vars), renderTemplateFile(template, vars));
132
+ }
133
+ const { plan } = generatePage(findProject(root), { name: HOME_PAGE, route: '/' });
134
+ plan.commit();
135
+ return listFiles(root);
136
+ }
@@ -0,0 +1,36 @@
1
+ import { ChangePlan, type Names } from '../codemod/index.js';
2
+ import type { Project } from '../project.js';
3
+ /** O componente e o teste dele: o modelo e o nome do arquivo (sem a pasta), os dois com marcadores. */
4
+ export declare const COMPONENT_FILES: readonly [{
5
+ readonly template: "component/component.tsx.tpl";
6
+ readonly name: "{{component.kebab}}.tsx";
7
+ }, {
8
+ readonly template: "component/component-test.tsx.tpl";
9
+ readonly name: "{{component.kebab}}.test.tsx";
10
+ }];
11
+ export interface ComponentRequest {
12
+ /** O nome do componente, em kebab-case: `resumo-do-pedido`. */
13
+ name: string;
14
+ /** A tela que recebe o componente (`src/pages/<tela>/components/`). */
15
+ page?: string | undefined;
16
+ /** O componente é de uso comum (`src/components/shared/`). */
17
+ shared?: boolean | undefined;
18
+ }
19
+ export interface ComponentResult {
20
+ plan: ChangePlan;
21
+ names: Names;
22
+ /** A pasta do componente, relativa à raiz do projeto, em posix. */
23
+ folder: string;
24
+ /** O arquivo do componente, relativo à raiz do projeto. */
25
+ file: string;
26
+ /** A tela, quando o componente é dela. */
27
+ page?: Names;
28
+ }
29
+ /**
30
+ * Monta o plano de um componente novo, só com elementos HTML, e o teste dele: em
31
+ * `src/pages/<tela>/components/` (`page`) ou em `src/components/shared/` (`shared`), um dos dois.
32
+ * Nada vai para o disco. Valida o nome (kebab-case, sem palavra reservada nem nome global, que
33
+ * viram o identificador do componente), a escolha entre a tela e o `shared` e a tela, que precisa
34
+ * existir; todo erro de uso é um `UsageError` (saída 2).
35
+ */
36
+ export declare function generateComponent(project: Project, { name, page, shared }: ComponentRequest): ComponentResult;
@@ -0,0 +1,48 @@
1
+ import { existsSync } from 'node:fs';
2
+ import path from 'node:path';
3
+ import { assertValidName, ChangePlan, usableNames } from "../codemod/index.js";
4
+ import { UsageError } from "../errors.js";
5
+ import { nameVars, renderTemplate, renderTemplateFile } from "../templates.js";
6
+ /** O componente e o teste dele: o modelo e o nome do arquivo (sem a pasta), os dois com marcadores. */
7
+ export const COMPONENT_FILES = [
8
+ { template: 'component/component.tsx.tpl', name: '{{component.kebab}}.tsx' },
9
+ { template: 'component/component-test.tsx.tpl', name: '{{component.kebab}}.test.tsx' },
10
+ ];
11
+ /**
12
+ * Monta o plano de um componente novo, só com elementos HTML, e o teste dele: em
13
+ * `src/pages/<tela>/components/` (`page`) ou em `src/components/shared/` (`shared`), um dos dois.
14
+ * Nada vai para o disco. Valida o nome (kebab-case, sem palavra reservada nem nome global, que
15
+ * viram o identificador do componente), a escolha entre a tela e o `shared` e a tela, que precisa
16
+ * existir; todo erro de uso é um `UsageError` (saída 2).
17
+ */
18
+ export function generateComponent(project, { name, page, shared = false }) {
19
+ const names = usableNames(name, 'o nome do componente', { globals: true });
20
+ if (page !== undefined && shared) {
21
+ throw new UsageError('use --page <tela> ou --shared, não os dois.');
22
+ }
23
+ if (page === undefined && !shared) {
24
+ throw new UsageError('diga onde o componente mora: --page <tela> (os da tela) ou --shared (os usados por duas ou mais telas).');
25
+ }
26
+ let pageNames;
27
+ let folder = 'src/components/shared';
28
+ if (page !== undefined) {
29
+ assertValidName(page, 'o nome da tela');
30
+ pageNames = usableNames(page, 'o nome da tela');
31
+ if (!existsSync(path.join(project.pages, pageNames.kebab))) {
32
+ throw new UsageError(`a tela '${pageNames.kebab}' não existe: não há a pasta src/pages/${pageNames.kebab} (crie-a com prumo make:page ${pageNames.kebab}).`);
33
+ }
34
+ folder = `src/pages/${pageNames.kebab}/components`;
35
+ }
36
+ const vars = nameVars('component', names);
37
+ const plan = new ChangePlan(project);
38
+ for (const { template, name: fileName } of COMPONENT_FILES) {
39
+ plan.createSource(path.join(project.root, folder, renderTemplate(fileName, vars)), renderTemplateFile(template, vars));
40
+ }
41
+ return {
42
+ plan,
43
+ names,
44
+ folder,
45
+ file: `${folder}/${names.kebab}.tsx`,
46
+ ...(pageNames ? { page: pageNames } : {}),
47
+ };
48
+ }
@@ -0,0 +1,31 @@
1
+ import { ChangePlan, type DomainNames } from '../codemod/index.js';
2
+ import type { Project } from '../project.js';
3
+ /** Um arquivo do domínio: o modelo e onde ele cai no projeto, os dois com marcadores. */
4
+ interface DomainFile {
5
+ /** O modelo, em `templates/`. */
6
+ template: string;
7
+ /** O caminho no projeto, relativo à raiz. */
8
+ to: string;
9
+ }
10
+ /** Os arquivos de um domínio novo, na ordem em que o plano os lista. */
11
+ export declare const DOMAIN_FILES: readonly DomainFile[];
12
+ /** Os nomes que o domínio exporta de `src/queries/index.ts`: as chaves, as queries e os hooks. */
13
+ export declare function queriesExports(to: DomainNames): string[];
14
+ export interface DomainRequest {
15
+ /** O nome do domínio, no plural e em kebab-case: `clientes`. */
16
+ name: string;
17
+ /** A entidade, no singular. Sem ela, sai do nome (tira o `s` final). */
18
+ entity?: string | undefined;
19
+ }
20
+ /**
21
+ * Monta o plano de um domínio novo: os arquivos dos modelos (schema, repositório com contrato,
22
+ * mock, fixtures, index e teste de contrato, e as queries) e as costuras nos índices de schemas,
23
+ * repositórios (com o mapa `factories`, que é o container) e queries. Nada vai para o disco: o
24
+ * chamador mostra o `summary()` ou faz o `commit()`. Valida o nome e confere o projeto antes de
25
+ * montar qualquer coisa, e todo erro de uso é um `UsageError` (saída 2).
26
+ */
27
+ export declare function generateDomain(project: Project, { name, entity }: DomainRequest): {
28
+ plan: ChangePlan;
29
+ names: DomainNames;
30
+ };
31
+ export {};
@@ -0,0 +1,63 @@
1
+ import { existsSync } from 'node:fs';
2
+ import path from 'node:path';
3
+ import { ChangePlan, domainNames, registerQueriesEntry, registerRepository, registerSchema, } from "../codemod/index.js";
4
+ import { UsageError } from "../errors.js";
5
+ import { nameVars, renderTemplate, renderTemplateFile } from "../templates.js";
6
+ /** Os arquivos de um domínio novo, na ordem em que o plano os lista. */
7
+ export const DOMAIN_FILES = [
8
+ { template: 'domain/schema.ts.tpl', to: 'src/schemas/entities/{{singular.kebab}}.ts' },
9
+ {
10
+ template: 'domain/repository-contract.ts.tpl',
11
+ to: 'src/repositories/{{plural.kebab}}/repository.contract.ts',
12
+ },
13
+ {
14
+ template: 'domain/repository-mock.ts.tpl',
15
+ to: 'src/repositories/{{plural.kebab}}/repository.mock.ts',
16
+ },
17
+ {
18
+ template: 'domain/repository-fixtures.ts.tpl',
19
+ to: 'src/repositories/{{plural.kebab}}/fixtures.ts',
20
+ },
21
+ { template: 'domain/repository-index.ts.tpl', to: 'src/repositories/{{plural.kebab}}/index.ts' },
22
+ {
23
+ template: 'domain/repository-contract-test.ts.tpl',
24
+ to: 'src/repositories/{{plural.kebab}}/repository.contract.test.ts',
25
+ },
26
+ { template: 'domain/queries.ts.tpl', to: 'src/queries/{{plural.kebab}}.ts' },
27
+ ];
28
+ /** Os nomes que o domínio exporta de `src/queries/index.ts`: as chaves, as queries e os hooks. */
29
+ export function queriesExports(to) {
30
+ const { plural, singular } = to;
31
+ return [
32
+ `${singular.camel}Keys`,
33
+ `${singular.camel}Queries`,
34
+ `use${plural.pascal}List`,
35
+ `use${singular.pascal}Detail`,
36
+ `useCreate${singular.pascal}`,
37
+ `useUpdate${singular.pascal}`,
38
+ `useRemove${singular.pascal}`,
39
+ ];
40
+ }
41
+ /**
42
+ * Monta o plano de um domínio novo: os arquivos dos modelos (schema, repositório com contrato,
43
+ * mock, fixtures, index e teste de contrato, e as queries) e as costuras nos índices de schemas,
44
+ * repositórios (com o mapa `factories`, que é o container) e queries. Nada vai para o disco: o
45
+ * chamador mostra o `summary()` ou faz o `commit()`. Valida o nome e confere o projeto antes de
46
+ * montar qualquer coisa, e todo erro de uso é um `UsageError` (saída 2).
47
+ */
48
+ export function generateDomain(project, { name, entity }) {
49
+ const names = domainNames(name, entity);
50
+ const folder = path.join(project.src, 'repositories', names.plural.kebab);
51
+ if (existsSync(folder)) {
52
+ throw new UsageError(`o domínio '${names.plural.kebab}' já existe: a pasta src/repositories/${names.plural.kebab} está no projeto.`);
53
+ }
54
+ const vars = { ...nameVars('plural', names.plural), ...nameVars('singular', names.singular) };
55
+ const plan = new ChangePlan(project);
56
+ for (const { template, to } of DOMAIN_FILES) {
57
+ plan.createSource(path.join(project.root, renderTemplate(to, vars)), renderTemplateFile(template, vars));
58
+ }
59
+ registerSchema(plan, names);
60
+ registerRepository(plan, names);
61
+ registerQueriesEntry(plan, { module: names.plural.kebab, exports: queriesExports(names) });
62
+ return { plan, names };
63
+ }
@@ -0,0 +1,45 @@
1
+ import { ChangePlan, type Names } from '../codemod/index.js';
2
+ import type { Project } from '../project.js';
3
+ /** Um arquivo da tela: o modelo e onde ele cai no projeto, os dois com marcadores. */
4
+ interface PageFile {
5
+ /** O modelo, em `templates/`. */
6
+ template: string;
7
+ /** O caminho no projeto, relativo à raiz. */
8
+ to: string;
9
+ }
10
+ /** Os arquivos de uma tela sem domínio: só o título. */
11
+ export declare const PAGE_FILES: readonly PageFile[];
12
+ /** Os arquivos de uma tela com `--domain`: o model lê a lista, e a view a mostra. */
13
+ export declare const PAGE_DOMAIN_FILES: readonly PageFile[];
14
+ /** Os idiomas dos modelos de mensagens: o `pt-BR` e o `en`. */
15
+ export declare const MESSAGE_LANGUAGES: readonly ["pt-BR", "en"];
16
+ /** O modelo do JSON de mensagens de um idioma, com ou sem domínio. */
17
+ export declare function messagesTemplate(language: (typeof MESSAGE_LANGUAGES)[number], domain: boolean): string;
18
+ /** Onde mora o módulo `src/<módulo>`: `<módulo>.ts`, `<módulo>.tsx` ou a pasta com `index`. */
19
+ export declare function moduleFile(project: Project, module: string): string | undefined;
20
+ export interface PageRequest {
21
+ /** O nome da tela, em kebab-case: `clientes`. */
22
+ name: string;
23
+ /** O domínio cuja lista a tela mostra (o nome dele, no plural), criado por `make:domain`. */
24
+ domain?: string | undefined;
25
+ /** A rota da tela. Padrão: `/<nome>`. A tela inicial de um app novo usa `/`. */
26
+ route?: string | undefined;
27
+ }
28
+ export interface PageResult {
29
+ plan: ChangePlan;
30
+ names: Names;
31
+ /** O domínio, se a tela tem um. */
32
+ domain?: Names;
33
+ /** A rota nova no `src/App.tsx`: `/clientes`. */
34
+ route: string;
35
+ }
36
+ /**
37
+ * Monta o plano de uma tela nova: `index`, `model`, `view` e o teste a partir dos modelos, as
38
+ * mensagens (`title` e, com domínio, os textos de carregando e de erro) em cada idioma do projeto,
39
+ * o namespace nos índices de mensagens e a rota `/<nome>` no `src/App.tsx`. Com `domain`, o model lê
40
+ * a lista do domínio e a view mostra o carregando, o erro e a lista. Nada vai para o disco: o
41
+ * chamador mostra o `summary()` ou faz o `commit()`. Valida os nomes e confere o projeto antes de
42
+ * montar qualquer coisa, e todo erro de uso é um `UsageError` (saída 2).
43
+ */
44
+ export declare function generatePage(project: Project, { name, domain, route }: PageRequest): PageResult;
45
+ export {};
@@ -0,0 +1,100 @@
1
+ import { existsSync, readFileSync } from 'node:fs';
2
+ import path from 'node:path';
3
+ import { addRouteSnippet, assertValidName, ChangePlan, deriveNames, registerMessageNamespace, usableNames, } from "../codemod/index.js";
4
+ import { messageLanguages } from "../codemod/messages.js";
5
+ import { UsageError } from "../errors.js";
6
+ import { nameVars, renderTemplate, renderTemplateFile } from "../templates.js";
7
+ const PAGE_DIR = 'src/pages/{{page.kebab}}';
8
+ /** Os arquivos de uma tela sem domínio: só o título. */
9
+ export const PAGE_FILES = [
10
+ { template: 'page/index.tsx.tpl', to: `${PAGE_DIR}/index.tsx` },
11
+ { template: 'page/model.ts.tpl', to: `${PAGE_DIR}/model.ts` },
12
+ { template: 'page/view.tsx.tpl', to: `${PAGE_DIR}/view.tsx` },
13
+ { template: 'page/index-test.tsx.tpl', to: `${PAGE_DIR}/index.test.tsx` },
14
+ ];
15
+ /** Os arquivos de uma tela com `--domain`: o model lê a lista, e a view a mostra. */
16
+ export const PAGE_DOMAIN_FILES = [
17
+ { template: 'page/index.tsx.tpl', to: `${PAGE_DIR}/index.tsx` },
18
+ { template: 'page/model-domain.ts.tpl', to: `${PAGE_DIR}/model.ts` },
19
+ { template: 'page/view-domain.tsx.tpl', to: `${PAGE_DIR}/view.tsx` },
20
+ { template: 'page/index-domain-test.tsx.tpl', to: `${PAGE_DIR}/index.test.tsx` },
21
+ ];
22
+ /** Os idiomas dos modelos de mensagens: o `pt-BR` e o `en`. */
23
+ export const MESSAGE_LANGUAGES = ['pt-BR', 'en'];
24
+ /** O modelo do JSON de mensagens de um idioma, com ou sem domínio. */
25
+ export function messagesTemplate(language, domain) {
26
+ return `page/messages${domain ? '-domain' : ''}.${language}.json.tpl`;
27
+ }
28
+ /**
29
+ * Qual dos dois modelos de mensagens vale para um idioma do projeto: os `pt` (`pt-BR`, `pt-PT`)
30
+ * usam o texto em português, e qualquer outro (`en`, `es`) o texto em inglês, que a pessoa traduz.
31
+ */
32
+ function messagesLanguageOf(language) {
33
+ return language.toLowerCase().startsWith('pt') ? 'pt-BR' : 'en';
34
+ }
35
+ /** Onde mora o módulo `src/<módulo>`: `<módulo>.ts`, `<módulo>.tsx` ou a pasta com `index`. */
36
+ export function moduleFile(project, module) {
37
+ return [`${module}.ts`, `${module}.tsx`, `${module}/index.ts`, `${module}/index.tsx`]
38
+ .map((file) => path.join(project.src, file))
39
+ .find((file) => existsSync(file));
40
+ }
41
+ /** O `<Route>` da tela, como entra no `src/App.tsx`. */
42
+ function routeElement(names, route) {
43
+ return `<Route path="${route}">\n <${names.pascal}Page />\n</Route>`;
44
+ }
45
+ /**
46
+ * Confere que o domínio existe e traz o hook de lista que o model usa: `src/queries/<domínio>.ts`
47
+ * com `use<Domínio>List`, o que o `make:domain` gera. Sem isso, a tela nasceria sem compilar.
48
+ */
49
+ function assertDomain(project, domain) {
50
+ const hook = `use${domain.pascal}List`;
51
+ const file = moduleFile(project, `queries/${domain.kebab}`);
52
+ if (!file) {
53
+ throw new UsageError(`o domínio '${domain.kebab}' não existe: falta src/queries/${domain.kebab}.ts (crie-o com prumo make:domain ${domain.kebab}).`);
54
+ }
55
+ if (!new RegExp(`\\b${hook}\\b`).test(readFileSync(file, 'utf8'))) {
56
+ throw new UsageError(`o domínio '${domain.kebab}' não tem o hook ${hook} em ${path.relative(project.root, file)}: o model da tela lê a lista por ele.`);
57
+ }
58
+ }
59
+ /**
60
+ * Monta o plano de uma tela nova: `index`, `model`, `view` e o teste a partir dos modelos, as
61
+ * mensagens (`title` e, com domínio, os textos de carregando e de erro) em cada idioma do projeto,
62
+ * o namespace nos índices de mensagens e a rota `/<nome>` no `src/App.tsx`. Com `domain`, o model lê
63
+ * a lista do domínio e a view mostra o carregando, o erro e a lista. Nada vai para o disco: o
64
+ * chamador mostra o `summary()` ou faz o `commit()`. Valida os nomes e confere o projeto antes de
65
+ * montar qualquer coisa, e todo erro de uso é um `UsageError` (saída 2).
66
+ */
67
+ export function generatePage(project, { name, domain, route }) {
68
+ const names = usableNames(name, 'o nome da tela');
69
+ let domainNames;
70
+ if (domain !== undefined) {
71
+ assertValidName(domain, 'o nome do domínio');
72
+ domainNames = deriveNames(domain);
73
+ }
74
+ if (existsSync(path.join(project.pages, names.kebab))) {
75
+ throw new UsageError(`a tela '${names.kebab}' já existe: a pasta src/pages/${names.kebab} está no projeto.`);
76
+ }
77
+ if (domainNames)
78
+ assertDomain(project, domainNames);
79
+ const vars = {
80
+ ...nameVars('page', names),
81
+ ...(domainNames ? nameVars('domain', domainNames) : {}),
82
+ };
83
+ const plan = new ChangePlan(project);
84
+ for (const { template, to } of domainNames ? PAGE_DOMAIN_FILES : PAGE_FILES) {
85
+ plan.createSource(path.join(project.root, renderTemplate(to, vars)), renderTemplateFile(template, vars));
86
+ }
87
+ for (const language of messageLanguages(project)) {
88
+ const template = messagesTemplate(messagesLanguageOf(language), domainNames !== undefined);
89
+ plan.createText(path.join(project.messages, language, `${names.kebab}.json`), renderTemplateFile(template, vars));
90
+ }
91
+ const pagePath = route ?? `/${names.kebab}`;
92
+ registerMessageNamespace(plan, names.kebab, names.camel);
93
+ addRouteSnippet(plan, {
94
+ component: `${names.pascal}Page`,
95
+ importPath: `@/pages/${names.kebab}`,
96
+ path: pagePath,
97
+ element: routeElement(names, pagePath),
98
+ });
99
+ return { plan, names, route: pagePath, ...(domainNames ? { domain: domainNames } : {}) };
100
+ }
package/dist/help.d.ts ADDED
@@ -0,0 +1,19 @@
1
+ import type { ArgDef, CommandDef, Resolvable } from 'citty';
2
+ /** Um comando de qualquer forma: os comandos têm argumentos de tipos diferentes. */
3
+ export type AnyCommand = CommandDef<any>;
4
+ /** Resolve o que o citty aceita como valor, função ou promessa. */
5
+ export declare function resolveValue<T>(value: Resolvable<T>): Promise<T>;
6
+ /** A primeira linha da descrição, que é o resumo mostrado na lista de comandos. */
7
+ export declare function summary(description: string | undefined): string;
8
+ /**
9
+ * A ajuda de um comando, em português: a sintaxe, a descrição, os argumentos, as opções e, para um
10
+ * comando com subcomandos, a lista deles. O citty tem uma ajuda própria, mas ela é em inglês e
11
+ * não permite trocar os títulos. `path` é o caminho do comando, como `['prumo', 'check']`.
12
+ */
13
+ export declare function renderHelp(command: AnyCommand, path: string[]): Promise<string>;
14
+ /** O argumento posicional que aceita vários valores: o nome termina em `...` (`item...`). */
15
+ export declare function isVariadic(name: string | undefined): boolean;
16
+ /** Os apelidos da opção (`-h` de `--help`). O argumento posicional não tem. */
17
+ export declare function aliasesOf(def: ArgDef): string[];
18
+ /** Se o argumento é obrigatório: o posicional é, a não ser que diga o contrário; a opção só se disser. */
19
+ export declare function isRequired(def: ArgDef): boolean;