@matizze/prumo-cli 0.0.0-stage → 0.5.1

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 (126) hide show
  1. package/README.md +121 -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 +87 -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 +184 -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 +29 -0
  53. package/dist/generate/app.js +137 -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/pnpm.d.ts +14 -0
  73. package/dist/pnpm.js +37 -0
  74. package/dist/process.d.ts +22 -0
  75. package/dist/process.js +45 -0
  76. package/dist/project.d.ts +22 -0
  77. package/dist/project.js +42 -0
  78. package/dist/root.d.ts +3 -0
  79. package/dist/root.js +24 -0
  80. package/dist/run.d.ts +13 -0
  81. package/dist/run.js +72 -0
  82. package/dist/runtime.d.ts +19 -0
  83. package/dist/runtime.js +1 -0
  84. package/dist/templates.d.ts +26 -0
  85. package/dist/templates.js +46 -0
  86. package/package.json +45 -3
  87. package/templates/app/AGENTS.md.tpl +50 -0
  88. package/templates/app/README.md.tpl +15 -0
  89. package/templates/app/eslint.config.js.tpl +19 -0
  90. package/templates/app/gitignore.tpl +22 -0
  91. package/templates/app/index.html.tpl +12 -0
  92. package/templates/app/mcp.json.tpl +8 -0
  93. package/templates/app/src/App.tsx.tpl +8 -0
  94. package/templates/app/src/i18n.ts.tpl +12 -0
  95. package/templates/app/src/main.tsx.tpl +12 -0
  96. package/templates/app/src/messages/index.ts.tpl +1 -0
  97. package/templates/app/src/providers/app.tsx.tpl +23 -0
  98. package/templates/app/src/providers/repository/index.ts.tpl +5 -0
  99. package/templates/app/src/queries-index.ts.tpl +1 -0
  100. package/templates/app/src/repositories/index.ts.tpl +18 -0
  101. package/templates/app/src/repositories/options.ts.tpl +8 -0
  102. package/templates/app/src/schemas-index.ts.tpl +1 -0
  103. package/templates/app/src/test/render.tsx.tpl +31 -0
  104. package/templates/app/src/test/setup.ts.tpl +4 -0
  105. package/templates/app/typescript.json.tpl +24 -0
  106. package/templates/app/vite.config.ts.tpl +16 -0
  107. package/templates/component/component-test.tsx.tpl +9 -0
  108. package/templates/component/component.tsx.tpl +11 -0
  109. package/templates/domain/queries.ts.tpl +62 -0
  110. package/templates/domain/repository-contract-test.ts.tpl +75 -0
  111. package/templates/domain/repository-contract.ts.tpl +13 -0
  112. package/templates/domain/repository-fixtures.ts.tpl +8 -0
  113. package/templates/domain/repository-index.ts.tpl +12 -0
  114. package/templates/domain/repository-mock.ts.tpl +69 -0
  115. package/templates/domain/schema.ts.tpl +23 -0
  116. package/templates/page/index-domain-test.tsx.tpl +11 -0
  117. package/templates/page/index-test.tsx.tpl +10 -0
  118. package/templates/page/index.tsx.tpl +7 -0
  119. package/templates/page/messages-domain.en.json.tpl +5 -0
  120. package/templates/page/messages-domain.pt-BR.json.tpl +5 -0
  121. package/templates/page/messages.en.json.tpl +3 -0
  122. package/templates/page/messages.pt-BR.json.tpl +3 -0
  123. package/templates/page/model-domain.ts.tpl +17 -0
  124. package/templates/page/model.ts.tpl +8 -0
  125. package/templates/page/view-domain.tsx.tpl +20 -0
  126. package/templates/page/view.tsx.tpl +9 -0
@@ -0,0 +1,62 @@
1
+ /** Os nomes derivados de um nome em kebab-case. */
2
+ export interface Names {
3
+ /** `pedidos-recentes`: a pasta, o arquivo de mensagens e a rota. */
4
+ kebab: string;
5
+ /** `PedidosRecentes`: componentes, hooks e tipos. */
6
+ pascal: string;
7
+ /** `pedidosRecentes`: o namespace do i18n e as chaves. */
8
+ camel: string;
9
+ }
10
+ /** Os nomes de um domínio: o plural (`suppliers`) e o singular da entidade (`supplier`). */
11
+ export interface DomainNames {
12
+ plural: Names;
13
+ singular: Names;
14
+ }
15
+ /**
16
+ * As palavras que não servem de identificador no código gerado, porque o nome da tela, do
17
+ * domínio ou do componente vira `import <camel> from './<nome>.json'`, `const <camel> = ...` e
18
+ * chaves de objeto. Entram as palavras reservadas do JavaScript, as reservadas só em modo estrito
19
+ * (todo módulo é estrito: `let`, `static`, `yield`, `await`...), os literais (`null`, `true`) e os
20
+ * nomes que o modo estrito proíbe como identificador (`eval`, `arguments`, `undefined`).
21
+ */
22
+ export declare const RESERVED_WORDS: ReadonlySet<string>;
23
+ /**
24
+ * Os nomes globais que um tipo ou componente com o mesmo nome esconderia dentro do arquivo gerado,
25
+ * e o código que usa `Date`, `Promise` ou `Record<...>` passaria a apontar para o nome novo: os
26
+ * objetos do JavaScript, os tipos utilitários do TypeScript e o `React`. São nomes em Pascal, o
27
+ * que o domínio (`Date`, `Record`) e o componente usam sozinhos, sem prefixo nem sufixo.
28
+ */
29
+ export declare const GLOBAL_NAMES: ReadonlySet<string>;
30
+ /** Nome válido: kebab-case com letras minúsculas, números e hífen, começando por letra. */
31
+ export declare function isValidName(name: string): boolean;
32
+ /** Lança um `UsageError` (saída 2) se o nome não for kebab-case. `what` entra na mensagem. */
33
+ export declare function assertValidName(name: string, what?: string): void;
34
+ /** Deriva Pascal e camel de um nome kebab-case, já validado: `error-404` vira `Error404`. */
35
+ export declare function deriveNames(name: string): Names;
36
+ /**
37
+ * Lança um `UsageError` (saída 2) se o nome derivado não serve de identificador no código gerado:
38
+ * o camel é palavra reservada do JavaScript (`new`, `class`, `default`...: viraria
39
+ * `import new from './new.json'`), ou, com `globals`, o Pascal é um nome global que o tipo ou o
40
+ * componente esconderia (`Date`, `Record`, `Promise`...). `what` entra na mensagem.
41
+ */
42
+ export declare function assertNotReserved(names: Names, what: string, { globals }?: {
43
+ globals?: boolean | undefined;
44
+ }): void;
45
+ /** Valida o nome (kebab-case, sem palavra reservada) e devolve os nomes derivados dele. */
46
+ export declare function usableNames(name: string, what: string, options?: {
47
+ globals?: boolean;
48
+ }): Names;
49
+ /**
50
+ * O singular de um plural, pela regra simples que serve ao inglês e ao português: tira o `s`
51
+ * final (`suppliers` vira `supplier`, `pedidos` vira `pedido`). Onde a regra erra, recusa em vez
52
+ * de derivar um nome errado em silêncio (`status` viraria `statu`, `categories`, `categorie`):
53
+ * o plural que termina em `ies`, `us`, `ss`, `xes`, `ches`, `shes` ou `sses` pede o singular
54
+ * explícito (`--entity`), e a mensagem sugere o provável (`categories`: `--entity category`).
55
+ */
56
+ export declare function singularOf(plural: string): string;
57
+ /**
58
+ * Deriva os nomes de um domínio. `plural` é o nome do domínio (`suppliers`); `singular` é a
59
+ * entidade (`supplier`) e, quando falta, sai da regra de `singularOf`. O singular não pode ser
60
+ * igual ao plural, senão o tipo da entidade e o da lista teriam o mesmo nome.
61
+ */
62
+ export declare function domainNames(plural: string, singular?: string): DomainNames;
@@ -0,0 +1,204 @@
1
+ import { UsageError } from "../errors.js";
2
+ /**
3
+ * As palavras que não servem de identificador no código gerado, porque o nome da tela, do
4
+ * domínio ou do componente vira `import <camel> from './<nome>.json'`, `const <camel> = ...` e
5
+ * chaves de objeto. Entram as palavras reservadas do JavaScript, as reservadas só em modo estrito
6
+ * (todo módulo é estrito: `let`, `static`, `yield`, `await`...), os literais (`null`, `true`) e os
7
+ * nomes que o modo estrito proíbe como identificador (`eval`, `arguments`, `undefined`).
8
+ */
9
+ export const RESERVED_WORDS = new Set([
10
+ 'arguments',
11
+ 'await',
12
+ 'break',
13
+ 'case',
14
+ 'catch',
15
+ 'class',
16
+ 'const',
17
+ 'continue',
18
+ 'debugger',
19
+ 'default',
20
+ 'delete',
21
+ 'do',
22
+ 'else',
23
+ 'enum',
24
+ 'eval',
25
+ 'export',
26
+ 'extends',
27
+ 'false',
28
+ 'finally',
29
+ 'for',
30
+ 'function',
31
+ 'if',
32
+ 'implements',
33
+ 'import',
34
+ 'in',
35
+ 'instanceof',
36
+ 'interface',
37
+ 'let',
38
+ 'new',
39
+ 'null',
40
+ 'package',
41
+ 'private',
42
+ 'protected',
43
+ 'public',
44
+ 'return',
45
+ 'static',
46
+ 'super',
47
+ 'switch',
48
+ 'this',
49
+ 'throw',
50
+ 'true',
51
+ 'try',
52
+ 'typeof',
53
+ 'undefined',
54
+ 'var',
55
+ 'void',
56
+ 'while',
57
+ 'with',
58
+ 'yield',
59
+ ]);
60
+ /**
61
+ * Os nomes globais que um tipo ou componente com o mesmo nome esconderia dentro do arquivo gerado,
62
+ * e o código que usa `Date`, `Promise` ou `Record<...>` passaria a apontar para o nome novo: os
63
+ * objetos do JavaScript, os tipos utilitários do TypeScript e o `React`. São nomes em Pascal, o
64
+ * que o domínio (`Date`, `Record`) e o componente usam sozinhos, sem prefixo nem sufixo.
65
+ */
66
+ export const GLOBAL_NAMES = new Set([
67
+ 'Array',
68
+ 'ArrayBuffer',
69
+ 'Awaited',
70
+ 'BigInt',
71
+ 'Boolean',
72
+ 'Date',
73
+ 'Error',
74
+ 'Exclude',
75
+ 'Extract',
76
+ 'Function',
77
+ 'Intl',
78
+ 'InstanceType',
79
+ 'JSON',
80
+ 'JSX',
81
+ 'Map',
82
+ 'Math',
83
+ 'NonNullable',
84
+ 'Number',
85
+ 'Object',
86
+ 'Omit',
87
+ 'Parameters',
88
+ 'Partial',
89
+ 'Pick',
90
+ 'Promise',
91
+ 'Proxy',
92
+ 'React',
93
+ 'Readonly',
94
+ 'Record',
95
+ 'Reflect',
96
+ 'RegExp',
97
+ 'Required',
98
+ 'ReturnType',
99
+ 'Set',
100
+ 'String',
101
+ 'Symbol',
102
+ 'URL',
103
+ 'URLSearchParams',
104
+ 'WeakMap',
105
+ 'WeakSet',
106
+ ]);
107
+ const NAME_PATTERN = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/;
108
+ /** Nome válido: kebab-case com letras minúsculas, números e hífen, começando por letra. */
109
+ export function isValidName(name) {
110
+ return NAME_PATTERN.test(name);
111
+ }
112
+ /** Lança um `UsageError` (saída 2) se o nome não for kebab-case. `what` entra na mensagem. */
113
+ export function assertValidName(name, what = 'nome') {
114
+ if (isValidName(name))
115
+ return;
116
+ throw new UsageError(`${what} '${name}' é inválido: use kebab-case, com letras minúsculas, números e hífen, começando por letra (ex.: pedidos-recentes).`);
117
+ }
118
+ /** Deriva Pascal e camel de um nome kebab-case, já validado: `error-404` vira `Error404`. */
119
+ export function deriveNames(name) {
120
+ assertValidName(name);
121
+ const pascal = name
122
+ .split('-')
123
+ .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
124
+ .join('');
125
+ return { kebab: name, pascal, camel: pascal.charAt(0).toLowerCase() + pascal.slice(1) };
126
+ }
127
+ /**
128
+ * Lança um `UsageError` (saída 2) se o nome derivado não serve de identificador no código gerado:
129
+ * o camel é palavra reservada do JavaScript (`new`, `class`, `default`...: viraria
130
+ * `import new from './new.json'`), ou, com `globals`, o Pascal é um nome global que o tipo ou o
131
+ * componente esconderia (`Date`, `Record`, `Promise`...). `what` entra na mensagem.
132
+ */
133
+ export function assertNotReserved(names, what, { globals = false } = {}) {
134
+ if (RESERVED_WORDS.has(names.camel)) {
135
+ throw new UsageError(`${what} '${names.kebab}' vira o identificador '${names.camel}', que é palavra reservada do JavaScript e quebraria o código gerado: escolha outro nome.`);
136
+ }
137
+ if (globals && GLOBAL_NAMES.has(names.pascal)) {
138
+ throw new UsageError(`${what} '${names.kebab}' vira o identificador '${names.pascal}', que é um nome global do JavaScript ou do TypeScript e esconderia o original no código gerado: escolha outro nome.`);
139
+ }
140
+ }
141
+ /** Valida o nome (kebab-case, sem palavra reservada) e devolve os nomes derivados dele. */
142
+ export function usableNames(name, what, options) {
143
+ assertValidName(name, what);
144
+ const names = deriveNames(name);
145
+ assertNotReserved(names, what, options);
146
+ return names;
147
+ }
148
+ /**
149
+ * Os plurais cujo singular a regra de tirar o `s` erra, e o que costuma ser o singular. Terminam
150
+ * em `ies` (`categories`, de `category`), `sses`, `xes`, `ches` e `shes` (`classes`, `boxes`,
151
+ * `matches`, `wishes`: o singular perde o `es`), ou em `us` e `ss`, que já parecem singulares
152
+ * (`status`, `address`) e não têm um palpite.
153
+ */
154
+ const IRREGULAR_PLURALS = [
155
+ { suffix: 'ies', singular: (plural) => `${plural.slice(0, -3)}y` },
156
+ { suffix: 'sses', singular: (plural) => plural.slice(0, -2) },
157
+ { suffix: 'xes', singular: (plural) => plural.slice(0, -2) },
158
+ { suffix: 'ches', singular: (plural) => plural.slice(0, -2) },
159
+ { suffix: 'shes', singular: (plural) => plural.slice(0, -2) },
160
+ { suffix: 'us', singular: () => undefined },
161
+ { suffix: 'ss', singular: () => undefined },
162
+ ];
163
+ /**
164
+ * O singular de um plural, pela regra simples que serve ao inglês e ao português: tira o `s`
165
+ * final (`suppliers` vira `supplier`, `pedidos` vira `pedido`). Onde a regra erra, recusa em vez
166
+ * de derivar um nome errado em silêncio (`status` viraria `statu`, `categories`, `categorie`):
167
+ * o plural que termina em `ies`, `us`, `ss`, `xes`, `ches`, `shes` ou `sses` pede o singular
168
+ * explícito (`--entity`), e a mensagem sugere o provável (`categories`: `--entity category`).
169
+ */
170
+ export function singularOf(plural) {
171
+ const singular = plural.slice(0, -1);
172
+ if (!plural.endsWith('s') || singular.length < 2 || singular.endsWith('-')) {
173
+ throw new UsageError(`não consegui derivar o singular de '${plural}': o nome do domínio é o plural e termina em 's'. Informe o singular com --entity.`);
174
+ }
175
+ const irregular = IRREGULAR_PLURALS.find(({ suffix }) => plural.endsWith(suffix));
176
+ if (irregular) {
177
+ const guess = irregular.singular(plural);
178
+ throw new UsageError(guess === undefined
179
+ ? `'${plural}' parece já estar no singular, e tirar o 's' daria '${singular}': informe a entidade com --entity (ela tem que diferir do nome do domínio).`
180
+ : `tirar o 's' de '${plural}' daria '${singular}', que provavelmente não é o singular: informe a entidade com --entity (provavelmente --entity ${guess}).`);
181
+ }
182
+ return singular;
183
+ }
184
+ /**
185
+ * Deriva os nomes de um domínio. `plural` é o nome do domínio (`suppliers`); `singular` é a
186
+ * entidade (`supplier`) e, quando falta, sai da regra de `singularOf`. O singular não pode ser
187
+ * igual ao plural, senão o tipo da entidade e o da lista teriam o mesmo nome.
188
+ */
189
+ export function domainNames(plural, singular) {
190
+ assertValidName(plural, 'o nome do domínio');
191
+ if (singular !== undefined)
192
+ assertValidName(singular, 'a entidade');
193
+ // O singular e o plural viram tipos, constantes e variáveis locais: nenhum pode ser palavra
194
+ // reservada nem um nome global
195
+ const pluralNames = usableNames(plural, 'o nome do domínio', { globals: true });
196
+ const entity = singular ?? singularOf(plural);
197
+ if (entity === plural) {
198
+ throw new UsageError(`a entidade '${entity}' é igual ao nome do domínio: o singular tem que diferir do plural.`);
199
+ }
200
+ return {
201
+ plural: pluralNames,
202
+ singular: usableNames(entity, 'a entidade', { globals: true }),
203
+ };
204
+ }
@@ -0,0 +1,45 @@
1
+ import { Project as MorphProject, type SourceFile } from 'ts-morph';
2
+ import type { Project } from '../project.js';
3
+ /** O que o plano criaria e alteraria, com caminhos relativos à raiz do projeto, em ordem. */
4
+ export interface PlanSummary {
5
+ created: string[];
6
+ modified: string[];
7
+ }
8
+ /**
9
+ * O plano de mudanças de um comando, todo em memória. Os arquivos de código entram num `Project`
10
+ * do ts-morph sem tsconfig e sem sistema de arquivos: ele só enxerga o que o plano carregou
11
+ * (os arquivos novos e os de costura), nada é lido nem escrito por ele, e a checagem de tipos
12
+ * nunca roda. Os arquivos que não são código (JSON de mensagens) ficam numa lista à parte. Nada
13
+ * vai para o disco até `commit()`, então um erro no meio do caminho não deixa o projeto pela
14
+ * metade, e `summary()` mostra o que seria feito (o `--dry-run`).
15
+ */
16
+ export declare class ChangePlan {
17
+ #private;
18
+ readonly project: Project;
19
+ /** O ts-morph do plano. Só os arquivos tocados entram nele. */
20
+ readonly morph: MorphProject;
21
+ constructor(project: Project);
22
+ /** O arquivo existe no disco ou o plano já vai criá-lo. */
23
+ has(file: string): boolean;
24
+ /** O plano vai criar o arquivo, ou ele já existe no disco como arquivo (pasta não conta). */
25
+ hasFile(file: string): boolean;
26
+ /** Um arquivo de código novo, com o conteúdo dado. */
27
+ createSource(file: string, text: string): SourceFile;
28
+ /** Um arquivo novo que não é código, com o conteúdo dado. */
29
+ createText(file: string, content: string): void;
30
+ /** Os arquivos de código criados pelo plano, em ordem de caminho. */
31
+ createdSources(): SourceFile[];
32
+ /** Um arquivo de código que já existe no projeto, aberto no plano (uma costura). */
33
+ source(file: string): SourceFile;
34
+ /** O texto atual de um arquivo existente, com as edições do plano. */
35
+ readText(file: string): string;
36
+ /** Troca o conteúdo de um arquivo existente que não é código. */
37
+ editText(file: string, content: string): void;
38
+ /** O que o plano criaria e alteraria. Arquivos editados que ficaram iguais não contam. */
39
+ summary(): PlanSummary;
40
+ /**
41
+ * Grava o plano no disco. Antes de escrever, confere de novo que nenhum arquivo novo apareceu
42
+ * no caminho de um que o plano ia criar. Os arquivos novos saem primeiro e os alterados depois.
43
+ */
44
+ commit(): PlanSummary;
45
+ }
@@ -0,0 +1,147 @@
1
+ import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
2
+ import path from 'node:path';
3
+ import { IndentationText, Project as MorphProject, QuoteKind, ts } from 'ts-morph';
4
+ import { UsageError } from "../errors.js";
5
+ /**
6
+ * O plano de mudanças de um comando, todo em memória. Os arquivos de código entram num `Project`
7
+ * do ts-morph sem tsconfig e sem sistema de arquivos: ele só enxerga o que o plano carregou
8
+ * (os arquivos novos e os de costura), nada é lido nem escrito por ele, e a checagem de tipos
9
+ * nunca roda. Os arquivos que não são código (JSON de mensagens) ficam numa lista à parte. Nada
10
+ * vai para o disco até `commit()`, então um erro no meio do caminho não deixa o projeto pela
11
+ * metade, e `summary()` mostra o que seria feito (o `--dry-run`).
12
+ */
13
+ export class ChangePlan {
14
+ project;
15
+ /** O ts-morph do plano. Só os arquivos tocados entram nele. */
16
+ morph;
17
+ #createdSources = new Map();
18
+ #loadedSources = new Map();
19
+ #createdFiles = new Map();
20
+ #editedTexts = new Map();
21
+ constructor(project) {
22
+ this.project = project;
23
+ this.morph = new MorphProject({
24
+ useInMemoryFileSystem: true,
25
+ skipAddingFilesFromTsConfig: true,
26
+ skipFileDependencyResolution: true,
27
+ skipLoadingLibFiles: true,
28
+ compilerOptions: {
29
+ jsx: ts.JsxEmit.Preserve,
30
+ target: ts.ScriptTarget.ES2023,
31
+ module: ts.ModuleKind.ESNext,
32
+ moduleResolution: ts.ModuleResolutionKind.Bundler,
33
+ allowImportingTsExtensions: true,
34
+ resolveJsonModule: true,
35
+ noEmit: true,
36
+ },
37
+ manipulationSettings: {
38
+ indentationText: IndentationText.TwoSpaces,
39
+ quoteKind: QuoteKind.Single,
40
+ useTrailingCommas: true,
41
+ },
42
+ });
43
+ }
44
+ /** O arquivo existe no disco ou o plano já vai criá-lo. */
45
+ has(file) {
46
+ return this.#createdSources.has(file) || this.#createdFiles.has(file) || existsSync(file);
47
+ }
48
+ /** O plano vai criar o arquivo, ou ele já existe no disco como arquivo (pasta não conta). */
49
+ hasFile(file) {
50
+ if (this.#createdSources.has(file) || this.#createdFiles.has(file))
51
+ return true;
52
+ return existsSync(file) && statSync(file).isFile();
53
+ }
54
+ /** Um arquivo de código novo, com o conteúdo dado. */
55
+ createSource(file, text) {
56
+ this.#assertNew(file);
57
+ const source = this.morph.createSourceFile(file, text);
58
+ this.#createdSources.set(file, source);
59
+ return source;
60
+ }
61
+ /** Um arquivo novo que não é código, com o conteúdo dado. */
62
+ createText(file, content) {
63
+ this.#assertNew(file);
64
+ this.#createdFiles.set(file, content);
65
+ }
66
+ /** Os arquivos de código criados pelo plano, em ordem de caminho. */
67
+ createdSources() {
68
+ return [...this.#createdSources.entries()]
69
+ .sort(([a], [b]) => a.localeCompare(b))
70
+ .map(([, source]) => source);
71
+ }
72
+ /** Um arquivo de código que já existe no projeto, aberto no plano (uma costura). */
73
+ source(file) {
74
+ const created = this.#createdSources.get(file);
75
+ if (created)
76
+ return created;
77
+ const loaded = this.#loadedSources.get(file);
78
+ if (loaded)
79
+ return loaded.file;
80
+ const original = this.#readExisting(file);
81
+ const sourceFile = this.morph.createSourceFile(file, original);
82
+ this.#loadedSources.set(file, { file: sourceFile, original });
83
+ return sourceFile;
84
+ }
85
+ /** O texto atual de um arquivo existente, com as edições do plano. */
86
+ readText(file) {
87
+ return this.#editedTexts.get(file)?.content ?? this.#readExisting(file);
88
+ }
89
+ /** Troca o conteúdo de um arquivo existente que não é código. */
90
+ editText(file, content) {
91
+ const original = this.#editedTexts.get(file)?.original ?? this.#readExisting(file);
92
+ this.#editedTexts.set(file, { original, content });
93
+ }
94
+ /** O que o plano criaria e alteraria. Arquivos editados que ficaram iguais não contam. */
95
+ summary() {
96
+ const relative = (file) => path.relative(this.project.root, file).split(path.sep).join('/');
97
+ const created = [...this.#createdSources.keys(), ...this.#createdFiles.keys()].map(relative);
98
+ const modified = [
99
+ ...[...this.#loadedSources]
100
+ .filter(([, s]) => s.file.getFullText() !== s.original)
101
+ .map(([f]) => f),
102
+ ...[...this.#editedTexts].filter(([, t]) => t.content !== t.original).map(([f]) => f),
103
+ ].map(relative);
104
+ return { created: created.sort(), modified: modified.sort() };
105
+ }
106
+ /**
107
+ * Grava o plano no disco. Antes de escrever, confere de novo que nenhum arquivo novo apareceu
108
+ * no caminho de um que o plano ia criar. Os arquivos novos saem primeiro e os alterados depois.
109
+ */
110
+ commit() {
111
+ const summary = this.summary();
112
+ for (const file of [...this.#createdSources.keys(), ...this.#createdFiles.keys()]) {
113
+ if (existsSync(file))
114
+ throw new UsageError(`'${this.#display(file)}' já existe: nada foi escrito.`);
115
+ }
116
+ for (const [file, source] of this.#createdSources)
117
+ write(file, source.getFullText());
118
+ for (const [file, content] of this.#createdFiles)
119
+ write(file, content);
120
+ for (const [file, { file: source, original }] of this.#loadedSources) {
121
+ if (source.getFullText() !== original)
122
+ write(file, source.getFullText());
123
+ }
124
+ for (const [file, { original, content }] of this.#editedTexts) {
125
+ if (content !== original)
126
+ write(file, content);
127
+ }
128
+ return summary;
129
+ }
130
+ #assertNew(file) {
131
+ if (this.has(file))
132
+ throw new UsageError(`'${this.#display(file)}' já existe.`);
133
+ }
134
+ #readExisting(file) {
135
+ if (!existsSync(file) || !statSync(file).isFile()) {
136
+ throw new UsageError(`'${this.#display(file)}' não existe.`);
137
+ }
138
+ return readFileSync(file, 'utf8');
139
+ }
140
+ #display(file) {
141
+ return path.relative(this.project.root, file).split(path.sep).join('/');
142
+ }
143
+ }
144
+ function write(file, content) {
145
+ mkdirSync(path.dirname(file), { recursive: true });
146
+ writeFileSync(file, content);
147
+ }
@@ -0,0 +1,51 @@
1
+ import type { DomainNames } from './names.js';
2
+ import type { ChangePlan } from './plan.js';
3
+ /**
4
+ * O `export * from './entities/<entidade>'` no fim de `src/schemas/index.ts`. A ordem do arquivo
5
+ * é a em que as entidades chegaram, e não a alfabética: o export novo vai depois do último (ou no
6
+ * fim do arquivo, se ele ainda não tem nenhum).
7
+ */
8
+ export declare function registerSchema(plan: ChangePlan, to: DomainNames): void;
9
+ /** Onde um repositório entra em `src/repositories/index.ts`. */
10
+ export interface RepositoryEntry {
11
+ /** A pasta em `src/repositories`, em kebab-case: `customers`. */
12
+ directory: string;
13
+ /** A fábrica: `createCustomersRepository`. */
14
+ factory: string;
15
+ /** A chave no mapa `factories`: `customers`. */
16
+ key: string;
17
+ }
18
+ /**
19
+ * Se `src/repositories/index.ts` já exporta a pasta do repositório (`export * from './<pasta>'`).
20
+ * É como o `prumo add` sabe que o domínio já está registrado.
21
+ */
22
+ export declare function isRepositoryRegistered(plan: ChangePlan, directory: string): boolean;
23
+ /**
24
+ * Registra o repositório em `src/repositories/index.ts`: o `import { <fábrica> }`, o `export *
25
+ * from` da pasta e a entrada `<chave>: <fábrica>` no mapa `factories`, cada um na posição
26
+ * alfabética. O tipo do container acompanha o mapa sozinho.
27
+ */
28
+ export declare function registerRepositoryEntry(plan: ChangePlan, entry: RepositoryEntry): void;
29
+ /** O repositório de um domínio novo: a pasta, a fábrica e a chave saem do nome do domínio. */
30
+ export declare function registerRepository(plan: ChangePlan, to: DomainNames): void;
31
+ /** O que um domínio exporta de `src/queries/index.ts`. */
32
+ export interface QueriesEntry {
33
+ /** O arquivo em `src/queries`, sem a extensão: `customers`. */
34
+ module: string;
35
+ /** Os nomes reexportados: `customerKeys`, `customerQueries`. */
36
+ exports: string[];
37
+ }
38
+ /** Se `src/queries/index.ts` já reexporta o módulo (`export { ... } from './<módulo>'`). */
39
+ export declare function isQueriesRegistered(plan: ChangePlan, module: string): boolean;
40
+ /**
41
+ * O `export { <nomes> } from './<módulo>'` em `src/queries/index.ts`, na posição alfabética pelo
42
+ * nome do arquivo, no formato das linhas que já existem.
43
+ */
44
+ export declare function registerQueriesEntry(plan: ChangePlan, entry: QueriesEntry): void;
45
+ /**
46
+ * O `export { <entidade>Keys, <entidade>Queries } from './<dominio>'` em `src/queries/index.ts`,
47
+ * na posição alfabética pelo nome do arquivo, no formato das linhas que já existem.
48
+ */
49
+ export declare function registerQueries(plan: ChangePlan, to: DomainNames): void;
50
+ /** As três costuras de um domínio novo: `schemas`, `repositories` e `queries`. */
51
+ export declare function registerDomain(plan: ChangePlan, to: DomainNames): void;