@tuqulore-inc/eleventy-plugin-postcss 0.0.1 → 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) tuqulore inc.
+
+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

@@ -1,45 +1,62 @@
 # @tuqulore-inc/eleventy-plugin-postcss
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+Eleventy plugin for processing CSS with PostCSS.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+## Installation
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+```bash
+npm install -D @11ty/eleventy postcss @tuqulore-inc/eleventy-plugin-postcss
+```
 
-## Purpose
+## Usage
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@tuqulore-inc/eleventy-plugin-postcss`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+```javascript
+// eleventy.config.mjs
+import postcss from "@tuqulore-inc/eleventy-plugin-postcss";
 
-## What is OIDC Trusted Publishing?
+export default function (eleventyConfig) {
+  eleventyConfig.addPlugin(postcss, {
+    contentGlob: ["src/**/*.{md,mdx,jsx}"],
+  });
+}
+```
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+This plugin requires a PostCSS configuration file (`postcss.config.mjs` or `postcss.config.js`) in your project root:
 
-## Setup Instructions
+```javascript
+// postcss.config.mjs
+export default {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+};
+```
 
-To properly configure OIDC trusted publishing for this package:
+## Options
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+### `contentGlob`
 
-## DO NOT USE THIS PACKAGE
+- Type: `string | string[]`
+- Default: `[]`
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+Glob patterns for files to track as dependencies. When any of these files change, the CSS will be rebuilt. This is useful for TailwindCSS which scans content files for class names.
 
-## More Information
+When using `contentGlob`, you should also configure `setServerOptions` to watch the generated CSS files for dev server reload:
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+```javascript
+eleventyConfig.addPlugin(postcss, {
+  contentGlob: ["src/**/*.{md,mdx,jsx}"],
+});
+eleventyConfig.setServerOptions({
+  watch: ["dist/**/*.css"],
+});
+```
 
----
+## Requirements
 
-**Maintained for OIDC setup purposes only**
+- Eleventy 3.0 or higher
+- PostCSS 8.0 or higher
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,20 @@
+import type { UserConfig } from "@11ty/eleventy";
+
+export interface PluginOptions {
+  /**
+   * Glob patterns for files to track as dependencies.
+   * When any of these files change, the CSS will be rebuilt.
+   * Useful for TailwindCSS which scans content files for class names.
+   */
+  contentGlob?: string | string[];
+}
+
+/**
+ * Eleventy plugin for processing CSS with PostCSS
+ */
+declare function postcssPlugin(
+  eleventyConfig: UserConfig,
+  pluginOptions?: PluginOptions,
+): void;
+
+export default postcssPlugin;

package/index.mjs

@@ -0,0 +1,44 @@
+import fg from "fast-glob";
+import postcss from "postcss";
+import postcssrc from "postcss-load-config";
+
+/**
+ * Eleventy plugin for processing CSS with PostCSS
+ * @param {import("@11ty/eleventy").UserConfig} eleventyConfig - Eleventy configuration object
+ * @param {Object} pluginOptions - Plugin options
+ * @param {string|string[]} [pluginOptions.contentGlob] - Glob patterns for dependency tracking
+ */
+export default function (eleventyConfig, pluginOptions = {}) {
+  try {
+    eleventyConfig.versionCheck(">=3.0");
+  } catch (e) {
+    console.log(`[eleventy-plugin-postcss] WARN: ${e.message}`);
+  }
+
+  const { contentGlob = [] } = pluginOptions;
+  const contentPatterns = Array.isArray(contentGlob)
+    ? contentGlob
+    : [contentGlob];
+
+  eleventyConfig.addTemplateFormats("css");
+  eleventyConfig.addExtension("css", {
+    outputFileExtension: "css",
+    compile: async function (content, inputPath) {
+      if (contentPatterns.length > 0) {
+        const deps = await fg(contentPatterns);
+        this.addDependencies(inputPath, deps);
+      }
+      const { plugins, options } = await postcssrc({ from: inputPath });
+      const result = await postcss(plugins).process(content, {
+        ...options,
+        from: inputPath,
+      });
+      result.warnings?.().forEach((warning) => {
+        console.warn(
+          `[eleventy-plugin-postcss] ${warning.node?.source?.input?.file ?? inputPath}: ${warning.text}`,
+        );
+      });
+      return () => result.css;
+    },
+  });
+}

package/package.json

@@ -1,10 +1,49 @@
 {
   "name": "@tuqulore-inc/eleventy-plugin-postcss",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @tuqulore-inc/eleventy-plugin-postcss",
+  "version": "4.0.0",
+  "description": "Eleventy plugin for processing CSS with PostCSS",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "eleventy",
+    "eleventy-plugin",
+    "postcss",
+    "css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tuqulore/website-boilerplate.git",
+    "directory": "packages/eleventy-plugin-postcss"
+  },
+  "license": "MIT",
+  "author": "tuqulore inc.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.mjs"
+    }
+  },
+  "main": "./index.mjs",
+  "files": [
+    "README.md",
+    "index.d.ts",
+    "index.mjs"
+  ],
+  "dependencies": {
+    "fast-glob": "^3.3.3",
+    "postcss-load-config": "^6.0.1"
+  },
+  "devDependencies": {
+    "eslint": "^9.39.2",
+    "@tuqulore-inc/eslint-config": "4.0.0"
+  },
+  "peerDependencies": {
+    "@11ty/eleventy": ">=3.0.0",
+    "postcss": ">=8.0.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "lint": "eslint --fix ."
+  }
+}