Merge branch 'release/1.4.1' into v1

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Recipe Changelog
 
+## 1.4.1 - 2022.12.01
+### Changed
+* Move to using `ServicesTrait` and add getter methods for services
+* Switch to VitePress `^1.0.0-alpha.29` for the documentation
+* Add `allow-plugins` to the `composer.json` to enable CI to work
+* Wrap the fields in `<fieldset>` tags for semantic HTML & a11y
+* Remove the odd Craft `modifiedAttributes` styling when a field value is changed ([#12403](https://github.com/craftcms/cms/issues/12403))
+
 ## 1.4.0 - 2021.10.05
 ### Added
 * Added `.createRecipeMetaJsonLd()` to the Recipes field, to allow the creation of SEOmatic MetaJsonLd objects that can be manipulated and rendered on the page by SEOmatic

composer.json

@@ -1,41 +1,46 @@
 {
-    "name": "nystudio107/craft-recipe",
-    "description": "A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support",
-    "type": "craft-plugin",
-    "version": "1.4.0",
-    "keywords": [
-        "craft",
-        "cms",
-        "craftcms",
-        "craft-plugin",
-        "recipe"
-    ],
-    "support": {
-        "docs": "https://nystudio107.com/plugins/recipe/documentation",
-        "issues": "https://nystudio107.com/plugins/recipe/support"
-    },
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "nystudio107",
-            "homepage": "https://nystudio107.com"
-        }
-    ],
-    "require": {
-        "craftcms/cms": "^3.0.0"
-    },
-    "autoload": {
-        "psr-4": {
-          "nystudio107\\recipe\\": "src/"
-        }
+  "name": "nystudio107/craft-recipe",
+  "description": "A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support",
+  "type": "craft-plugin",
+  "version": "1.4.1",
+  "keywords": [
+    "craft",
+    "cms",
+    "craftcms",
+    "craft-plugin",
+    "recipe"
+  ],
+  "support": {
+    "docs": "https://nystudio107.com/docs/recipe/",
+    "issues": "https://nystudio107.com/plugins/recipe/support",
+    "source": "https://github.com/nystudio107/craft-recipe"
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "nystudio107",
+      "homepage": "https://nystudio107.com"
+    }
+  ],
+  "require": {
+    "craftcms/cms": "^3.0.0"
+  },
+  "config": {
+    "allow-plugins": {
+      "craftcms/plugin-installer": true,
+      "yiisoft/yii2-composer": true
     },
-    "extra": {
-        "name": "Recipe",
-        "handle": "recipe",
-        "schemaVersion": "1.0.0",
-        "hasCpSettings": true,
-        "hasCpSection": false,
-        "changelogUrl": "https://raw.githubusercontent.com/nystudio107/craft-recipe/v1/CHANGELOG.md",
-        "class": "nystudio107\\recipe\\Recipe"
+    "optimize-autoloader": true,
+    "sort-packages": true
+  },
+  "autoload": {
+    "psr-4": {
+      "nystudio107\\recipe\\": "src/"
     }
+  },
+  "extra": {
+    "class": "nystudio107\\recipe\\Recipe",
+    "handle": "recipe",
+    "name": "Recipe"
+  }
 }

docs/.gitignore

@@ -1,2 +1,3 @@
 /vendor
 /node_modules
+docs/.vitepress/dist

docs/Makefile

@@ -11,32 +11,40 @@ DOCSDEST?=../../../sites/nystudio107/web/docs/recipe
 
 .PHONY: docker build dev fix install lint clean npm
 
+# Start the Docker container
 docker:
 	docker build \
 		. \
 		-t ${CONTAINER}:${TAG} \
 		--build-arg TAG=${TAG} \
 		--no-cache
-build: clean docker install
+# Build the production docs
+build: docker install
 	${DOCKERRUN} \
 		run docs:build
 	rm -rf ${DOCSDEST}
 	mv ./docs/.vitepress/dist ${DOCSDEST}
+# Start up the dev server
 dev: docker install
 	${DOCKERRUN} \
 		run docs:dev
+# Fix the docs via textlint
 fix: docker install
 	${DOCKERRUN} \
 		run docs:fix
+# Run an npm install
 install: docker
 	${DOCKERRUN} \
 		install
+# Lint the docs via textlint
 lint: docker install
 	${DOCKERRUN} \
 		run docs:lint
+# Remove node_modules/* & package-lock.json
 clean:
 	rm -rf node_modules/
 	rm -f package-lock.json
+# Run the passed in npm command
 npm: docker
 	${DOCKERRUN} \
 		$(filter-out $@,$(MAKECMDGOALS))

docs/docs/.vitepress/config.ts

@@ -0,0 +1,38 @@
+import {defineConfig} from 'vitepress'
+
+export default defineConfig({
+  title: 'Recipe Plugin',
+  description: 'Documentation for the Recipe plugin',
+  base: '/docs/recipe/',
+  lang: 'en-US',
+  head: [
+    ['meta', {content: 'https://github.com/nystudio107', property: 'og:see_also',}],
+    ['meta', {content: 'https://twitter.com/nystudio107', property: 'og:see_also',}],
+    ['meta', {content: 'https://youtube.com/nystudio107', property: 'og:see_also',}],
+    ['meta', {content: 'https://www.facebook.com/newyorkstudio107', property: 'og:see_also',}],
+  ],
+  themeConfig: {
+    socialLinks: [
+      {icon: 'github', link: 'https://github.com/nystudio107'},
+      {icon: 'twitter', link: 'https://twitter.com/nystudio107'},
+    ],
+    logo: '/img/plugin-logo.svg',
+    editLink: {
+      pattern: 'https://github.com/nystudio107/craft-recipe/edit/develop/docs/docs/:path',
+      text: 'Edit this page on GitHub'
+    },
+    algolia: {
+      appId: 'ANVOBU7GYX',
+      apiKey: 'd9aa4fc31d67fba1d38915de67311070',
+      indexName: 'recipe'
+    },
+    lastUpdatedText: 'Last Updated',
+    sidebar: [],
+    nav: [
+      {text: 'Home', link: 'https://nystudio107.com/plugins/recipe'},
+      {text: 'Store', link: 'https://plugins.craftcms.com/recipe'},
+      {text: 'Changelog', link: 'https://nystudio107.com/plugins/recipe/changelog'},
+      {text: 'Issues', link: 'https://github.com/nystudio107/craft-recipe/issues'},
+    ]
+  },
+});

docs/docs/.vitepress/theme/SidebarBottom.vue → docs/docs/.vitepress/theme/NYSLogo.vue

@@ -6,18 +6,15 @@
       target="_blank"
       rel="noopener"
     >
-    <img
-        src="/resources/img/nys-logo.svg"
+      <img
+        src="/img/nys-logo.svg"
         aria-label="nystudio107 logo"
-        />
+      />
     </a>
   </div>
 </template>
 
-<script>
-export default {
-  name: "SidebarBottom"
-}
+<script setup>
 </script>
 
 <style scoped>

docs/docs/.vitepress/theme/custom.css

@@ -10,3 +10,7 @@
 .DocSearch {
     --docsearch-primary-color: var(--c-brand) !important;
 }
+
+a > img {
+    display: inline-block;
+}

docs/docs/.vitepress/theme/index.ts

@@ -0,0 +1,42 @@
+import Theme from 'vitepress/theme'
+import {h, watch} from 'vue'
+import './custom.css'
+
+import NYSLogo from './NYSLogo.vue';
+
+// Could also come from .env
+const GA_ID = 'UA-69117511-1';
+
+export default {
+  ...Theme,
+  Layout() {
+    return h(Theme.Layout, null, {
+        'aside-bottom': () => h(NYSLogo)
+      }
+    )
+  },
+  enhanceApp: (ctx) => {
+    // Google analytics integration
+    if (import.meta.env.PROD && GA_ID && typeof window !== 'undefined') {
+      (function (i, s, o, g, r, a, m) {
+        i['GoogleAnalyticsObject'] = r
+        i[r] = i[r] || function () {
+          (i[r].q = i[r].q || []).push(arguments)
+        }
+        i[r].l = 1 * new Date()
+        a = s.createElement(o)
+        m = s.getElementsByTagName(o)[0]
+        a.async = 1
+        a.src = g
+        m.parentNode.insertBefore(a, m)
+      })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga')
+      ga('create', GA_ID, 'auto')
+      ga('set', 'anonymizeIp', true)
+      // Send a page view any time the route changes
+      watch(ctx.router.route, (newValue, oldValue) => {
+        ga('set', 'page', newValue.path)
+        ga('send', 'pageview')
+      })
+    }
+  }
+}

docs/docs/@types/shims.d.ts

@@ -0,0 +1,7 @@
+declare module "*.vue" {
+  import Vue from 'vue';
+  export default Vue;
+}
+
+declare module 'rollup-plugin-sitemap';
+declare module 'NYSLogo';

docs/docs/vite.config.js → docs/docs/vite.config.ts

@@ -1,9 +1,9 @@
-import { defineConfig } from 'vite'
+import {defineConfig} from 'vite'
 import SitemapPlugin from 'rollup-plugin-sitemap'
-import VitePressConfig from './.vitepress/config.js'
+import VitePressConfig from './.vitepress/config'
 
 const docsSiteBaseUrl = 'https://nystudio107.com'
-const docsBaseUrl = new URL(VitePressConfig.base, docsSiteBaseUrl).href.replace(/\/$/, '') + '/'
+const docsBaseUrl = new URL(VitePressConfig.base!, docsSiteBaseUrl).href.replace(/\/$/, '') + '/'
 const siteMapRoutes = [{
   path: '',
   name: VitePressConfig.title