Merge branch 'release/1.1.5' into v1

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Similar Changelog
 
+## 1.1.5 - 2021.06.03
+### Changed
+* If `orderBy` criteria is omitted, entries are now sorted by the number of relations in common. (https://github.com/nystudio107/craft-similar/issues/35)
+* Switch to VitePress for documentation
+* Updated `Makefile` to use `node-14-alpine`
+
 ## 1.1.4 - 2021.03.27
 ### Changed
 * Move settings from the `composer.json` “extra” to the plugin main class

composer.json

@@ -2,7 +2,7 @@
     "name": "nystudio107/craft-similar",
     "description": "Similar for Craft lets you find elements, Entries, Categories, Commerce Products, etc, that are similar, based on... other related elements.",
     "type": "craft-plugin",
-    "version": "1.1.4",
+    "version": "1.1.5",
     "keywords": [
         "craft",
         "cms",

docs/.textlint.terms.json

@@ -0,0 +1,8 @@
+[
+  "Stylus",
+  "VuePress",
+  [
+    "front[- ]matter",
+    "frontmatter"
+  ]
+]

docs/.textlintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+    rules: {
+        '@textlint-rule/no-unmatched-pair': true,
+        apostrophe: true,
+        'common-misspellings': true,
+        diacritics: true,
+        'en-capitalization': {
+            allowHeading: false
+        },
+        'stop-words': {
+            severity: 'warning'
+        },
+        terminology: {
+            terms: `${__dirname}/.textlint.terms.json`
+        },
+        'write-good': {
+            severity: 'warning'
+        }
+    },
+    filters: {
+        comments: true
+    }
+}

Dockerfile → docs/Dockerfile

@@ -1,7 +1,7 @@
-ARG TAG=12-alpine
+ARG TAG=14-alpine
 FROM nystudio107/node-dev-base:$TAG
 
-WORKDIR /app/buildchain/
+WORKDIR /app/
 
 CMD ["run build"]
 

docs/Makefile

@@ -0,0 +1,45 @@
+TAG?=14-alpine
+CONTAINER?=$(shell basename $(dir $(CURDIR)))-docs
+DOCKERRUN=docker container run \
+	--name ${CONTAINER} \
+	--rm \
+	-p 3002:3002 \
+	-t \
+	-v `pwd`:/app \
+	${CONTAINER}:${TAG}
+DOCSDEST?=../../../sites/nystudio107/web/docs/similar
+
+.PHONY: docker build dev fix install lint update npm
+
+docker:
+	docker build \
+		. \
+		-t ${CONTAINER}:${TAG} \
+		--build-arg TAG=${TAG} \
+		--no-cache
+build: docker install update
+	${DOCKERRUN} \
+		run docs:build
+	rm -rf ${DOCSDEST}
+	mv ./docs/.vitepress/dist ${DOCSDEST}
+dev: docker install
+	${DOCKERRUN} \
+		run docs:dev
+fix: docker install
+	${DOCKERRUN} \
+		run docs:fix
+install: docker
+	${DOCKERRUN} \
+		install
+lint: docker install
+	${DOCKERRUN} \
+		run docs:lint
+update: docker
+	${DOCKERRUN} \
+		update
+npm: docker
+	${DOCKERRUN} \
+		$(filter-out $@,$(MAKECMDGOALS))
+%:
+	@:
+# ref: https://stackoverflow.com/questions/6273608/how-to-pass-argument-to-makefile-from-command-line

docs/docs/.vitepress/config.js

@@ -0,0 +1,18 @@
+module.exports = {
+    title: 'Similar Documentation',
+    description: 'Documentation for the Similar plugin',
+    base: '/docs/similar/',
+    lang: 'en-US',
+    themeConfig: {
+        repo: 'nystudio107/craft-similar',
+        docsDir: 'docs/docs',
+        docsBranch: 'v1',
+        algolia: {
+            apiKey: '',
+            indexName: 'similar'
+        },
+        editLinks: true,
+        editLinkText: 'Edit this page on GitHub',
+        lastUpdated: 'Last Updated',
+    },
+};

docs/docs/README.md → docs/docs/index.md

@@ -2,7 +2,7 @@
 
 # Similar plugin for Craft CMS 3.x
 
-Similar for Craft lets you find elements, Entries, Categories, Commerce Products, etc, that are similar, based on... other related elements.
+Similar for Craft lets you find elements, Entries, Categories, Commerce Products, etc, that are similar, based on... Other related elements.
 
 ![Screenshot](./resources/img/plugin-logo.png)
 
@@ -47,7 +47,7 @@ The plugin has one template method, `find`, which takes a parameters object with
     </ul>
 ```
 
-There is also a third, optional parameter that you probably would want to use most of the time, `criteria`. `criteria` lets you create the base ElementQuery that Similar will extend, giving you the ability to use all of Craft's usual goodies for your queries. If you'd want to limit the number of entries returned (good idea!), you could do it like this:
+There is also a third, optional parameter that you probably would want to use most of the time, `criteria`. `criteria` lets you create the base ElementQuery that Similar will extend, giving you the ability to use all of Craft’s usual goodies for your queries. If you’d want to limit the number of entries returned (good idea!), you could do it like this:
 
 ```twig
     {% set limitCriteria = craft.entries.limit(4) %}
@@ -62,7 +62,7 @@ There is also a third, optional parameter that you probably would want to use mo
 
 The supported element types are `Entry`, `Asset`, `Category`, `Tag`, `User` and `Commerce_Product`. If you miss one, send me a feature request.
 
-The `context` parameter takes either an `ElementQuery`, or a list of ids. If you want to find similar entries based on an entry's tags and categories, you could do:
+The `context` parameter takes either an `ElementQuery`, or a list of IDs. To find similar entries based on an entry’s tags and categories, you could do:
 
  ```twig
     {% set ids = entry.tags.ids() | merge(entry.categories.ids()) %}

docs/docs/vite.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vite'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  server: {
+    host: '0.0.0.0',
+    port: 3002,
+    strictPort: true,
+  }
+});