Add explanation on how to modify the generated files

purescript-react · Nov 8, 2024 · 19b0082 · 19b0082
1 parent bee08c7
commit 19b0082
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 16 deletions.
diff --git a/codegen/index.js b/codegen/index.js
@@ -5,10 +5,15 @@ const htmlGenFile = "../src/React/Basic/DOM/Generated.purs";
 const htmlSimplifiedGenFile = "../src/React/Basic/DOM/Simplified/Generated.purs";
 const svgGenFile = "../src/React/Basic/DOM/SVG.purs";
 
-const htmlHeader = `-- | ----------------------------------------
+const warningHeader = `-- | ------------------------------------------------------------
 -- | THIS FILE IS GENERATED -- DO NOT EDIT IT
--- | ----------------------------------------
+-- | Instead edit files under 'codegen/' dir and regenerate with:
+-- |     npm install
+-- |     node ./index.js
+-- | ------------------------------------------------------------
+`;
 
+const htmlHeader = `${warningHeader}
 module React.Basic.DOM.Generated where
 
 import Data.Nullable (Nullable)
@@ -23,10 +28,7 @@ import Web.DOM (Node)
 
 `;
 
-const simplifiedHtmlHeader = `-- | ----------------------------------------
--- | THIS FILE IS GENERATED -- DO NOT EDIT IT
--- | ----------------------------------------
-
+const simplifiedHtmlHeader = `${warningHeader}
 module React.Basic.DOM.Simplified.Generated where
 
 import Data.Nullable (Nullable)
@@ -55,10 +57,7 @@ const propType = (e, p) => {
   }
 }
 
-const svgHeader = `-- | ----------------------------------------
--- | THIS FILE IS GENERATED -- DO NOT EDIT IT
--- | ----------------------------------------
-
+const svgHeader = `${warningHeader}
 module React.Basic.DOM.SVG where
 
 import Data.Nullable (Nullable)

diff --git a/src/React/Basic/DOM/Generated.purs b/src/React/Basic/DOM/Generated.purs
@@ -1,6 +1,9 @@
--- | ----------------------------------------
+-- | ------------------------------------------------------------
 -- | THIS FILE IS GENERATED -- DO NOT EDIT IT
--- | ----------------------------------------
+-- | Instead edit files under 'codegen/' dir and regenerate with:
+-- |     npm install
+-- |     node ./index.js
+-- | ------------------------------------------------------------
 
 module React.Basic.DOM.Generated where
 

diff --git a/src/React/Basic/DOM/SVG.purs b/src/React/Basic/DOM/SVG.purs
@@ -1,6 +1,9 @@
--- | ----------------------------------------
+-- | ------------------------------------------------------------
 -- | THIS FILE IS GENERATED -- DO NOT EDIT IT
--- | ----------------------------------------
+-- | Instead edit files under 'codegen/' dir and regenerate with:
+-- |     npm install
+-- |     node ./index.js
+-- | ------------------------------------------------------------
 
 module React.Basic.DOM.SVG where
 

diff --git a/src/React/Basic/DOM/Simplified/Generated.purs b/src/React/Basic/DOM/Simplified/Generated.purs
@@ -1,6 +1,9 @@
--- | ----------------------------------------
+-- | ------------------------------------------------------------
 -- | THIS FILE IS GENERATED -- DO NOT EDIT IT
--- | ----------------------------------------
+-- | Instead edit files under 'codegen/' dir and regenerate with:
+-- |     npm install
+-- |     node ./index.js
+-- | ------------------------------------------------------------
 
 module React.Basic.DOM.Simplified.Generated where