PostCSS Global Data

.github/ISSUE_TEMPLATE/css-issue.yml

@@ -81,6 +81,7 @@ body:
         - PostCSS Focus Within
         - PostCSS Font Variant
         - PostCSS Gap Properties
+        - PostCSS Global Data
         - PostCSS Gradients Interpolation Method
         - PostCSS HWB Function
         - PostCSS Image Set Function

.github/ISSUE_TEMPLATE/plugin-issue.yml

@@ -83,6 +83,7 @@ body:
         - PostCSS Focus Within
         - PostCSS Font Variant
         - PostCSS Gap Properties
+        - PostCSS Global Data
         - PostCSS Gradients Interpolation Method
         - PostCSS HWB Function
         - PostCSS Image Set Function

.github/bin/generate-docs/readme.mjs

@@ -6,7 +6,13 @@ const template = await fsp.readFile(path.join('docs', './README.md'), 'utf8');
 const corsTemplate = await fsp.readFile(path.join(path.dirname(fileURLToPath(import.meta.url)), './cors-template.md'), 'utf8');
 const packageJSONInfo = JSON.parse(await fsp.readFile('./package.json', 'utf8'));
 
-const exampleFilePaths = await fsp.readdir(path.join('test', 'examples'));
+let exampleFilePaths = [];
+
+try {
+	exampleFilePaths = await fsp.readdir(path.join('test', 'examples'));
+} catch(error) {
+	// No examples
+}
 
 let readmeDoc = template.toString();
 

.github/labeler.yml

@@ -119,6 +119,10 @@
   - plugins/postcss-gap-properties/**
   - experimental/postcss-gap-properties/**
 
+"plugins/postcss-global-data":
+  - plugins/postcss-global-data/**
+  - experimental/postcss-global-data/**
+
 "plugins/postcss-gradients-interpolation-method":
   - plugins/postcss-gradients-interpolation-method/**
   - experimental/postcss-gradients-interpolation-method/**

plugins/postcss-global-data/.gitignore

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

plugins/postcss-global-data/.nvmrc

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

plugins/postcss-global-data/.tape.mjs

@@ -0,0 +1,17 @@
+import { postcssTape } from '../../packages/postcss-tape/dist/index.mjs';
+import plugin from '@csstools/postcss-global-data';
+import postcssCustomMedia from 'postcss-custom-media';
+
+postcssTape(plugin)({
+	basic: {
+		message: "supports basic usage",
+		plugins: [
+			plugin({
+				files: [
+					'./test/fixtures/fixture.css',
+				]
+			}),
+			postcssCustomMedia(),
+		],
+	},
+});

plugins/postcss-global-data/CHANGELOG.md

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

plugins/postcss-global-data/INSTALL.md

@@ -0,0 +1,235 @@
+# Installing PostCSS Global Data
+
+[PostCSS Global Data] 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 Global Data] to your project:
+
+```bash
+npm install postcss @csstools/postcss-global-data --save-dev
+```
+
+Use it as a [PostCSS] plugin:
+
+```js
+// commonjs
+const postcss = require('postcss');
+const postcssGlobalData = require('@csstools/postcss-global-data');
+
+postcss([
+	postcssGlobalData(/* pluginOptions */)
+]).process(YOUR_CSS /*, processOptions */);
+```
+
+```js
+// esm
+import postcss from 'postcss';
+import postcssGlobalData from '@csstools/postcss-global-data';
+
+postcss([
+	postcssGlobalData(/* pluginOptions */)
+]).process(YOUR_CSS /*, processOptions */);
+```
+
+## PostCSS CLI
+
+Add [PostCSS CLI] to your project:
+
+```bash
+npm install postcss-cli @csstools/postcss-global-data --save-dev
+```
+
+Use [PostCSS Global Data] in your `postcss.config.js` configuration file:
+
+```js
+const postcssGlobalData = require('@csstools/postcss-global-data');
+
+module.exports = {
+	plugins: [
+		postcssGlobalData(/* pluginOptions */)
+	]
+}
+```
+
+## PostCSS Load Config
+
+If your framework/CLI supports [`postcss-load-config`](https://github.com/postcss/postcss-load-config).
+
+```bash
+npm install @csstools/postcss-global-data --save-dev
+```
+
+`package.json`:
+
+```json
+{
+	"postcss": {
+		"plugins": {
+			"@csstools/postcss-global-data": {}
+		}
+	}
+}
+```
+
+`.postcssrc.json`:
+
+```json
+{
+	"plugins": {
+		"@csstools/postcss-global-data": {}
+	}
+}
+```
+
+_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-global-data --save-dev
+```
+
+Use [PostCSS Global Data] 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-global-data",
+										{
+											// 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-global-data --save-dev
+```
+
+Use [PostCSS Global Data] in your `postcss.config.json` file:
+
+```json
+{
+	"plugins": [
+		"@csstools/postcss-global-data"
+	]
+}
+```
+
+```json5
+{
+	"plugins": [
+		[
+			"@csstools/postcss-global-data",
+			{
+				// Optionally add plugin options
+			}
+		]
+	]
+}
+```
+
+## Gulp
+
+Add [Gulp PostCSS] to your project:
+
+```bash
+npm install gulp-postcss @csstools/postcss-global-data --save-dev
+```
+
+Use [PostCSS Global Data] in your Gulpfile:
+
+```js
+const postcss = require('gulp-postcss');
+const postcssGlobalData = require('@csstools/postcss-global-data');
+
+gulp.task('css', function () {
+	var plugins = [
+		postcssGlobalData(/* 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-global-data --save-dev
+```
+
+Use [PostCSS Global Data] in your Gruntfile:
+
+```js
+const postcssGlobalData = require('@csstools/postcss-global-data');
+
+grunt.loadNpmTasks('grunt-postcss');
+
+grunt.initConfig({
+	postcss: {
+		options: {
+			processors: [
+			postcssGlobalData(/* 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 Global Data]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-global-data
+[Next.js]: https://nextjs.org