@csstools/postcss-sign-functions 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changes to PostCSS Sign Functions
+
+### 1.0.0
+
+_November 11, 2024_
+
+- Initial version
+- Updated [`@csstools/css-calc`](https://github.com/csstools/postcss-plugins/tree/main/packages/css-calc) to [`2.1.0`](https://github.com/csstools/postcss-plugins/tree/main/packages/css-calc/CHANGELOG.md#210) (minor)

package/LICENSE.md

@@ -0,0 +1,18 @@
+MIT No Attribution (MIT-0)
+
+Copyright © CSSTools Contributors
+
+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.
+
+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,167 @@
+# PostCSS Sign Functions [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][PostCSS]
+
+`npm install @csstools/postcss-sign-functions --save-dev`
+
+[PostCSS Sign Functions] lets you use the `sign` and `abs` functions, following the [CSS Values 4] specification.
+
+```css
+.sign {
+	z-index: sign(-10px);
+}
+
+.sign {
+	z-index: sign(0);
+}
+
+.sign {
+	z-index: sign(10px);
+}
+
+.abs {
+	z-index: abs(-10px);
+}
+
+.abs {
+	z-index: abs(0);
+}
+
+.abs {
+	z-index: abs(10px);
+}
+
+/* becomes */
+
+.sign {
+	z-index: -1;
+	z-index: sign(-10px);
+}
+
+.sign {
+	z-index: 0;
+	z-index: sign(0);
+}
+
+.sign {
+	z-index: 1;
+	z-index: sign(10px);
+}
+
+.abs {
+	z-index: 10px;
+	z-index: abs(-10px);
+}
+
+.abs {
+	z-index: 0;
+	z-index: abs(0);
+}
+
+.abs {
+	z-index: 10px;
+	z-index: abs(10px);
+}
+```
+
+> [!NOTE]
+> The utility of static fallbacks for `sign` and `abs` is limited.
+> The most interesting values are variables and dynamic values (e.g. those containing `%`).
+> It is impossible to generate static fallbacks in a build process for values that are dynamic on the client.
+
+## Usage
+
+Add [PostCSS Sign Functions] to your project:
+
+```bash
+npm install postcss @csstools/postcss-sign-functions --save-dev
+```
+
+Use it as a [PostCSS] plugin:
+
+```js
+const postcss = require('postcss');
+const postcssSignFunctions = require('@csstools/postcss-sign-functions');
+
+postcss([
+	postcssSignFunctions(/* pluginOptions */)
+]).process(YOUR_CSS /*, processOptions */);
+```
+
+
+
+## ⚠️ About custom properties
+
+Given the dynamic nature of custom properties it's impossible to know what the variable value is, which means the plugin can't compute a final value for the stylesheet. 
+
+Because of that, any usage that contains a `var` is skipped.
+
+## Options
+
+### preserve
+
+The `preserve` option determines whether the original notation
+is preserved. By default, it is preserved.
+
+```js
+postcssSignFunctions({ preserve: false })
+```
+
+```css
+.sign {
+	z-index: sign(-10px);
+}
+
+.sign {
+	z-index: sign(0);
+}
+
+.sign {
+	z-index: sign(10px);
+}
+
+.abs {
+	z-index: abs(-10px);
+}
+
+.abs {
+	z-index: abs(0);
+}
+
+.abs {
+	z-index: abs(10px);
+}
+
+/* becomes */
+
+.sign {
+	z-index: -1;
+}
+
+.sign {
+	z-index: 0;
+}
+
+.sign {
+	z-index: 1;
+}
+
+.abs {
+	z-index: 10px;
+}
+
+.abs {
+	z-index: 0;
+}
+
+.abs {
+	z-index: 10px;
+}
+```
+
+[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
+[css-url]: https://cssdb.org/#sign-functions
+[discord]: https://discord.gg/bUadyRwkJS
+[npm-url]: https://www.npmjs.com/package/@csstools/postcss-sign-functions
+
+[PostCSS]: https://github.com/postcss/postcss
+[PostCSS Sign Functions]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-sign-functions
+[CSS Values 4]: https://drafts.csswg.org/css-values-4/#sign-funcs

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var s=require("@csstools/css-calc");const e=/(?<![-\w])(?:sign|abs)\(/i,creator=c=>{const t=Object.assign({preserve:!0},c);return{postcssPlugin:"postcss-sign-functions",Declaration(c){if(!e.test(c.value))return;const o=s.calc(c.value,{precision:5,toCanonicalUnits:!0});o!==c.value&&(c.cloneBefore({value:o}),t.preserve||c.remove())}}};creator.postcss=!0,module.exports=creator;

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { PluginCreator } from 'postcss';
+
+declare const creator: PluginCreator<pluginOptions>;
+export default creator;
+
+/** postcss-sign-functions plugin options */
+export declare type pluginOptions = {
+    /** Preserve the original notation. default: true */
+    preserve?: boolean;
+};
+
+export { }

package/dist/index.mjs

@@ -0,0 +1 @@
+import{calc as s}from"@csstools/css-calc";const e=/(?<![-\w])(?:sign|abs)\(/i,creator=o=>{const t=Object.assign({preserve:!0},o);return{postcssPlugin:"postcss-sign-functions",Declaration(o){if(!e.test(o.value))return;const n=s(o.value,{precision:5,toCanonicalUnits:!0});n!==o.value&&(o.cloneBefore({value:n}),t.preserve||o.remove())}}};creator.postcss=!0;export{creator as default};

package/package.json

@@ -0,0 +1,72 @@
+{
+	"name": "@csstools/postcss-sign-functions",
+	"description": "Use sign and abs functions in CSS",
+	"version": "1.0.0",
+	"contributors": [
+		{
+			"name": "Antonio Laguna",
+			"email": "antonio@laguna.es",
+			"url": "https://antonio.laguna.es"
+		},
+		{
+			"name": "Romain Menke",
+			"email": "romainmenke@gmail.com"
+		}
+	],
+	"license": "MIT-0",
+	"funding": [
+		{
+			"type": "github",
+			"url": "https://github.com/sponsors/csstools"
+		},
+		{
+			"type": "opencollective",
+			"url": "https://opencollective.com/csstools"
+		}
+	],
+	"engines": {
+		"node": ">=18"
+	},
+	"type": "module",
+	"main": "dist/index.cjs",
+	"module": "dist/index.mjs",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.mjs"
+			},
+			"require": {
+				"default": "./dist/index.cjs"
+			}
+		}
+	},
+	"files": [
+		"CHANGELOG.md",
+		"LICENSE.md",
+		"README.md",
+		"dist"
+	],
+	"dependencies": {
+		"@csstools/css-calc": "^2.1.0",
+		"@csstools/css-parser-algorithms": "^3.0.4",
+		"@csstools/css-tokenizer": "^3.0.3"
+	},
+	"peerDependencies": {
+		"postcss": "^8.4"
+	},
+	"scripts": {},
+	"homepage": "https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-sign-functions#readme",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/csstools/postcss-plugins.git",
+		"directory": "plugins/postcss-sign-functions"
+	},
+	"bugs": "https://github.com/csstools/postcss-plugins/issues",
+	"keywords": [
+		"abs",
+		"css",
+		"postcss-plugin",
+		"sign"
+	]
+}