postcss-debug-logger (#950)

Author: romainmenke

.github/labeler.yml

@@ -11,6 +11,7 @@
   - packages/postcss-tape/**
   - packages/selector-specificity/**
   - plugins/postcss-base-plugin/**
+  - plugins/postcss-debug-logger/**
   - rollup/**
 
 "plugin-packs/postcss-preset-env":

package-lock.json

@@ -18,6 +18,7 @@
 		"packages/media-query-list-parser",
 		"packages/*",
 		"plugins/postcss-progressive-custom-properties",
+		"plugins/postcss-debug-logger",
 		"plugins/*",
 		"plugin-packs/*",
 		"cli/*",

package.json

@@ -0,0 +1,6 @@
+node_modules
+package-lock.json
+yarn.lock
+*.result.css
+*.result.css.map
+*.result.html

plugins/postcss-debug-logger/.gitignore

@@ -0,0 +1 @@
+v18.8.0

plugins/postcss-debug-logger/.nvmrc

@@ -0,0 +1,13 @@
+import { postcssTape } from '@csstools/postcss-tape';
+import plugin from '@csstools/postcss-debug-logger';
+
+postcssTape(plugin)({
+	basic: {
+		message: "supports basic usage",
+		options: {}
+	},
+	document: {
+		postcssSyntaxHTML: true,
+		message: "supports document usage",
+	},
+});

plugins/postcss-debug-logger/.tape.mjs

@@ -0,0 +1,5 @@
+# Changes to PostCSS Debug Logger
+
+### Unreleased (major)
+
+- Initial version

plugins/postcss-debug-logger/CHANGELOG.md

@@ -0,0 +1,235 @@
+# Installing PostCSS Debug Logger
+
+[PostCSS Debug Logger] runs in all Node environments, with special instructions for:
+
+- [Node](#node)
+- [PostCSS CLI](#postcss-cli)
+- [PostCSS Load Config](#postcss-load-config)
+- [Webpack](#webpack)
+- [Next.js](#nextjs)
+- [Gulp](#gulp)
+- [Grunt](#grunt)
+
+
+
+## Node
+
+Add [PostCSS Debug Logger] to your project:
+
+```bash
+npm install postcss @csstools/postcss-debug-logger --save-dev
+```
+
+Use it as a [PostCSS] plugin:
+
+```js
+// commonjs
+const postcss = require('postcss');
+const postcssDebugLogger = require('@csstools/postcss-debug-logger');
+
+postcss([
+	postcssDebugLogger(/* pluginOptions */)
+]).process(YOUR_CSS /*, processOptions */);
+```
+
+```js
+// esm
+import postcss from 'postcss';
+import postcssDebugLogger from '@csstools/postcss-debug-logger';
+
+postcss([
+	postcssDebugLogger(/* pluginOptions */)
+]).process(YOUR_CSS /*, processOptions */);
+```
+
+## PostCSS CLI
+
+Add [PostCSS CLI] to your project:
+
+```bash
+npm install postcss-cli @csstools/postcss-debug-logger --save-dev
+```
+
+Use [PostCSS Debug Logger] in your `postcss.config.js` configuration file:
+
+```js
+const postcssDebugLogger = require('@csstools/postcss-debug-logger');
+
+module.exports = {
+	plugins: [
+		postcssDebugLogger(/* pluginOptions */)
+	]
+}
+```
+
+## PostCSS Load Config
+
+If your framework/CLI supports [`postcss-load-config`](https://github.com/postcss/postcss-load-config).
+
+```bash
+npm install @csstools/postcss-debug-logger --save-dev
+```
+
+`package.json`:
+
+```json
+{
+	"postcss": {
+		"plugins": {
+			"@csstools/postcss-debug-logger": {}
+		}
+	}
+}
+```
+
+`.postcssrc.json`:
+
+```json
+{
+	"plugins": {
+		"@csstools/postcss-debug-logger": {}
+	}
+}
+```
+
+_See the [README of `postcss-load-config`](https://github.com/postcss/postcss-load-config#usage) for more usage options._
+
+## Webpack
+
+_Webpack version 5_
+
+Add [PostCSS Loader] to your project:
+
+```bash
+npm install postcss-loader @csstools/postcss-debug-logger --save-dev
+```
+
+Use [PostCSS Debug Logger] in your Webpack configuration:
+
+```js
+module.exports = {
+	module: {
+		rules: [
+			{
+				test: /\.css$/i,
+				use: [
+					"style-loader",
+					{
+						loader: "css-loader",
+						options: { importLoaders: 1 },
+					},
+					{
+						loader: "postcss-loader",
+						options: {
+							postcssOptions: {
+								plugins: [
+									// Other plugins,
+									[
+										"@csstools/postcss-debug-logger",
+										{
+											// Options
+										},
+									],
+								],
+							},
+						},
+					},
+				],
+			},
+		],
+	},
+};
+```
+
+## Next.js
+
+Read the instructions on how to [customize the PostCSS configuration in Next.js](https://nextjs.org/docs/advanced-features/customizing-postcss-config)
+
+```bash
+npm install @csstools/postcss-debug-logger --save-dev
+```
+
+Use [PostCSS Debug Logger] in your `postcss.config.json` file:
+
+```json
+{
+	"plugins": [
+		"@csstools/postcss-debug-logger"
+	]
+}
+```
+
+```json5
+{
+	"plugins": [
+		[
+			"@csstools/postcss-debug-logger",
+			{
+				// Optionally add plugin options
+			}
+		]
+	]
+}
+```
+
+## Gulp
+
+Add [Gulp PostCSS] to your project:
+
+```bash
+npm install gulp-postcss @csstools/postcss-debug-logger --save-dev
+```
+
+Use [PostCSS Debug Logger] in your Gulpfile:
+
+```js
+const postcss = require('gulp-postcss');
+const postcssDebugLogger = require('@csstools/postcss-debug-logger');
+
+gulp.task('css', function () {
+	var plugins = [
+		postcssDebugLogger(/* pluginOptions */)
+	];
+
+	return gulp.src('./src/*.css')
+		.pipe(postcss(plugins))
+		.pipe(gulp.dest('.'));
+});
+```
+
+## Grunt
+
+Add [Grunt PostCSS] to your project:
+
+```bash
+npm install grunt-postcss @csstools/postcss-debug-logger --save-dev
+```
+
+Use [PostCSS Debug Logger] in your Gruntfile:
+
+```js
+const postcssDebugLogger = require('@csstools/postcss-debug-logger');
+
+grunt.loadNpmTasks('grunt-postcss');
+
+grunt.initConfig({
+	postcss: {
+		options: {
+			processors: [
+			postcssDebugLogger(/* pluginOptions */)
+			]
+		},
+		dist: {
+			src: '*.css'
+		}
+	}
+});
+```
+
+[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
+[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
+[PostCSS]: https://github.com/postcss/postcss
+[PostCSS CLI]: https://github.com/postcss/postcss-cli
+[PostCSS Loader]: https://github.com/postcss/postcss-loader
+[PostCSS Debug Logger]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-debug-logger
+[Next.js]: https://nextjs.org