postcss-reduce-initial 5.0.3 → 5.1.0

package/README.md

@@ -85,10 +85,7 @@ See [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTOR
 
 ## License
 
-[Template:CSSData] by Mozilla Contributors is licensed under [CC-BY-SA 2.5].
-
-[template:cssdata]: https://developer.mozilla.org/en-US/docs/Template:CSSData
-[cc-by-sa 2.5]: http://creativecommons.org/licenses/by-sa/2.5/
+This program uses a list of CSS properties derived from data maintained my the MDN team at Mozilla and licensed under the [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
 
 MIT © [Ben Briggs](http://beneb.info)
 

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "postcss-reduce-initial",
-  "version": "5.0.3",
+  "version": "5.1.0",
   "description": "Reduce initial definitions to the actual initial value, where possible.",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
-    "data",
-    "src/index.js",
-    "LICENSE-MIT"
+    "src",
+    "LICENSE-MIT",
+    "types"
   ],
   "keywords": [
     "css",
@@ -32,6 +33,7 @@
     "node": "^10 || ^12 || >=14.0"
   },
   "devDependencies": {
+    "@types/caniuse-api": "^3.0.2",
     "postcss": "^8.2.15"
   },
   "peerDependencies": {
@@ -40,5 +42,5 @@
   "scripts": {
     "acquire": "node ./src/script/acquire.mjs"
   },
-  "readme": "# [postcss][postcss]-reduce-initial\n\n> Reduce `initial` definitions to the _actual_ initial value, where possible.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-reduce-initial) do:\n\n```\nnpm install postcss-reduce-initial --save\n```\n\n## Examples\n\nSee the [data](data) for more conversions. This data is courtesy\nof Mozilla.\n\n### Convert `initial` values\n\nWhen the `initial` keyword is longer than the property value, it will\nbe converted:\n\n#### Input\n\n```css\nh1 {\n  min-width: initial;\n}\n```\n\n#### Output\n\n```css\nh1 {\n  min-width: 0;\n}\n```\n\n### Convert values back to `initial`\n\nWhen the `initial` value is smaller than the property value, it will\nbe converted:\n\n#### Input\n\n```css\nh1 {\n  transform-box: border-box;\n}\n```\n\n#### Output\n\n```css\nh1 {\n  transform-box: initial;\n}\n```\n\nThis conversion is only applied when you supply a browsers list that all support\nthe `initial` keyword; it's worth noting that Internet Explorer has no support.\n\n## API\n\n### reduceInitial([options])\n\n#### options\n\n##### ignore\n\nType: `Array<String>`\nDefault: `undefined`\n\nIt contains the Array of properties that will be ignored while reducing its value to initial.\nExample : `{ ignore : [\"min-height\"] }`\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\n[Template:CSSData] by Mozilla Contributors is licensed under [CC-BY-SA 2.5].\n\n[template:cssdata]: https://developer.mozilla.org/en-US/docs/Template:CSSData\n[cc-by-sa 2.5]: http://creativecommons.org/licenses/by-sa/2.5/\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n"
+  "readme": "# [postcss][postcss]-reduce-initial\n\n> Reduce `initial` definitions to the _actual_ initial value, where possible.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-reduce-initial) do:\n\n```\nnpm install postcss-reduce-initial --save\n```\n\n## Examples\n\nSee the [data](data) for more conversions. This data is courtesy\nof Mozilla.\n\n### Convert `initial` values\n\nWhen the `initial` keyword is longer than the property value, it will\nbe converted:\n\n#### Input\n\n```css\nh1 {\n  min-width: initial;\n}\n```\n\n#### Output\n\n```css\nh1 {\n  min-width: 0;\n}\n```\n\n### Convert values back to `initial`\n\nWhen the `initial` value is smaller than the property value, it will\nbe converted:\n\n#### Input\n\n```css\nh1 {\n  transform-box: border-box;\n}\n```\n\n#### Output\n\n```css\nh1 {\n  transform-box: initial;\n}\n```\n\nThis conversion is only applied when you supply a browsers list that all support\nthe `initial` keyword; it's worth noting that Internet Explorer has no support.\n\n## API\n\n### reduceInitial([options])\n\n#### options\n\n##### ignore\n\nType: `Array<String>`\nDefault: `undefined`\n\nIt contains the Array of properties that will be ignored while reducing its value to initial.\nExample : `{ ignore : [\"min-height\"] }`\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nThis program uses a list of CSS properties derived from data maintained my the MDN team at Mozilla and licensed under the [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n"
 }

package/src/index.js

@@ -1,18 +1,22 @@
 'use strict';
 const browserslist = require('browserslist');
 const { isSupported } = require('caniuse-api');
-const fromInitial = require('../data/fromInitial.json');
-const toInitial = require('../data/toInitial.json');
+const fromInitial = require('./data/fromInitial.json');
+const toInitial = require('./data/toInitial.json');
 
 const initial = 'initial';
 
 // In most of the browser including chrome the initial for `writing-mode` is not `horizontal-tb`. Ref https://github.com/cssnano/cssnano/pull/905
 const defaultIgnoreProps = ['writing-mode', 'transform-box'];
 
+/**
+ * @type {import('postcss').PluginCreator<void>}
+ * @return {import('postcss').Plugin}
+ */
 function pluginCreator() {
   return {
     postcssPlugin: 'postcss-reduce-initial',
-
+    /** @param {import('postcss').Result & {opts: browserslist.Options & {ignore?: string[]}}} result */
     prepare(result) {
       const resultOpts = result.opts || {};
       const browsers = browserslist(null, {
@@ -37,7 +41,8 @@ function pluginCreator() {
             if (
               initialSupport &&
               Object.prototype.hasOwnProperty.call(toInitial, lowerCasedProp) &&
-              decl.value.toLowerCase() === toInitial[lowerCasedProp]
+              decl.value.toLowerCase() ===
+                toInitial[/** @type {keyof toInitial} */ (lowerCasedProp)]
             ) {
               decl.value = initial;
               return;
@@ -45,12 +50,13 @@ function pluginCreator() {
 
             if (
               decl.value.toLowerCase() !== initial ||
-              !fromInitial[lowerCasedProp]
+              !fromInitial[/** @type {keyof fromInitial} */ (lowerCasedProp)]
             ) {
               return;
             }
 
-            decl.value = fromInitial[lowerCasedProp];
+            decl.value =
+              fromInitial[/** @type {keyof fromInitial} */ (lowerCasedProp)];
           });
         },
       };

package/types/index.d.ts

@@ -0,0 +1,9 @@
+export = pluginCreator;
+/**
+ * @type {import('postcss').PluginCreator<void>}
+ * @return {import('postcss').Plugin}
+ */
+declare function pluginCreator(): import('postcss').Plugin;
+declare namespace pluginCreator {
+    const postcss: true;
+}