Merge pull request #565 from kethinov/0.30.0

0.30.0

Author: kethinov

CHANGELOG.md

@@ -6,6 +6,14 @@ This project's versioning tracks Roosevelt's versioning. When some version numbe
 
 - Put your changes here...
 
+## 0.30.0
+
+- Added `standard-mpa-install`, `standard-static-install`, and `standard-spa-install` CLI flags.
+- Added a demonstration of a global model for static sites.
+- Added more favicon PNG files.
+- Fixed a bug that caused favicon.ico to be placed in the wrong folder in static site generator mode.
+- Updated dependencies.
+
 ## 0.29.4
 
 - Fixed a bug with the default helpers CSS file.

generators/app/index.js

@@ -10,8 +10,23 @@ module.exports = class extends Generator {
     super(args, opts)
 
     // if this is executed like `yo roosevelt --standard-install custom-app-name`, cache that name so it can override appName later
-    if (opts.standardInstall && typeof opts.standardInstall === 'string') cache.standardInstall = opts.standardInstall
-    else if (args[0] === '--standard-install') cache.standardInstall = args[1] // if mkroosevelt is being used, type of installation in args[0] and the project name will be in args[1]
+    if (opts.standardInstall && typeof opts.standardInstall === 'string') {
+      cache.standardInstall = opts.standardInstall
+      cache.standardMpaInstall = opts.standardInstall
+    }
+    if (opts.standardMpaInstall && typeof opts.standardMpaInstall === 'string') {
+      cache.standardInstall = opts.standardMpaInstall
+      cache.standardMpaInstall = opts.standardMpaInstall
+    }
+    if (opts.standardStaticInstall && typeof opts.standardStaticInstall === 'string') cache.standardStaticInstall = opts.standardStaticInstall
+    if (opts.standardSpaInstall && typeof opts.standardSpaInstall === 'string') cache.standardSpaInstall = opts.standardSpaInstall
+
+    if (args[0] === '--standard-install' || args[0] === '--standard-mpa-install') {
+      cache.standardInstall = args[1] // if mkroosevelt is being used, type of installation in args[0] and the project name will be in args[1]
+      cache.standardMpaInstall = args[1] // if mkroosevelt is being used, type of installation in args[0] and the project name will be in args[1]
+    }
+    if (args[0] === '--standard-static-install') cache.standardStaticInstall = args[1] // if mkroosevelt is being used, type of installation in args[0] and the project name will be in args[1]
+    if (args[0] === '--standard-spa-install') cache.standardSpaInstall = args[1] // if mkroosevelt is being used, type of installation in args[0] and the project name will be in args[1]
 
     this.option('standard-install', {
       alias: 's',
@@ -20,6 +35,24 @@ module.exports = class extends Generator {
       desc: 'Skips all prompts and creates a Roosevelt app with all defaults.'
     })
 
+    this.option('standard-mpa-install', {
+      type: String,
+      required: false,
+      desc: 'Skips all prompts and creates a Roosevelt multi-page app with all defaults.'
+    })
+
+    this.option('standard-static-install', {
+      type: String,
+      required: false,
+      desc: 'Skips all prompts and creates a Roosevelt static site generator with all defaults.'
+    })
+
+    this.option('standard-spa-install', {
+      type: String,
+      required: false,
+      desc: 'Skips all prompts and creates a Roosevelt single page app with all defaults.'
+    })
+
     this.option('skip-closing-message', {
       type: Boolean,
       required: false,
@@ -29,9 +62,11 @@ module.exports = class extends Generator {
   }
 
   start () {
-    if (this.options['standard-install']) {
+    if (this.options['standard-install'] || this.options['standard-mpa-install'] || this.options['standard-static-install'] || this.options['standard-spa-install']) {
       this.appName = defaults.appName
-      if (cache.standardInstall) this.appName = cache.standardInstall
+      if (cache.standardMpaInstall) this.appName = cache.standardMpaInstall
+      else if (cache.standardStaticInstall) this.appName = cache.standardStaticInstall
+      else if (cache.standardSpaInstall) this.appName = cache.standardSpaInstall
       this.packageName = helper.sanitizePackageName(this.appName)
       return true
     }
@@ -80,7 +115,7 @@ module.exports = class extends Generator {
   }
 
   chooseAppVariant () {
-    if (this.options['standard-install']) return true
+    if (this.options['standard-install'] || this.options['standard-mpa-install'] || this.options['standard-static-install'] || this.options['standard-spa-install']) return true
 
     return this.prompt(
       [
@@ -102,16 +137,24 @@ module.exports = class extends Generator {
       })
   }
 
-  setSpaModeIfSelected () {
-    if (this.configMode !== 'SPA — single page app (advanced users only)') return true
-    this.spaMode = true
-  }
-
   setStaticSiteModeIfSelected () {
+    if (this.options['standard-static-install']) {
+      this.staticSiteMode = true
+      return true
+    }
     if (this.configMode !== 'Static site generator (easiest to use, but fewer features available)') return true
     this.staticSiteMode = true
   }
 
+  setSpaModeIfSelected () {
+    if (this.options['standard-spa-install']) {
+      this.spaMode = true
+      return true
+    }
+    if (this.configMode !== 'SPA — single page app (advanced users only)') return true
+    this.spaMode = true
+  }
+
   chooseAppVariantToCustomize () {
     if (this.configMode !== 'Custom app') return true
 
@@ -291,7 +334,7 @@ module.exports = class extends Generator {
   }
 
   async makeApp () {
-    const standardInstall = this.options['standard-install']
+    const standardInstall = this.options['standard-install'] || this.options['standard-mpa-install'] || this.options['standard-static-install'] || this.options['standard-spa-install']
     let destination
     if (standardInstall === 'true') destination = this.packageName
     else if (standardInstall || this.createDir) destination = standardInstall || this.dirname
@@ -326,6 +369,15 @@ module.exports = class extends Generator {
       }
     ]
 
+    if (this.staticSiteMode) {
+      this.symlinks.push(
+        {
+          source: '${staticsRoot}/images/favicon.ico', // eslint-disable-line
+          dest: '${publicFolder}/favicon.ico' // eslint-disable-line
+        }
+      )
+    }
+
     this.cssCompiler = this.cssCompiler || 'default'
     if (this.cssCompiler !== 'none') {
       if (this.cssCompiler === 'default') {
@@ -641,6 +693,26 @@ module.exports = class extends Generator {
       this.templatePath('statics/images/favicon.ico'),
       this.destinationPath('statics/images/favicon.ico')
     )
+    this.fs.copy(
+      this.templatePath('statics/images/favicon-16x16.png'),
+      this.destinationPath('statics/images/favicon-16x16.png')
+    )
+    this.fs.copy(
+      this.templatePath('statics/images/favicon-32x32.png'),
+      this.destinationPath('statics/images/favicon-32x32.png')
+    )
+    this.fs.copy(
+      this.templatePath('statics/images/favicon-48x48.png'),
+      this.destinationPath('statics/images/favicon-48x48.png')
+    )
+    this.fs.copy(
+      this.templatePath('statics/images/favicon-64x64.png'),
+      this.destinationPath('statics/images/favicon-64x64.png')
+    )
+    this.fs.copy(
+      this.templatePath('statics/images/favicon-128x128.png'),
+      this.destinationPath('statics/images/favicon-128x128.png')
+    )
 
     this.fs.copy(
       this.templatePath(`statics/js/main${appVariant}.js`),

generators/app/templates/build.js

@@ -1,3 +1,12 @@
 (async () => {
-  await require('roosevelt')().init()
+  await require('roosevelt')({
+    onBeforeMiddleware: (app) => {
+      // this defines a model used on all static pages, unless overridden by a page-specific model
+      app.get('htmlModels')['*'] = {
+        global: {
+          hello: 'world!'
+        }
+      }
+    }
+  }).init()
 })()

generators/app/templates/defaults.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "check-if-css-is-disabled": "~2.0.0",
-    "roosevelt": "~0.29.0",
+    "roosevelt": "~0.30.0",
     "webpack": "~5.98.0"
   },
   "appName": "My Roosevelt Sample App",
@@ -101,7 +101,7 @@
     "semantic-forms": "~5.0.0"
   },
   "single-page-express": {
-    "single-page-express": "~1.2.0"
+    "single-page-express": "~2.0.0"
   },
   "clientControllers": {
     "enable": true,

generators/app/templates/mvc/controllers/teddy/404.js

@@ -1,5 +1,5 @@
 module.exports = (router, app) => {
-  router.route('*').all(async (req, res) => {
+  router.route('*all').all(async (req, res) => {
     const model = await require('models/server')(req, res)
     model.content.pageTitle = 'Not Found'
     res.status(404)

generators/app/templates/mvc/views/teddy/layouts/main.html

@@ -10,6 +10,11 @@
     <script>window.addEventListener('error', (event) => { if (event?.target?.tagName === 'LINK') { window.linkTagError = true } }, true)</script>
     <link rel="preload" href="/css/styles.css" as="style">
     <link rel="preload" href="/js/main.js" as="script">
+    <link rel="icon" type="image/png" href="/images/favicon-16x16.png" sizes="16x16">
+    <link rel="icon" type="image/png" href="/images/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="/images/favicon-48x48.png" sizes="48x48">
+    <link rel="icon" type="image/png" href="/images/favicon-64x64.png" sizes="64x64">
+    <link rel="icon" type="image/png" href="/images/favicon-128x128.png" sizes="128x128">
     <link rel="stylesheet" href="/css/styles.css">
     <script src="/js/main.js" defer></script>
   </head>

generators/app/templates/mvc/views/teddy/layouts/main.spa.html

@@ -10,6 +10,11 @@
     <script>window.addEventListener('error', (event) => { if (event?.target?.tagName === 'LINK') { window.linkTagError = true } }, true)</script>
     <link rel="preload" href="/css/styles.css" as="style">
     <link rel="preload" href="/js/main.js" as="script">
+    <link rel="icon" type="image/png" href="/images/favicon-16x16.png" sizes="16x16">
+    <link rel="icon" type="image/png" href="/images/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="/images/favicon-48x48.png" sizes="48x48">
+    <link rel="icon" type="image/png" href="/images/favicon-64x64.png" sizes="64x64">
+    <link rel="icon" type="image/png" href="/images/favicon-128x128.png" sizes="128x128">
     <link rel="stylesheet" href="/css/styles.css">
     <script src="/js/main.js" defer></script>
   </head>

generators/app/templates/mvc/views/vanilla/homepage.html

@@ -10,6 +10,11 @@
     <script>window.addEventListener('error', (event) => { if (event?.target?.tagName === 'LINK') { window.linkTagError = true } }, true)</script>
     <link rel="preload" href="/css/styles.css" as="style">
     <link rel="preload" href="/js/main.js" as="script">
+    <link rel="icon" type="image/png" href="/images/favicon-16x16.png" sizes="16x16">
+    <link rel="icon" type="image/png" href="/images/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="/images/favicon-48x48.png" sizes="48x48">
+    <link rel="icon" type="image/png" href="/images/favicon-64x64.png" sizes="64x64">
+    <link rel="icon" type="image/png" href="/images/favicon-128x128.png" sizes="128x128">
     <link rel="stylesheet" href="/css/styles.css">
     <script src="/js/main.js" defer></script>
   </head>

generators/app/templates/package.json.ejs

@@ -16,7 +16,7 @@
     <% } %>
     "nodemon": "~3.1.0",
     "standard": "~17.1.0",
-    "stylelint": "~16.16.0",
+    "stylelint": "~16.17.0",
     <%- stylelintPostCssModule -%>
     <%- stylelintConfigModule %>
   },

generators/app/templates/statics/images/favicon-128x128.png

@@ -3,6 +3,7 @@
     <article id="homepage">
       <p>{content.hello}</p>
       <p>{content.picLabel}</p>
+      <p>hello {global.hello}</p>
       <p><img src="{teddyPath}" alt="Sample image"></p>
     </article>
   </arg>

generators/app/templates/statics/images/favicon-16x16.png

@@ -10,6 +10,11 @@
     <script>window.addEventListener('error', (event) => { if (event?.target?.tagName === 'LINK') { window.linkTagError = true } }, true)</script>
     <link rel="preload" href="/css/styles.css" as="style">
     <link rel="preload" href="/js/main.js" as="script">
+    <link rel="icon" type="image/png" href="/images/favicon-16x16.png" sizes="16x16">
+    <link rel="icon" type="image/png" href="/images/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="/images/favicon-48x48.png" sizes="48x48">
+    <link rel="icon" type="image/png" href="/images/favicon-64x64.png" sizes="64x64">
+    <link rel="icon" type="image/png" href="/images/favicon-128x128.png" sizes="128x128">
     <link rel="stylesheet" href="/css/styles.css">
     <script src="/js/main.js" defer></script>
   </head>