@quartz-community/explicit-publish 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.1.0
+
+### Minor Changes
+
+- 0053681: Files without frontmatter — `.base`, `.canvas` and `.excalidraw` pages — are published when a published page links to them, and not otherwise (quartz-community/bases-page#11). Before, every such file was published regardless of this filter. Needs Quartz 5.1, which runs the filters on these pages; with older Quartz nothing changes.
+
+## 1.0.1
+
+### Patch Changes
+
+- 952de74: Releases are published from GitHub Actions with npm trusted publishing, so each version on npm now carries provenance linking it to the commit and workflow that built it. No changes to the package itself.
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -16,6 +16,18 @@ plugins:
     enabled: true
 ```
 
+## Files without frontmatter
+
+`.base`, `.canvas` and `.excalidraw` files have no frontmatter to put `publish: true` in. They are
+published along with the published pages that link to them (`[[Board.canvas]]`, or an embed that
+needs the file's page, such as `![[Board.canvas]]`), and not otherwise — like Obsidian Publish
+adding the files a published note links to. A file that only unpublished notes reference, or that
+nothing references, is not published. A base embedded in a published note (`![[Views.base]]` or a
+` ```base ` block) renders inside that note without getting a page of its own.
+
+A drawing stored as Markdown (`.excalidraw.md`) has frontmatter, and follows its own `publish:`
+like a note. This needs Quartz 5.1 or later, which runs the filters on these pages.
+
 ## Configuration
 
 This plugin has no configuration options.

package/dist/index.d.ts

@@ -1,6 +1,15 @@
 import { QuartzFilterPlugin } from '@quartz-community/types';
 export { QuartzFilterPlugin } from '@quartz-community/types';
 
+/**
+ * Publishes pages whose frontmatter has `publish: true`.
+ *
+ * Files without frontmatter (`.base`, `.canvas`, `.excalidraw` pages, which page types render
+ * from the file itself) have no way to opt in. They are published along with the published pages
+ * that link to them, like Obsidian Publish adds the files a published note links to: Quartz 5.1+
+ * runs the filters on such pages with `file.data.referencedBy` set to those pages. A file only
+ * embedded or linked by unpublished notes, or by nothing, is not published.
+ */
 declare const ExplicitPublish: QuartzFilterPlugin;
 
 export { ExplicitPublish };

package/dist/index.js

@@ -3,7 +3,13 @@ var ExplicitPublish = () => ({
   name: "ExplicitPublish",
   shouldPublish(_ctx, [_tree, vfile]) {
     const frontmatter = vfile.data?.frontmatter;
-    return frontmatter?.publish === true || frontmatter?.publish === "true";
+    if (frontmatter?.publish === true || frontmatter?.publish === "true") return true;
+    const relativePath = vfile.data?.relativePath;
+    if (typeof relativePath === "string" && !relativePath.toLowerCase().endsWith(".md")) {
+      const referencedBy = vfile.data.referencedBy;
+      return Array.isArray(referencedBy) && referencedBy.length > 0;
+    }
+    return false;
   }
 });
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/filter.ts"],"names":[],"mappings":";AAEO,IAAM,kBAAsC,OAAO;AAAA,EACxD,IAAA,EAAM,iBAAA;AAAA,EACN,aAAA,CAAc,IAAA,EAAM,CAAC,KAAA,EAAO,KAAK,CAAA,EAAG;AAClC,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,EAAM,WAAA;AAChC,IAAA,OAAO,WAAA,EAAa,OAAA,KAAY,IAAA,IAAQ,WAAA,EAAa,OAAA,KAAY,MAAA;AAAA,EACnE;AACF,CAAA","file":"index.js","sourcesContent":["import type { QuartzFilterPlugin } from \"@quartz-community/types\";\n\nexport const ExplicitPublish: QuartzFilterPlugin = () => ({\n  name: \"ExplicitPublish\",\n  shouldPublish(_ctx, [_tree, vfile]) {\n    const frontmatter = vfile.data?.frontmatter as Record<string, unknown> | undefined;\n    return frontmatter?.publish === true || frontmatter?.publish === \"true\";\n  },\n});\n"]}
+{"version":3,"sources":["../src/filter.ts"],"names":[],"mappings":";AAWO,IAAM,kBAAsC,OAAO;AAAA,EACxD,IAAA,EAAM,iBAAA;AAAA,EACN,aAAA,CAAc,IAAA,EAAM,CAAC,KAAA,EAAO,KAAK,CAAA,EAAG;AAClC,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,EAAM,WAAA;AAChC,IAAA,IAAI,aAAa,OAAA,KAAY,IAAA,IAAQ,WAAA,EAAa,OAAA,KAAY,QAAQ,OAAO,IAAA;AAE7E,IAAA,MAAM,YAAA,GAAe,MAAM,IAAA,EAAM,YAAA;AACjC,IAAA,IAAI,OAAO,iBAAiB,QAAA,IAAY,CAAC,aAAa,WAAA,EAAY,CAAE,QAAA,CAAS,KAAK,CAAA,EAAG;AACnF,MAAA,MAAM,YAAA,GAAgB,MAAM,IAAA,CAAiC,YAAA;AAC7D,MAAA,OAAO,KAAA,CAAM,OAAA,CAAQ,YAAY,CAAA,IAAK,aAAa,MAAA,GAAS,CAAA;AAAA,IAC9D;AACA,IAAA,OAAO,KAAA;AAAA,EACT;AACF,CAAA","file":"index.js","sourcesContent":["import type { QuartzFilterPlugin } from \"@quartz-community/types\";\n\n/**\n * Publishes pages whose frontmatter has `publish: true`.\n *\n * Files without frontmatter (`.base`, `.canvas`, `.excalidraw` pages, which page types render\n * from the file itself) have no way to opt in. They are published along with the published pages\n * that link to them, like Obsidian Publish adds the files a published note links to: Quartz 5.1+\n * runs the filters on such pages with `file.data.referencedBy` set to those pages. A file only\n * embedded or linked by unpublished notes, or by nothing, is not published.\n */\nexport const ExplicitPublish: QuartzFilterPlugin = () => ({\n  name: \"ExplicitPublish\",\n  shouldPublish(_ctx, [_tree, vfile]) {\n    const frontmatter = vfile.data?.frontmatter as Record<string, unknown> | undefined;\n    if (frontmatter?.publish === true || frontmatter?.publish === \"true\") return true;\n\n    const relativePath = vfile.data?.relativePath;\n    if (typeof relativePath === \"string\" && !relativePath.toLowerCase().endsWith(\".md\")) {\n      const referencedBy = (vfile.data as Record<string, unknown>).referencedBy;\n      return Array.isArray(referencedBy) && referencedBy.length > 0;\n    }\n    return false;\n  },\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quartz-community/explicit-publish",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Filter plugin that only publishes pages with explicit publish flag",
   "type": "module",
   "license": "MIT",
@@ -41,7 +41,8 @@
     "typecheck": "tsc --noEmit",
     "check": "npm run typecheck && npm run lint && npm run format && npm run test",
     "prepublishOnly": "npm run build",
-    "release": "npm run build && changeset publish"
+    "release": "npm run build && changeset publish",
+    "version-packages": "changeset version && npm install --package-lock-only --ignore-scripts --no-audit --no-fund"
   },
   "dependencies": {
     "@quartz-community/types": "^1.0.0"