@cadence-app/compiler 0.2.0 → 0.4.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,10 +31,11 @@ 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
- `build` rend un dossier `dist` : `engine.js`, `app.js`, la feuille de thème, les pages, les icônes
37
- et une archive prête à distribuer. Le budget du moteur — 30 ko gzip — est vérifié à chaque
37
+ `build` rend un dossier `dist` : `engine.js`, `app.js`, la feuille de thème, les pages, les icônes,
38
+ le dossier `assets/` copié tel quel et une archive prête à distribuer. Le budget du moteur — 30 ko gzip — est vérifié à chaque
38
39
  construction, et un dépassement fait échouer la commande.
39
40
 
40
41
  `dev` sert le mini-programme dans un navigateur, avec un hôte simulé : le geste retour tient à la
@@ -0,0 +1,19 @@
1
+ export interface CopiedAsset {
2
+ /** Chemin dans le bundle, tel qu'une feuille de style doit l'écrire. */
3
+ readonly path: string;
4
+ readonly bytes: number;
5
+ }
6
+ /**
7
+ * Copie `assets/` du mini-programme dans le bundle, à l'identique.
8
+ *
9
+ * Polices, images et sons n'ont jamais eu de chemin : le conteneur sait pourtant
10
+ * servir n'importe quel fichier du bundle, types MIME compris, et seul le build
11
+ * manquait. Un mini-programme qui veut sa propre voix typographique n'a donc
12
+ * aujourd'hui que la police du système.
13
+ *
14
+ * Les noms sont gardés tels quels plutôt qu'empreintés : la feuille de style du
15
+ * mini-programme les écrit à la main, et les réécrire demanderait de relire le
16
+ * CSS compilé. Le cache se règle ailleurs — un bundle est versionné entier et
17
+ * installé d'un bloc.
18
+ */
19
+ export declare function copyAppAssets(miniappDir: string, outDir: string): Promise<readonly CopiedAsset[]>;
@@ -0,0 +1,41 @@
1
+ import { existsSync } from 'node:fs';
2
+ import { copyFile, mkdir, readdir, stat } from 'node:fs/promises';
3
+ import path from 'node:path';
4
+ const ASSETS_DIRECTORY = 'assets';
5
+ /**
6
+ * Copie `assets/` du mini-programme dans le bundle, à l'identique.
7
+ *
8
+ * Polices, images et sons n'ont jamais eu de chemin : le conteneur sait pourtant
9
+ * servir n'importe quel fichier du bundle, types MIME compris, et seul le build
10
+ * manquait. Un mini-programme qui veut sa propre voix typographique n'a donc
11
+ * aujourd'hui que la police du système.
12
+ *
13
+ * Les noms sont gardés tels quels plutôt qu'empreintés : la feuille de style du
14
+ * mini-programme les écrit à la main, et les réécrire demanderait de relire le
15
+ * CSS compilé. Le cache se règle ailleurs — un bundle est versionné entier et
16
+ * installé d'un bloc.
17
+ */
18
+ export async function copyAppAssets(miniappDir, outDir) {
19
+ const sourceDir = path.join(miniappDir, ASSETS_DIRECTORY);
20
+ if (!existsSync(sourceDir)) {
21
+ return [];
22
+ }
23
+ const copied = await copyTree(sourceDir, path.join(outDir, ASSETS_DIRECTORY), ASSETS_DIRECTORY);
24
+ return [...copied].sort((left, right) => left.path.localeCompare(right.path));
25
+ }
26
+ async function copyTree(sourceDir, targetDir, bundlePrefix) {
27
+ await mkdir(targetDir, { recursive: true });
28
+ const entries = await readdir(sourceDir, { withFileTypes: true });
29
+ const copied = [];
30
+ for (const entry of entries) {
31
+ const source = path.join(sourceDir, entry.name);
32
+ const bundlePath = `${bundlePrefix}/${entry.name}`;
33
+ if (entry.isDirectory()) {
34
+ copied.push(...(await copyTree(source, path.join(targetDir, entry.name), bundlePath)));
35
+ continue;
36
+ }
37
+ await copyFile(source, path.join(targetDir, entry.name));
38
+ copied.push({ path: bundlePath, bytes: (await stat(source)).size });
39
+ }
40
+ return copied;
41
+ }
package/dist/build.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { type CopiedAsset } from './app-assets.js';
1
2
  import type { MiniAppManifest } from './manifest.js';
2
3
  export declare class BuildError extends Error {
3
4
  constructor(message: string);
@@ -21,6 +22,7 @@ export interface BuildSummary {
21
22
  readonly minified: boolean;
22
23
  readonly engine: SizeReport;
23
24
  readonly app: SizeReport;
25
+ readonly assets: readonly CopiedAsset[];
24
26
  readonly zipFile: string | null;
25
27
  }
26
28
  /**
package/dist/build.js CHANGED
@@ -6,6 +6,7 @@ import { fileURLToPath } from 'node:url';
6
6
  import { gzipSync } from 'node:zlib';
7
7
  import * as esbuild from 'esbuild';
8
8
  import JSZip from 'jszip';
9
+ import { copyAppAssets } from "./app-assets.js";
9
10
  import { generateRenderFunction } from "./template/codegen.js";
10
11
  import { parseTemplate } from "./template/parser.js";
11
12
  import { compileStyle } from "./style/compile-style.js";
@@ -70,6 +71,7 @@ export async function buildMiniApp(options) {
70
71
  await bundleHostScripts(outDir, minified);
71
72
  await writeHtmlShells(outDir, manifest.language ?? DEFAULT_DOCUMENT_LANGUAGE);
72
73
  await writeFile(path.join(outDir, 'manifest.json'), JSON.stringify(manifest, null, 2));
74
+ const assets = await copyAppAssets(miniappDir, outDir);
73
75
  const engine = await measure(path.join(outDir, 'engine.js'));
74
76
  const app = await measure(path.join(outDir, 'app.js'));
75
77
  const zipFile = (options.zip ?? true) ? await writeBundleArchive(outDir, manifest) : null;
@@ -82,6 +84,7 @@ export async function buildMiniApp(options) {
82
84
  minified,
83
85
  engine,
84
86
  app,
87
+ assets,
85
88
  zipFile,
86
89
  };
87
90
  }
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);
@@ -182,6 +184,11 @@ function printSummary(summary) {
182
184
  }
183
185
  console.log(` engine.js : ${engineGzipKo} ko gzip (${describeEngineBudget(budgetVerdict)})`);
184
186
  console.log(` app.js : ${appGzipKo} ko gzip`);
187
+ if (summary.assets.length > 0) {
188
+ const assetsKo = (summary.assets.reduce((total, asset) => total + asset.bytes, 0) / 1024).toFixed(1);
189
+ const plural = summary.assets.length > 1 ? 's' : '';
190
+ console.log(` actifs : ${summary.assets.length} fichier${plural}, ${assetsKo} ko`);
191
+ }
185
192
  if (summary.zipFile !== null) {
186
193
  console.log(` archive : ${summary.zipFile}`);
187
194
  }
@@ -10,6 +10,11 @@ const CONTENT_TYPES = {
10
10
  '.png': 'image/png',
11
11
  '.jpg': 'image/jpeg',
12
12
  '.svg': 'image/svg+xml',
13
+ '.webp': 'image/webp',
14
+ '.avif': 'image/avif',
15
+ '.txt': 'text/plain; charset=utf-8',
16
+ '.woff2': 'font/woff2',
17
+ '.woff': 'font/woff',
13
18
  '.zip': 'application/zip',
14
19
  };
15
20
  const REBUILD_DEBOUNCE_MS = 150;
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,61 @@
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
+ /*
16
+ * Les trois mini-programmes du dépôt importent leur module de données avec
17
+ * l'extension — `'../../data/produits.ts'`. Le bundler accepte les deux
18
+ * formes, TypeScript non : sans ce drapeau, celle-là lève un TS5097 et
19
+ * l'éditeur rougit sur du code qui compile.
20
+ */
21
+ allowImportingTsExtensions: true,
22
+ strict: true,
23
+ noEmit: true,
24
+ types: [],
25
+ paths: Object.fromEntries(VIRTUAL_MODULES.map((module) => [
26
+ `@cadence/${module}`,
27
+ [`./node_modules/@cadence-app/${module}`],
28
+ ])),
29
+ },
30
+ include: ['pages/**/*.ts', 'components/**/*.ts', 'app.ts'],
31
+ };
32
+ /**
33
+ * Les deux fichiers qui font comprendre le projet à un éditeur : `@cadence/core`
34
+ * n'existe pas sur npm, donc TypeScript ne le résout qu'avec un `paths` vers le
35
+ * paquet publié.
36
+ */
37
+ export async function projectToolingFiles(name) {
38
+ const own = JSON.parse(await readFile(OWN_MANIFEST, 'utf8'));
39
+ return {
40
+ 'package.json': `${JSON.stringify(packageJsonFor(name, own), null, 2)}\n`,
41
+ 'tsconfig.json': `${JSON.stringify(TSCONFIG, null, 2)}\n`,
42
+ };
43
+ }
44
+ /*
45
+ * Les quatre paquets du moteur sont déclarés un par un, et non laissés en
46
+ * dépendances transitives du compilateur : pnpm ne les remonterait pas à la
47
+ * racine de `node_modules`, où `paths` va les chercher.
48
+ */
49
+ function packageJsonFor(name, own) {
50
+ const devDependencies = { [own.name]: `^${own.version}` };
51
+ for (const module of VIRTUAL_MODULES) {
52
+ const dependency = `@cadence-app/${module}`;
53
+ devDependencies[dependency] = rangeFor(own.dependencies?.[dependency]);
54
+ }
55
+ return { name, private: true, type: 'module', devDependencies };
56
+ }
57
+ /* Le dépôt déclare ses paquets en `workspace:*`, que pnpm remplace par une
58
+ version à la publication. Lancé depuis un clone, `init` n'a donc rien à citer. */
59
+ function rangeFor(declared) {
60
+ return declared === undefined || declared.startsWith('workspace:') ? '*' : `^${declared}`;
61
+ }
@@ -7,4 +7,6 @@ export declare class TemplateParseError extends Error {
7
7
  readonly reason: string;
8
8
  constructor(message: string, line: number, column: number);
9
9
  }
10
+ /** Les balises qui ne peuvent rien contenir : aucune n'attend de fermeture. */
11
+ export declare const VOID_ELEMENTS: ReadonlySet<string>;
10
12
  export declare function parseTemplate(source: string): TemplateNode[];
@@ -15,7 +15,8 @@ export class TemplateParseError extends Error {
15
15
  }
16
16
  const INTERPOLATION_OPEN = '{{';
17
17
  const INTERPOLATION_CLOSE = '}}';
18
- const VOID_ELEMENTS = new Set([
18
+ /** Les balises qui ne peuvent rien contenir : aucune n'attend de fermeture. */
19
+ export const VOID_ELEMENTS = new Set([
19
20
  'area',
20
21
  'base',
21
22
  'br',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cadence-app/compiler",
3
- "version": "0.2.0",
3
+ "version": "0.4.0",
4
4
  "description": "Compilation des templates en instructions, SCSS scopé, bundling",
5
5
  "keywords": [
6
6
  "compiler",
@@ -48,8 +48,8 @@
48
48
  "@cadence-app/bridge": "0.1.0",
49
49
  "@cadence-app/core": "0.1.0",
50
50
  "@cadence-app/router": "0.1.0",
51
- "@cadence-app/runtime": "0.1.0",
52
- "@cadence-app/theme": "0.1.0",
51
+ "@cadence-app/runtime": "0.2.0",
52
+ "@cadence-app/theme": "0.2.0",
53
53
  "esbuild": "^0.25.0",
54
54
  "jszip": "^3.10.1",
55
55
  "postcss": "^8.5.1",