@quartz-community/remove-draft 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial Quartz community plugin template.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Quartz Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @quartz-community/remove-draft
+
+Filters out pages with draft: true in their frontmatter.
+
+## Installation
+
+```bash
+npx quartz plugin add github:quartz-community/remove-draft
+```
+
+## Usage
+
+```yaml title="quartz.config.yaml"
+plugins:
+  - source: github:quartz-community/remove-draft
+    enabled: true
+```
+
+## Configuration
+
+This plugin has no configuration options.
+
+## Documentation
+
+See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/RemoveDrafts) for more information.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { QuartzFilterPlugin } from '@quartz-community/types';
+export { QuartzFilterPlugin } from '@quartz-community/types';
+
+declare const RemoveDrafts: QuartzFilterPlugin<object>;
+
+export { RemoveDrafts };

package/dist/index.js

@@ -0,0 +1,13 @@
+// src/filter.ts
+var RemoveDrafts = () => ({
+  name: "RemoveDrafts",
+  shouldPublish(_ctx, [_tree, vfile]) {
+    const frontmatter = vfile.data?.frontmatter;
+    const draftFlag = frontmatter?.draft === true || frontmatter?.draft === "true";
+    return !draftFlag;
+  }
+});
+
+export { RemoveDrafts };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/filter.ts"],"names":[],"mappings":";AAEO,IAAM,eAA2C,OAAO;AAAA,EAC7D,IAAA,EAAM,cAAA;AAAA,EACN,aAAA,CAAc,IAAA,EAAM,CAAC,KAAA,EAAO,KAAK,CAAA,EAAG;AAClC,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,EAAM,WAAA;AAChC,IAAA,MAAM,SAAA,GAAqB,WAAA,EAAa,KAAA,KAAU,IAAA,IAAQ,aAAa,KAAA,KAAU,MAAA;AACjF,IAAA,OAAO,CAAC,SAAA;AAAA,EACV;AACF,CAAA","file":"index.js","sourcesContent":["import type { QuartzFilterPlugin } from \"@quartz-community/types\";\n\nexport const RemoveDrafts: QuartzFilterPlugin<object> = () => ({\n  name: \"RemoveDrafts\",\n  shouldPublish(_ctx, [_tree, vfile]) {\n    const frontmatter = vfile.data?.frontmatter as Record<string, unknown> | undefined;\n    const draftFlag: boolean = frontmatter?.draft === true || frontmatter?.draft === \"true\";\n    return !draftFlag;\n  },\n});\n"]}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@quartz-community/remove-draft",
+  "version": "0.1.0",
+  "description": "Filter plugin that removes draft pages from Quartz builds",
+  "type": "module",
+  "license": "MIT",
+  "author": "Quartz Community",
+  "homepage": "https://github.com/quartz-community/remove-draft",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/quartz-community/remove-draft"
+  },
+  "keywords": [
+    "quartz",
+    "quartz-plugin",
+    "filter",
+    "draft"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint . --max-warnings=0",
+    "format": "prettier . --check",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "check": "npm run typecheck && npm run lint && npm run format && npm run test",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@quartz-community/types": "^0.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.6.2",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.9"
+  },
+  "quartz": {
+    "name": "remove-draft",
+    "displayName": "Remove Drafts",
+    "category": "filter",
+    "version": "1.0.0",
+    "quartzVersion": ">=5.0.0",
+    "dependencies": [],
+    "defaultOrder": 50,
+    "defaultEnabled": true,
+    "defaultOptions": {}
+  },
+  "engines": {
+    "node": ">=22",
+    "npm": ">=10.9.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}