@telegraph/postcss-config 0.0.29 → 0.0.31

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @telegraph/postcss-config
 
+## 0.0.31
+
+### Patch Changes
+
+- Updated dependencies [[`d6c6aa9`](https://github.com/knocklabs/telegraph/commit/d6c6aa9cb0e11ba96df7d7efd479c8e4652fc029)]:
+  - @telegraph/tokens@0.1.3
+
+## 0.0.30
+
+### Patch Changes
+
+- Updated dependencies [[`0474256`](https://github.com/knocklabs/telegraph/commit/047425631c37101998e39896a34812da5bd4dcbb)]:
+  - @telegraph/tokens@0.1.2
+
 ## 0.0.29
 
 ### Patch Changes

package/README.md

@@ -1,14 +1,299 @@
+# ⚙️ PostCSS Config
+
+> Shared PostCSS configuration for Telegraph projects with optimized plugins and design token integration.
+
 ![Telegraph by Knock](https://github.com/knocklabs/telegraph/assets/29106675/9b5022e3-b02c-4582-ba57-3d6171e45e44)
 
 [![npm version](https://img.shields.io/npm/v/@telegraph/postcss-config.svg)](https://www.npmjs.com/package/@telegraph/postcss-config)
+[![minzipped size](https://img.shields.io/bundlephobia/minzip/@telegraph/postcss-config)](https://bundlephobia.com/result?p=@telegraph/postcss-config)
+[![license](https://img.shields.io/npm/l/@telegraph/postcss-config)](https://github.com/knocklabs/telegraph/blob/main/LICENSE)
+
+## Installation
+
+```bash
+npm install @telegraph/postcss-config
+```
 
-# @telegraph/postcss-config
-> Shared `PostCSS` config for internal use in the telegraph project.
+> **Note**: This package has no stylesheets required.
 
+## Quick Start
 
-### Installation Instructions
+```js
+// postcss.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
 
+module.exports = styleEnginePostCssConfig;
 ```
-npm install @telegraph/postcss-config
+
+```js
+// Or with ES modules (postcss.config.mjs)
+import { styleEnginePostCssConfig } from "@telegraph/postcss-config";
+
+export default styleEnginePostCssConfig;
+```
+
+## What's Included
+
+This configuration includes optimized PostCSS plugins specifically chosen for Telegraph projects:
+
+- **`postcss-discard-empty`** - Removes empty CSS rules for cleaner output
+- **`autoprefixer`** - Automatically adds vendor prefixes for browser compatibility
+- **`@csstools/postcss-global-data`** - Provides Telegraph design tokens (breakpoints)
+- **`postcss-custom-media`** - Enables custom media queries using Telegraph breakpoints
+
+## API Reference
+
+### `styleEnginePostCssConfig`
+
+The main PostCSS configuration object that includes all Telegraph-specific plugins and settings.
+
+**Type**: `PostCSSConfig`
+
+**Returns**: PostCSS configuration object with plugins array
+
+## Usage Patterns
+
+### Basic PostCSS Config
+
+```js
+// postcss.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+module.exports = styleEnginePostCssConfig;
+```
+
+### With Webpack
+
+```js
+// webpack.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        use: [
+          "style-loader",
+          "css-loader",
+          {
+            loader: "postcss-loader",
+            options: {
+              postcssOptions: styleEnginePostCssConfig,
+            },
+          },
+        ],
+      },
+    ],
+  },
+};
+```
+
+### With Vite
+
+```js
+// vite.config.js
+import { styleEnginePostCssConfig } from "@telegraph/postcss-config";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  css: {
+    postcss: styleEnginePostCssConfig,
+  },
+});
+```
+
+### With Next.js
+
+```js
+// next.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+module.exports = {
+  experimental: {
+    postcss: styleEnginePostCssConfig,
+  },
+};
+```
+
+## Advanced Usage
+
+### Extending the Configuration
+
+```js
+// postcss.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+module.exports = {
+  ...styleEnginePostCssConfig,
+  plugins: [
+    ...styleEnginePostCssConfig.plugins,
+    // Add your custom plugins
+    require("postcss-nested"),
+    require("cssnano")({
+      preset: "default",
+    }),
+  ],
+};
+```
+
+### Custom Media Queries Usage
+
+With this configuration, you can use Telegraph breakpoints in your CSS:
+
+```css
+/* Input CSS */
+@custom-media --mobile-and-up (min-width: 480px);
+@custom-media --tablet-and-up (min-width: 768px);
+@custom-media --desktop-and-up (min-width: 1024px);
+
+.component {
+  padding: 1rem;
+}
+
+@media (--tablet-and-up) {
+  .component {
+    padding: 2rem;
+  }
+}
+
+@media (--desktop-and-up) {
+  .component {
+    padding: 3rem;
+  }
+}
+```
+
+## Browser Support
+
+The autoprefixer plugin ensures compatibility with:
+
+- **Chrome**: Last 2 versions
+- **Firefox**: Last 2 versions
+- **Safari**: Last 2 versions
+- **Edge**: Last 2 versions
+- **iOS Safari**: Last 2 versions
+
+## Performance Optimization
+
+This configuration is optimized for performance:
+
+- **Tree Shaking**: Only includes necessary PostCSS plugins
+- **Build Speed**: Minimal plugin overhead
+- **Output Size**: Removes empty rules and optimizes CSS
+- **Caching**: PostCSS plugins support caching for faster rebuilds
+
+## Troubleshooting
+
+### Common Issues
+
+**Plugin not found errors**
+
+```bash
+# Ensure all peer dependencies are installed
+npm install postcss autoprefixer
+```
+
+**Custom media not working**
+
+```js
+// Make sure @telegraph/tokens is installed
+npm install @telegraph/tokens
+```
+
+**Autoprefixer not adding prefixes**
+
+```js
+// Check your browserslist configuration
+// .browserslistrc or package.json "browserslist" field
+```
+
+### Debug Configuration
+
+```js
+// postcss.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+console.log(
+  "PostCSS plugins:",
+  styleEnginePostCssConfig.plugins.map((p) => p.pluginName),
+);
+
+module.exports = styleEnginePostCssConfig;
 ```
 
+## Examples
+
+### Basic Setup
+
+```js
+// postcss.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+module.exports = styleEnginePostCssConfig;
+```
+
+### Advanced Build Pipeline
+
+```js
+// build.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+const postcss = require("postcss");
+const fs = require("fs");
+
+async function buildCSS() {
+  const css = fs.readFileSync("src/styles.css", "utf8");
+
+  const result = await postcss(styleEnginePostCssConfig.plugins).process(css, {
+    from: "src/styles.css",
+    to: "dist/styles.css",
+  });
+
+  fs.writeFileSync("dist/styles.css", result.css);
+
+  if (result.map) {
+    fs.writeFileSync("dist/styles.css.map", result.map.toString());
+  }
+}
+
+buildCSS().catch(console.error);
+```
+
+### Monorepo Configuration
+
+```js
+// packages/shared/postcss.config.js
+const { styleEnginePostCssConfig } = require("@telegraph/postcss-config");
+
+// Shared configuration for all packages
+module.exports = {
+  ...styleEnginePostCssConfig,
+  plugins: [
+    ...styleEnginePostCssConfig.plugins,
+    // Add monorepo-specific plugins
+    require("postcss-import")({
+      resolve: (id) => {
+        // Custom resolution for monorepo packages
+        if (id.startsWith("@company/")) {
+          return path.resolve(__dirname, `../${id.split("/")[1]}/src/styles`);
+        }
+        return id;
+      },
+    }),
+  ],
+};
+```
+
+## References
+
+- [PostCSS Documentation](https://postcss.org/)
+- [Autoprefixer Documentation](https://github.com/postcss/autoprefixer)
+- [Telegraph Tokens](../tokens/README.md)
+
+## Contributing
+
+See our [Contributing Guide](../../CONTRIBUTING.md) for more details.
+
+## License
+
+MIT License - see [LICENSE](../../LICENSE) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telegraph/postcss-config",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "author": "@knocklabs",
   "license": "MIT",
   "repository": "https://github.com/knocklabs/telegraph/tree/main/packages/postcss-config",
@@ -18,19 +18,19 @@
     "format:check": "prettier \"src/**/*.{js,ts,tsx}\" --check"
   },
   "dependencies": {
-    "@csstools/postcss-global-data": "^3.0.0",
-    "@telegraph/tokens": "^0.1.1",
+    "@csstools/postcss-global-data": "^3.1.0",
+    "@telegraph/tokens": "^0.1.3",
     "autoprefixer": "^10.4.21",
-    "postcss": "^8.5.3",
+    "postcss": "^8.5.6",
     "postcss-combine-duplicated-selectors": "^10.0.3",
     "postcss-custom-media": "^11.0.6",
     "postcss-discard-empty": "^7.0.1"
   },
   "devDependencies": {
-    "@knocklabs/eslint-config": "^0.0.4",
+    "@knocklabs/eslint-config": "^0.0.5",
     "@knocklabs/typescript-config": "^0.0.2",
     "@telegraph/prettier-config": "^0.0.7",
     "eslint": "^8.56.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.9.3"
   }
 }