From 4e12b640b7e562e5a3a3825a1565f7e15b1e7d12 Mon Sep 17 00:00:00 2001 From: Grant Hutchinson Date: Tue, 21 Jul 2020 21:21:58 -0400 Subject: [PATCH] Task/issue 322 remove need for MDIMPORT, rename MYROUTES (#387) * task: replace MYROUTES with * task: remove need for MDIMPORT * docs: remove references to predefined vars MDIMPORT and MYROUTES * fix: remove all test/doc references to MDIMPORT * fix: remove additional ref to MDIMPORT * fix: move mdimport to start of file * fix: test template example Co-authored-by: hutchgrant --- packages/cli/src/lifecycles/scaffold.js | 7 ++--- packages/cli/src/templates/app-template.js | 2 +- packages/cli/src/templates/page-template.js | 1 - .../src/templates/page-template.js | 1 - .../src/templates/blog-template.js | 2 -- .../src/templates/blog-template.js | 2 -- .../src/templates/page-template.js | 2 -- .../src/templates/post-template.js | 2 -- .../src/templates/blog-template.js | 2 -- .../src/templates/page-template.js | 2 -- .../src/templates/app-template.js | 2 +- .../src/templates/page-template.js | 1 - .../src/templates/page-template.js | 1 - .../src/templates/page-template.js | 1 - www/pages/docs/css-and-images.md | 4 --- www/pages/docs/layouts.md | 31 ++++--------------- www/pages/getting-started/branding.md | 4 --- www/pages/getting-started/creating-content.md | 2 -- www/pages/getting-started/key-concepts.md | 1 - www/templates/app-template.js | 2 +- www/templates/home-template.js | 2 -- www/templates/page-template.js | 2 -- 22 files changed, 12 insertions(+), 64 deletions(-) diff --git a/packages/cli/src/lifecycles/scaffold.js b/packages/cli/src/lifecycles/scaffold.js index b185038d4..7109b8d6f 100644 --- a/packages/cli/src/lifecycles/scaffold.js +++ b/packages/cli/src/lifecycles/scaffold.js @@ -10,11 +10,10 @@ const writePageComponentsFromTemplate = async (compilation) => { : path.join(context.templatesDir, `${file.template}-template.js`); const templateData = await fs.readFile(pageTemplatePath, 'utf8'); - let result = templateData.toString().replace(/entry/g, `wc-md-${file.label}`); - + + result = `import '${file.mdFile}';\n${result}`; result = result.replace(/page-template/g, `eve-${file.label}`); - result = result.replace(/MDIMPORT;/, `import '${file.mdFile}';`); resolve(result); } catch (err) { @@ -84,7 +83,7 @@ const writeRoutes = async(compilation) => { >`; }); - const result = data.toString().replace(/MYROUTES/g, routes.join('')); + const result = data.toString().replace(/<\/routes>/g, routes.join('')); // Create app directory so that app-template relative imports are correct const appDir = path.join(compilation.context.scratchDir, 'app'); diff --git a/packages/cli/src/templates/app-template.js b/packages/cli/src/templates/app-template.js index 60b8d5fb6..f26096e26 100644 --- a/packages/cli/src/templates/app-template.js +++ b/packages/cli/src/templates/app-template.js @@ -4,7 +4,7 @@ class AppComponent extends LitElement { render() { return html` - MYROUTES +

404 Not found

 `; } diff --git a/packages/cli/src/templates/page-template.js b/packages/cli/src/templates/page-template.js index 77bc375f2..894fa40e0 100644 --- a/packages/cli/src/templates/page-template.js +++ b/packages/cli/src/templates/page-template.js @@ -1,5 +1,4 @@ import { html, LitElement } from 'lit-element'; -MDIMPORT; class PageTemplate extends LitElement { render() { diff --git a/packages/cli/test/cases/build.config.theme/src/templates/page-template.js b/packages/cli/test/cases/build.config.theme/src/templates/page-template.js index 1641d9481..e2306013f 100644 --- a/packages/cli/test/cases/build.config.theme/src/templates/page-template.js +++ b/packages/cli/test/cases/build.config.theme/src/templates/page-template.js @@ -1,6 +1,5 @@ import { html, LitElement } from 'lit-element'; import '../styles/my-brand.css'; -MDIMPORT; class PageTemplate extends LitElement { render() { diff --git a/packages/cli/test/cases/build.data.graph-custom-frontmatter/src/templates/blog-template.js b/packages/cli/test/cases/build.data.graph-custom-frontmatter/src/templates/blog-template.js index 28ce6074a..87ff4086d 100644 --- a/packages/cli/test/cases/build.data.graph-custom-frontmatter/src/templates/blog-template.js +++ b/packages/cli/test/cases/build.data.graph-custom-frontmatter/src/templates/blog-template.js @@ -2,8 +2,6 @@ import { html, LitElement } from 'lit-element'; import client from '@greenwood/cli/data/client'; import gql from 'graphql-tag'; -MDIMPORT; - class BlogTemplate extends LitElement { static get properties() { diff --git a/packages/cli/test/cases/build.data.graph/src/templates/blog-template.js b/packages/cli/test/cases/build.data.graph/src/templates/blog-template.js index 50f08f75d..110338c66 100644 --- a/packages/cli/test/cases/build.data.graph/src/templates/blog-template.js +++ b/packages/cli/test/cases/build.data.graph/src/templates/blog-template.js @@ -3,8 +3,6 @@ import client from '@greenwood/cli/data/client'; import ChildrenQuery from '@greenwood/cli/data/queries/children'; import '../components/header'; -MDIMPORT; - class BlogTemplate extends LitElement { static get properties() { diff --git a/packages/cli/test/cases/build.data.graph/src/templates/page-template.js b/packages/cli/test/cases/build.data.graph/src/templates/page-template.js index bc70f14bb..88022b8a1 100644 --- a/packages/cli/test/cases/build.data.graph/src/templates/page-template.js +++ b/packages/cli/test/cases/build.data.graph/src/templates/page-template.js @@ -1,8 +1,6 @@ import { html, LitElement } from 'lit-element'; import '../components/header'; -MDIMPORT; - class PageTemplate extends LitElement { constructor() { diff --git a/packages/cli/test/cases/build.data.graph/src/templates/post-template.js b/packages/cli/test/cases/build.data.graph/src/templates/post-template.js index a47886df3..6dc53b8d1 100644 --- a/packages/cli/test/cases/build.data.graph/src/templates/post-template.js +++ b/packages/cli/test/cases/build.data.graph/src/templates/post-template.js @@ -3,8 +3,6 @@ import gql from 'graphql-tag'; import { html, LitElement } from 'lit-element'; import '../components/header'; -MDIMPORT; - class PostTemplate extends LitElement { static get properties() { diff --git a/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/blog-template.js b/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/blog-template.js index 21e910acb..d21cfd5eb 100644 --- a/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/blog-template.js +++ b/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/blog-template.js @@ -2,8 +2,6 @@ import { html, LitElement } from 'lit-element'; import '../components/footer'; import '../components/header'; -MDIMPORT; - class BlogTemplate extends LitElement { constructor() { diff --git a/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/page-template.js b/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/page-template.js index de36af971..3bb9c1b8c 100644 --- a/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/page-template.js +++ b/packages/cli/test/cases/build.default.workspace-getting-started/src/templates/page-template.js @@ -3,8 +3,6 @@ import '../components/footer'; import '../components/header'; import '../styles/theme.css'; -MDIMPORT; - class PageTemplate extends LitElement { constructor() { diff --git a/packages/cli/test/cases/build.default.workspace-template-app/src/templates/app-template.js b/packages/cli/test/cases/build.default.workspace-template-app/src/templates/app-template.js index 7e866dcc4..d04a46b99 100644 --- a/packages/cli/test/cases/build.default.workspace-template-app/src/templates/app-template.js +++ b/packages/cli/test/cases/build.default.workspace-template-app/src/templates/app-template.js @@ -4,7 +4,7 @@ class AppComponent extends LitElement { render() { return html` - MYROUTES +

My Custom App Template

`; } diff --git a/packages/cli/test/cases/build.default.workspace-template-page-style/src/templates/page-template.js b/packages/cli/test/cases/build.default.workspace-template-page-style/src/templates/page-template.js index 9ccad35e0..00c45ce62 100644 --- a/packages/cli/test/cases/build.default.workspace-template-page-style/src/templates/page-template.js +++ b/packages/cli/test/cases/build.default.workspace-template-page-style/src/templates/page-template.js @@ -1,7 +1,6 @@ import { html, LitElement } from 'lit-element'; import '../styles/theme.css'; import css from '../styles/style.css'; -MDIMPORT; class PageTemplate extends LitElement { render() { diff --git a/packages/cli/test/cases/build.default.workspace-template-page/src/templates/page-template.js b/packages/cli/test/cases/build.default.workspace-template-page/src/templates/page-template.js index 394bf5808..1e0d17ae8 100644 --- a/packages/cli/test/cases/build.default.workspace-template-page/src/templates/page-template.js +++ b/packages/cli/test/cases/build.default.workspace-template-page/src/templates/page-template.js @@ -1,5 +1,4 @@ import { html, LitElement } from 'lit-element'; -MDIMPORT; class PageTemplate extends LitElement { render() { diff --git a/packages/cli/test/cases/build.default.workspace-user-directory-mapping/src/templates/page-template.js b/packages/cli/test/cases/build.default.workspace-user-directory-mapping/src/templates/page-template.js index d08a451ba..0db79707e 100644 --- a/packages/cli/test/cases/build.default.workspace-user-directory-mapping/src/templates/page-template.js +++ b/packages/cli/test/cases/build.default.workspace-user-directory-mapping/src/templates/page-template.js @@ -1,6 +1,5 @@ import { html, LitElement } from 'lit-element'; import '../components/header/header'; -MDIMPORT; class PageTemplate extends LitElement { render() { diff --git a/www/pages/docs/css-and-images.md b/www/pages/docs/css-and-images.md index 719d036c4..8b005e1d5 100644 --- a/www/pages/docs/css-and-images.md +++ b/www/pages/docs/css-and-images.md @@ -38,8 +38,6 @@ The below is an example of using _theme.css_ to load a Google font and apply a g import { html, LitElement } from 'lit-element'; import '../styles/theme.css'; -MDIMPORT; - class PageTemplate extends LitElement { constructor() { @@ -62,8 +60,6 @@ For any of your components and page templates, it is recommended to use the [Sha import { html, LitElement } from 'lit-element'; import pageTemplateCss '../styles/page-template.css'; // if you like your CSS-in-JS -MDIMPORT; - class PageTemplate extends LitElement { constructor() { diff --git a/www/pages/docs/layouts.md b/www/pages/docs/layouts.md index b7feeb6e7..b084faf35 100644 --- a/www/pages/docs/layouts.md +++ b/www/pages/docs/layouts.md @@ -13,13 +13,12 @@ Greenwood has two types of templates: ### Page Template -In order to make a page template, you need to create a `LitElement` based custom element that contains a number of pre-defined variables, elements, and imports. You need to do this in a file within your _templates/_ directory named _-template.js_. +In order to make a page template, you need to create a `LitElement` based custom element that contains a predefined `` element. The `` element is where your markdown page content will be placed once compiled. You need to do this in a file within your _templates/_ directory named _-template.js_. -Here is an example `page-template.js` (the [default](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/cli/templates/page-template.js) one included with Greenwood). You can just copy / paste this to start your own page template. +Here is an example `page-template.js` (the [default](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/cli/templates/page-template.js) one included with Greenwood which is the default page-template.js if no other is defined). You can just copy / paste this to start your own page template. ```js import { html, LitElement } from 'lit-element'; -MDIMPORT; class PageTemplate extends LitElement { render() { @@ -38,44 +37,26 @@ customElements.define('page-template', PageTemplate); > **Note**: the filename must be in the format `