create-nodality 1.0.95 → 1.0.97

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 (2) hide show
  1. package/bin/index.js +104 -21
  2. package/package.json +1 -1
package/bin/index.js CHANGED
@@ -13,20 +13,20 @@ function createProject(projectName) {
13
13
  }
14
14
 
15
15
  mkdirSync(projectPath);
16
- const srcPath = resolve(projectPath, "src");
17
- mkdirSync(srcPath);
18
-
19
- // Root dev index.html — used during `npm run dev` (live-server serves
20
- // upload/, but the root file is also kept as a development fallback
21
- // pointing at src/app.js via the node_modules importmap).
16
+ mkdirSync(resolve(projectPath, "src"));
17
+ mkdirSync(resolve(projectPath, "upload"));
18
+ mkdirSync(resolve(projectPath, "upload", "pages"));
19
+
20
+ // Root dev index.html used during `npm run dev` only as a
21
+ // sketchpad for the Designer (src/app.js). Live-server serves
22
+ // upload/ by default; this root file is opened manually when the
23
+ // user wants the Designer's code-generation panel.
22
24
  const indexHtml = `<!DOCTYPE html>
23
25
  <html lang="en">
24
26
  <head>
25
27
  <meta charset="UTF-8">
26
28
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
27
- <title>${projectName}</title>
28
-
29
- <!-- importmap to map "nodality" to node_modules path -->
29
+ <title>${projectName} — Designer</title>
30
30
  <script type="importmap">
31
31
  {
32
32
  "imports": {
@@ -37,15 +37,16 @@ function createProject(projectName) {
37
37
  </head>
38
38
  <body>
39
39
  <div id="mount"></div>
40
-
41
- <!-- User app -->
42
40
  <script type="module" src="src/app.js"></script>
43
41
  </body>
44
42
  </html>`;
45
43
  writeFileSync(resolve(projectPath, "index.html"), indexHtml);
46
44
 
47
- // src/app.js — the user's source. On first `npm run prerender`
48
- // the CLI clones this into upload/pages/<name>.js as the SSG entry.
45
+ // src/app.js — the Designer sketchpad. Declarative quick-start API.
46
+ // Opening this in a browser with `code: true` shows the imperative
47
+ // form on-page; copy pieces into upload/pages/index.js, or run
48
+ // \`npm run compile\` to get them as a companion .designer.js file.
49
+ // This file is NOT part of the SSG build.
49
50
  const appJs = `import { Des } from "nodality";
50
51
 
51
52
  const elements = [
@@ -64,7 +65,84 @@ new Des()
64
65
  code: true,
65
66
  });
66
67
  `;
67
- writeFileSync(resolve(srcPath, "app.js"), appJs);
68
+ writeFileSync(resolve(projectPath, "src", "app.js"), appJs);
69
+
70
+ // upload/index.html — the production shell. Prerender writes the
71
+ // static body into this file in place. Importmap points at the
72
+ // bundled library (./lib.bundle.js, emitted by webpack into upload/).
73
+ const uploadIndexHtml = `<!DOCTYPE html>
74
+ <html lang="en">
75
+ <head>
76
+ <meta charset="UTF-8">
77
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
78
+ <title>${projectName}</title>
79
+ <script type="importmap">
80
+ {
81
+ "imports": {
82
+ "nodality": "./lib.bundle.js"
83
+ }
84
+ }
85
+ </script>
86
+ </head>
87
+ <body>
88
+ <div id="mount"></div>
89
+ <script type="module" src="./pages/index.js"></script>
90
+ </body>
91
+ </html>
92
+ `;
93
+ writeFileSync(resolve(projectPath, "upload", "index.html"), uploadIndexHtml);
94
+
95
+ // upload/pages/index.js — THE canonical source of truth. Imperative
96
+ // class instances directly. This is what \`nodality prerender\` renders,
97
+ // and what the browser re-hydrates with after the static HTML loads.
98
+ // Refine this file by hand; copy any new pieces from the Designer
99
+ // panel (or `npm run compile`) as you sketch in src/app.js.
100
+ const uploadPageJs = `import { Text } from "nodality";
101
+ // SEO metadata — uncomment + customise once you have real content.
102
+ // \`applySeoMeta\` writes description / Open Graph / Twitter card /
103
+ // canonical / JSON-LD tags into <head>; these land in the static
104
+ // HTML at build time so crawlers and social-card scrapers see them.
105
+ // Origin is auto-resolved from window.location at runtime; call
106
+ // \`setSeoOrigin("https://example.com")\` once at app boot if you
107
+ // want the prerendered tags to use your production URL too.
108
+ //
109
+ // import {
110
+ // applySeoMeta, setSeoOrigin,
111
+ // websiteJsonLd, organizationJsonLd,
112
+ // } from "nodality/seo";
113
+ // setSeoOrigin("https://${projectName}.example.com");
114
+ // applySeoMeta({
115
+ // path: "/",
116
+ // title: "${projectName} — homepage",
117
+ // description: "One-sentence pitch shown in Google search snippets.",
118
+ // image: "/og-cover.jpg",
119
+ // jsonLd: {
120
+ // "@context": "https://schema.org",
121
+ // "@graph": [
122
+ // websiteJsonLd({ name: "${projectName}", url: "https://${projectName}.example.com" }),
123
+ // organizationJsonLd({ name: "${projectName}", url: "https://${projectName}.example.com" }),
124
+ // ],
125
+ // },
126
+ // });
127
+
128
+ new Text("Hello")
129
+ .set({
130
+ size: "S1",
131
+ font: "Arial",
132
+ })
133
+ .render("#mount");
134
+ `;
135
+ writeFileSync(resolve(projectPath, "upload", "pages", "index.js"), uploadPageJs);
136
+
137
+ // robots.txt — allow-all default + sitemap pointer. `nodality
138
+ // prerender` writes upload/sitemap.xml on every build (1.0.168+),
139
+ // so the URL declared here will resolve once you deploy.
140
+ const robotsTxt = `User-agent: *
141
+ Allow: /
142
+
143
+ Sitemap: https://${projectName}.example.com/sitemap.xml
144
+ `;
145
+ writeFileSync(resolve(projectPath, "upload", "robots.txt"), robotsTxt);
68
146
 
69
147
  // webpack outputs the bundle into upload/ so dev (live-server upload)
70
148
  // and prerender both see the same lib.bundle.js. clean:false so the
@@ -107,6 +185,9 @@ export default {
107
185
  scripts: {
108
186
  build: "webpack --config webpack.config.js",
109
187
  prerender: "nodality prerender",
188
+ // Run the Designer in jsdom and emit the imperative form as a
189
+ // companion file (upload/pages/index.designer.js). Non-destructive.
190
+ compile: "nodality compile",
110
191
  watch: "webpack --watch --config webpack.config.js",
111
192
  start: "live-server upload --port=4000 --watch=upload",
112
193
  dev: "npm-run-all --parallel watch start"
@@ -118,6 +199,7 @@ export default {
118
199
  "@babel/core": "^7.28.4",
119
200
  "@babel/preset-env": "^7.28.3",
120
201
  "babel-loader": "^9.2.1",
202
+ "jsdom": "^25.0.0",
121
203
  "live-server": "^1.2.2",
122
204
  "npm-run-all": "^4.1.5",
123
205
  "serve": "^14.0.0",
@@ -151,14 +233,15 @@ export default {
151
233
  console.log(`\n${color1abc9c}${bold}%s${reset}\n`, `Project "${projectName}" is ready! 🎉`);
152
234
  console.log("\nUsage:\n");
153
235
  console.log(` cd ${projectName}`);
154
- console.log(" npm run build # Rebuild library bundle into upload/");
155
- console.log(" npm run prerender # First run bootstraps upload/, then renders static HTML");
156
- console.log(" npm run dev # Start dev server (live-server on upload/) with watch");
157
- console.log(" npm start # Serve upload/ without watch");
236
+ console.log(" npm run dev # Live-server on upload/ + webpack watch");
237
+ console.log(" npm run compile # Sketch in src/app.js emit upload/pages/index.designer.js");
238
+ console.log(" npm run prerender # Render static HTML from upload/pages/*.js");
239
+ console.log(" npm run build # Rebuild lib.bundle.js into upload/");
158
240
  console.log("");
159
- console.log(
160
- ` Edit ${color1abc9c}nodality.config.json${reset} to set your public origin before running prerender.`
161
- );
241
+ console.log(` ${color1abc9c}src/app.js${reset} ← Designer sketchpad (declarative)`);
242
+ console.log(` ${color1abc9c}upload/pages/index.js${reset} canonical source (imperative). Edit this.`);
243
+ console.log("");
244
+ console.log(` Edit ${color1abc9c}nodality.config.json${reset} to set your public origin before prerender.`);
162
245
  }
163
246
 
164
247
  const args = process.argv.slice(2);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-nodality",
3
- "version": "1.0.95",
3
+ "version": "1.0.97",
4
4
  "description": "Project scaffolding tool for Nodality library",
5
5
  "bin": {
6
6
  "create-nodality": "bin/index.js"