Minor generated metadata improvements

simshadows · simshadows · commit 49a3f4524993 · 2022-08-09T16:45:01.000+10:00
diff --git a/solves/base-template/package.json.ejs b/solves/base-template/package.json.ejs
@@ -1,7 +1,10 @@
 {
-  "name": "<%- name %>",
+  "name": <%- JSON.stringify(String(name)) %>,
+  "author": <%- JSON.stringify(String(author)) %>,
+  "version": "0.0.0-dev",
   "private": true,
   "license": "MIT",
+  "description": <%- JSON.stringify(String(description)) %>,
   "scripts": {
     "test": "jest",
     "build": "webpack",
diff --git a/solves/base-template/src/components/App.css b/solves/base-template/src/components/App.css
@@ -8,6 +8,13 @@
     width: 100%;
 }
 
+#app-title {
+    width: 100%;
+}
+#app-title > * {
+    margin: 0;
+}
+
 .input-wrapper {
     flex: 1 0 0;
 
diff --git a/solves/base-template/src/components/App.tsx.ejs b/solves/base-template/src/components/App.tsx.ejs
@@ -113,6 +113,9 @@ export class App extends React.Component<{}, State> {
 -%>
 
         return <div id="app">
+            <div id="app-title">
+                <h1><%- appTitle -%></h1>
+            </div>
 <%-
                 Object.entries(allTextInputs).map(([k, v]) => {
                     const x = {};
diff --git a/solves/base-template/webpack.config.js.ejs b/solves/base-template/webpack.config.js.ejs
@@ -15,9 +15,9 @@ function htmlWebpackPluginCommon(configArgs, mergeIn) {
 
         minify: (configArgs.mode === "production"),
 
-        title: "Solves Prototype",
-        author: "simshadows",
-        description: "Solves Prototype",
+        title: "<%- appTitle -%>",
+        author: "<%- author -%>",
+        description: "<%- description -%>",
         keywords: "",
         //favicon: path.resolve(__dirname, "src", "favicon.png"),
     }, mergeIn);
diff --git a/solves/src/spec-parse.ts b/solves/src/spec-parse.ts
@@ -85,6 +85,10 @@ interface OutputPartialSpec {
 
 export interface SpecValues {
     name:            string;
+    appTitle:        string;
+    author:          string;
+    description:     string;
+
     encoding:        string;
     constraintsCode: string;
     
@@ -140,6 +144,10 @@ export function getSpecValues(specPath: string): SpecValues {
 
     return {
         name:            ensureStr(fileData?.name, "name"),
+        appTitle:        ensureStr(fileData?.appTitle, "appTitle"),
+        author:          ensureStr(fileData?.author, "author"),
+        description:     ensureStr(fileData?.description, "description"),
+
         encoding:        ensureStr(fileData?.encoding, "encoding"),
         constraintsCode: ensureStr(fileData?.constraints, "constraints"),
 
diff --git a/solves/test/cnf-sat-alt.yml b/solves/test/cnf-sat-alt.yml
@@ -1,4 +1,7 @@
 name: cnf-sat
+appTitle: CNF-SAT Solver (with dummy output for debugging)
+author: simshadows
+description: your description here
 
 input-base:
   variable:
diff --git a/solves/test/cnf-sat.yml b/solves/test/cnf-sat.yml
@@ -1,4 +1,7 @@
 name: cnf-sat
+appTitle: CNF-SAT Solver
+author: simshadows
+description: your description here
 
 input-base:
   variable:
diff --git a/solves/test/sample-spec.yml b/solves/test/sample-spec.yml
@@ -1,4 +1,7 @@
 name: graph-colouring
+appTitle: Vertex Colouring Solver
+author: simshadows
+description: your description here
 
 input-base:
   colour:
@@ -32,7 +35,7 @@ input-constrained:
 
 output:
   color:
-    title: Colourings
+    title: Valid Vertex Colouring
     fieldLabels:
       - Vertex
       - Colour
diff --git a/solves/test/vertex-cover.yml b/solves/test/vertex-cover.yml
@@ -1,4 +1,7 @@
 name: vertex-cover
+appTitle: Vertex Cover Solver
+author: simshadows
+description: your description here
 
 input-base:
   vertex:
