@cadence-app/compiler 0.2.0 → 0.3.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
@@ -31,7 +31,8 @@ npx mini dev mon-mini-programme
31
31
 
32
32
  `init` écrit un mini-programme qui se compile déjà, dans un dossier absent ou vide. Trois
33
33
  squelettes, par `--template` : `page` (défaut), `onglets` pour une tab bar, `composant` pour un
34
- composant à soi.
34
+ composant à soi. Il pose aussi un `package.json` et un `tsconfig.json`, sans lesquels un éditeur
35
+ souligne en rouge des imports que le build résout très bien — reste à lancer `npm install`.
35
36
 
36
37
  `build` rend un dossier `dist` : `engine.js`, `app.js`, la feuille de thème, les pages, les icônes
37
38
  et une archive prête à distribuer. Le budget du moteur — 30 ko gzip — est vérifié à chaque
package/dist/cli.js CHANGED
@@ -149,7 +149,9 @@ function printInitReport(report, requestedDir) {
149
149
  console.log(` + ${file}`);
150
150
  }
151
151
  console.log('');
152
- console.log(`Pour le voir tourner : mini dev ${requestedDir}`);
152
+ console.log('Pour le voir tourner :');
153
+ console.log(` cd ${requestedDir} && npm install`);
154
+ console.log(' npx mini dev .');
153
155
  }
154
156
  function printPublishReport(report) {
155
157
  const sizeKo = (report.archiveBytes / 1024).toFixed(1);
package/dist/index.d.ts CHANGED
@@ -13,6 +13,7 @@ export { stableHash } from './hash.js';
13
13
  export { buildMiniApp, BuildError } from './build.js';
14
14
  export type { BuildOptions, BuildSummary, SizeReport } from './build.js';
15
15
  export { initProject, InitError } from './init-project.js';
16
+ export { projectToolingFiles } from './project-tooling.js';
16
17
  export type { InitOptions, InitReport } from './init-project.js';
17
18
  export { PROJECT_TEMPLATES, PROJECT_TEMPLATE_NAMES, isProjectTemplateName, } from './project-templates.js';
18
19
  export type { ProjectTemplate, ProjectTemplateName } from './project-templates.js';
package/dist/index.js CHANGED
@@ -8,6 +8,7 @@ export { parseManifest, allManifestPages, ManifestError } from "./manifest.js";
8
8
  export { stableHash } from "./hash.js";
9
9
  export { buildMiniApp, BuildError } from "./build.js";
10
10
  export { initProject, InitError } from "./init-project.js";
11
+ export { projectToolingFiles } from "./project-tooling.js";
11
12
  export { PROJECT_TEMPLATES, PROJECT_TEMPLATE_NAMES, isProjectTemplateName, } from "./project-templates.js";
12
13
  export { startDevServer } from "./dev-server.js";
13
14
  export { credentialsPath, readCredentials, writeCredentials, clearCredentials, normalizeRemoteUrl, } from "./publish/credentials.js";
@@ -1,6 +1,7 @@
1
1
  import { mkdir, readdir, writeFile } from 'node:fs/promises';
2
2
  import path from 'node:path';
3
3
  import { PROJECT_TEMPLATES, PROJECT_TEMPLATE_NAMES, isProjectTemplateName, } from "./project-templates.js";
4
+ import { projectToolingFiles } from "./project-tooling.js";
4
5
  export class InitError extends Error {
5
6
  constructor(reason) {
6
7
  super(reason);
@@ -19,6 +20,7 @@ export async function initProject(options) {
19
20
  const manifest = PROJECT_TEMPLATES[template].manifestFor(name);
20
21
  const contents = {
21
22
  [MANIFEST_FILE]: `${JSON.stringify(manifest, null, 2)}\n`,
23
+ ...(await projectToolingFiles(name)),
22
24
  ...PROJECT_TEMPLATES[template].sources,
23
25
  };
24
26
  const files = Object.keys(contents).sort();
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Les deux fichiers qui font comprendre le projet à un éditeur : `@cadence/core`
3
+ * n'existe pas sur npm, donc TypeScript ne le résout qu'avec un `paths` vers le
4
+ * paquet publié.
5
+ */
6
+ export declare function projectToolingFiles(name: string): Promise<Readonly<Record<string, string>>>;
@@ -0,0 +1,54 @@
1
+ import { readFile } from 'node:fs/promises';
2
+ import path from 'node:path';
3
+ import { fileURLToPath } from 'node:url';
4
+ /** Les quatre noms que le shim du compilateur fournit à un mini-programme (ADR-031). */
5
+ const VIRTUAL_MODULES = ['core', 'runtime', 'bridge', 'router'];
6
+ /* `src` dans le dépôt, `dist` une fois publié : le manifeste du compilateur est
7
+ à la même hauteur dans les deux, un cran au-dessus de ce module. */
8
+ const OWN_MANIFEST = path.join(path.dirname(fileURLToPath(import.meta.url)), '..', 'package.json');
9
+ const TSCONFIG = {
10
+ compilerOptions: {
11
+ target: 'ES2022',
12
+ lib: ['ES2022', 'DOM'],
13
+ module: 'ESNext',
14
+ moduleResolution: 'bundler',
15
+ strict: true,
16
+ noEmit: true,
17
+ types: [],
18
+ paths: Object.fromEntries(VIRTUAL_MODULES.map((module) => [
19
+ `@cadence/${module}`,
20
+ [`./node_modules/@cadence-app/${module}`],
21
+ ])),
22
+ },
23
+ include: ['pages/**/*.ts', 'components/**/*.ts', 'app.ts'],
24
+ };
25
+ /**
26
+ * Les deux fichiers qui font comprendre le projet à un éditeur : `@cadence/core`
27
+ * n'existe pas sur npm, donc TypeScript ne le résout qu'avec un `paths` vers le
28
+ * paquet publié.
29
+ */
30
+ export async function projectToolingFiles(name) {
31
+ const own = JSON.parse(await readFile(OWN_MANIFEST, 'utf8'));
32
+ return {
33
+ 'package.json': `${JSON.stringify(packageJsonFor(name, own), null, 2)}\n`,
34
+ 'tsconfig.json': `${JSON.stringify(TSCONFIG, null, 2)}\n`,
35
+ };
36
+ }
37
+ /*
38
+ * Les quatre paquets du moteur sont déclarés un par un, et non laissés en
39
+ * dépendances transitives du compilateur : pnpm ne les remonterait pas à la
40
+ * racine de `node_modules`, où `paths` va les chercher.
41
+ */
42
+ function packageJsonFor(name, own) {
43
+ const devDependencies = { [own.name]: `^${own.version}` };
44
+ for (const module of VIRTUAL_MODULES) {
45
+ const dependency = `@cadence-app/${module}`;
46
+ devDependencies[dependency] = rangeFor(own.dependencies?.[dependency]);
47
+ }
48
+ return { name, private: true, type: 'module', devDependencies };
49
+ }
50
+ /* Le dépôt déclare ses paquets en `workspace:*`, que pnpm remplace par une
51
+ version à la publication. Lancé depuis un clone, `init` n'a donc rien à citer. */
52
+ function rangeFor(declared) {
53
+ return declared === undefined || declared.startsWith('workspace:') ? '*' : `^${declared}`;
54
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cadence-app/compiler",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Compilation des templates en instructions, SCSS scopé, bundling",
5
5
  "keywords": [
6
6
  "compiler",