@caweb/template 1.0.9 → 1.0.11

package/README.md

@@ -1,6 +1,40 @@
-# Official CAWebPublishing Template
+# CAWebPublishing Template
+This is the CAWebPublishing Template built with [handlebars](https://handlebarsjs.com/) and used by the CAWebPublishing Servce for static site generation.
 
-- Logicless [handlebars](https://handlebarsjs.com/) template
-- Paths should be absolute and not relative
-- Uses @caweb/framework
-- Uses @caweb/icon-library
+## Using npm to test the website locally  
+
+``` npm run install ```  
+This command will install all the necessary npm packages to test your markup.  
+
+---
+
+``` npm run serve ```  
+This command will run the website in your [http://localhost:9000](http://localhost:9000) and watch for any changes made.  
+
+---
+
+``` npm run serve:audit ```  
+This command does the same as `npm run serve` and will also generate a WordPress CSS Audit, IBM Accessibility Checker Report, and a JSHint Report page as well.  
+
+---
+
+## Changing colorscheme
+Since this template utilizes the [@caweb/framework](https://github.com/CAWebPublishing/framework) and [@caweb/icon-library](https://github.com/CAWebPublishing/icon-library) you can change the scheme by running
+
+` npm run serve:scheme:<color> ` - where \<color\> is one of the following:   
+- none - *Note: this will disable the [@caweb/framework](https://github.com/CAWebPublishing/framework) and [@caweb/icon-library](https://github.com/CAWebPublishing/icon-library), only do this if providing your own frontend UI  
+- delta
+- eureka
+- mono
+- oceanside
+- orangecounty
+- pasorobles
+- sacramento
+- santabarbara
+- santacruz
+- shasta
+- sierra
+- trinity
+
+## Output
+All the web content is generated to the `/build/` folder.

package/components/alert/alert.html

@@ -9,18 +9,16 @@
         <div class="alert alert-primary alert-dismissible">
             <div class="container">
                 {{#if this.header }}
-                <h6 class="alert-level" >
+                <span class="alert-level" >
                     {{#if this.icon }}
                     <span class="ca-gov-icon-{{ this.icon }}"></span>
                     {{/if}}
                     {{ this.header }}
-                </h6>
+                </span>
                 {{/if}}
 
                 {{#if this.msg }}
-                <div>
                     {{ this.msg }}
-                </div>
                 {{/if}}
                 {{#if this.url }}
 				<a href="{{ this.url }}" target="_blank" class="alert-link btn btn-outline-dark btn-sm">{{ this.text }}</a>

package/package.json

@@ -1,15 +1,22 @@
 {
     "name": "@caweb/template",
-    "version": "1.0.9",
+    "version": "1.0.11",
     "author": "CAWebPublishing",
     "description": "CAWebPublishing Template",
     "license": "ISC",
-    "main": "src/index.html",
     "homepage": "https://github.com/CAWebPublishing/template#readme",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/CAWebPublishing/template.git"
     },
+    "files": [
+        "components",
+        "content",
+        "forms",
+        "media",
+        "patterns",
+        "semantics"
+    ],
     "keywords": [
         "caweb",
         "cagov",
@@ -24,16 +31,26 @@
     "scripts": {
         "webpack": "webpack",
         "test": "echo \"Error: run tests from root\" && exit 0",
-        "testa": "node test.js",
-        "build": "webpack build --config ./node_modules/@caweb/webpack/webpack.config.js",
-        "serve:blank": "set NODE_OPTIONS='--template ./patterns/blank.html --search-template ./patterns/search.html' && webpack serve --config ./node_modules/@caweb/webpack/webpack.config.js",
-        "serve": "set NODE_OPTIONS='--template ./patterns/index.html --search-template ./patterns/search.html' && webpack serve --config ./node_modules/@caweb/webpack/webpack.config.js --host danny.com --port 8888"
-    },
-    "peerDependencies": {
-        "@caweb/framework": "^1.8.6",
-        "@caweb/icon-library": "^1.1.3"
+        "serve": "webpack serve --config ./node_modules/@caweb/webpack/webpack.config.js ./node_modules/@caweb/webpack/tests/webpack.tests.js --merge",
+        "serve:blank": "set NODE_OPTIONS='--template ./patterns/blank.html --search-template ./patterns/search.html' && npm run serve",
+        "serve:delta": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme delta' && npm run serve",
+        "serve:eureka": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme eureka' && npm run serve",
+        "serve:mono": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme mono' && npm run serve",
+        "serve:oceanside": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme oceanside' && npm run serve",
+        "serve:orangecounty": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme orangecounty' && npm run serve",
+        "serve:pasorobles": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme pasorobles' && npm run serve",
+        "serve:sacramento": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme sacramento' && npm run serve",
+        "serve:santabarbara": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme santabarbara' && npm run serve",
+        "serve:santacruz": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme santacruz' && npm run serve",
+        "serve:shasta": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme shasta' && npm run serve",
+        "serve:sierra": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme sierra' && npm run serve",
+        "serve:trinity": "set NODE_OPTIONS='--template ./patterns/default.html --search-template ./patterns/search.html --scheme trinity' && npm run serve"
     },
     "devDependencies": {
-        "@caweb/webpack": "^1.5.10"
+        "@caweb/framework": "^1.9.0",
+        "@caweb/icon-library": "^1.1.4"
+    },
+    "dependencies": {
+        "@caweb/webpack": "^1.6.0"
     }
 }

package/patterns/{index.html → default.html}

@@ -35,10 +35,10 @@
           <div id="main-content" class="main-content" tabindex="-1">
             <main class="main-primary">
 
-              {{#if htmlWebpackPlugin.options.templateParameters.bodyHtmlSnippet }}
-              {{{ htmlWebpackPlugin.options.templateParameters.bodyHtmlSnippet }}}
+              {{#if partial }}
+                {{{ partial }}}
               {{else}}
-              {{> index }}
+                {{> index }}
               {{/if}}
 
             </main>

package/semantics/utility-header.html

@@ -13,9 +13,9 @@
       </div>
       <p class="official-tag">Official website of the State of California</p>
     </div>
-    {{#if header.utility }}
+    {{#if header.utility.links }}
     <div class="settings-links">
-      {{#each header.utility }}
+      {{#each header.utility.links }}
       {{#if this.url }}{{#if this.label }}
       <a href="{{ this.url }}">{{ this.label }}</a>
       {{/if}}{{/if}}

package/.distignore

@@ -1,21 +0,0 @@
-# A set of files you probably don't want in your WordPress.org distribution
-.babelrc
-.deployignore
-.distignore
-.editorconfig
-.eslintignore
-.eslintrc
-.git
-.gitignore
-.github
-.gitlab-ci.yml
-.travis.yml
-.DS_Store
-.*~
-private
-tests
-vendor
-node_modules
-*.sql
-*.tar.gz
-*.zip

package/.github/workflows/publish.yml

@@ -1,22 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Publish Template
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/CHANGELOG.md

@@ -1,33 +0,0 @@
-v1.0.9
-- Updated npm packages
-
-v1.0.8
-- Updated npm packages
-
-v1.0.7
-- Updated npm packages
-
-v1.0.6
-- Updated npm packages
-
-v1.0.5
--  Fixed issue with search.html
-
-v1.0.4
-- Updated logo.png so that it uses a .png instead of .webp
-- Updated content/index.html to provide instructions
-
-v1.0.3
-- Card component card-title element changed from div to H5
-
-v1.0.2
-- Removed divi reference
-
-v1.0.1
-- Fixed issue with alerts component
-
-v1.0.0
-- Removed templating out of @caweb/html-webpack-plugin and into it's own individual package
-- Updated nav.header and utility.links references
-- Added new navFooter partial
-- Added Card component