postcss-discard-unused 5.0.1 → 5.1.0

package/package.json

@@ -1,18 +1,14 @@
 {
   "name": "postcss-discard-unused",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "Discard unused counter styles, keyframes and fonts.",
-  "main": "dist/index.js",
+  "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
-    "bin",
     "LICENSE-MIT",
-    "dist"
+    "src",
+    "types"
   ],
-  "scripts": {
-    "prebuild": "del-cli dist",
-    "build": "cross-env BABEL_ENV=publish babel src --config-file ../../babel.config.json --out-dir dist --ignore \"**/__tests__/\"",
-    "prepublish": "yarn build"
-  },
   "keywords": [
     "css",
     "minify",
@@ -44,5 +40,5 @@
   "peerDependencies": {
     "postcss": "^8.2.15"
   },
-  "gitHead": "28c247175032fa03f04911cde56ad82d74d211cc"
-}
+  "readme": "# [postcss][postcss]-discard-unused\n\n> Discard unused counter styles, keyframes and fonts.\n\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-discard-unused) do:\n\n```\nnpm install postcss-discard-unused --save\n```\n\n\n## Example\n\nThis module will discard unused at rules in your CSS file, if it cannot find\nany selectors that make use of them. It works on `@counter-style`, `@keyframes`\nand `@font-face`.\n\n### Input\n\n```css\n@counter-style custom {\n    system: extends decimal;\n    suffix: \"> \"\n}\n\n@counter-style custom2 {\n    system: extends decimal;\n    suffix: \"| \"\n}\n\na {\n    list-style: custom\n}\n```\n\n### Output\n\n```css\n@counter-style custom {\n    system: extends decimal;\n    suffix: \"> \"\n}\n\na {\n    list-style: custom\n}\n```\n\nNote that this plugin is not responsible for normalising font families, as it\nmakes the assumption that you will write your font names consistently, such that\nit considers these two declarations differently:\n\n```css\nh1 {\n    font-family: \"Helvetica Neue\"\n}\n\nh2 {\n    font-family: Helvetica Neue\n}\n```\n\nHowever, you can mitigate this by including [postcss-minify-font-values][mfv]\n*before* this plugin, which will take care of normalising quotes, and\ndeduplicating. For more examples, see the [tests](src/__tests__/index.js).\n\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n\n## API\n\n### discardUnused([options])\n\n#### options\n\n##### fontFace\n\nType: `boolean`  \nDefault: `true`\n\nPass `false` to disable discarding unused font face rules.\n\n##### counterStyle\n\nType: `boolean`  \nDefault: `true`\n\nPass `false` to disable discarding unused counter style rules.\n\n##### keyframes\n\nType: `boolean`  \nDefault: `true`\n\nPass `false` to disable discarding unused keyframe rules.\n\n##### namespace\n\nType: `boolean`  \nDefault: `true`\n\nPass `false` to disable discarding unused namespace rules.\n\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\nMIT © [Ben Briggs](http://beneb.info)\n\n\n[postcss]: https://github.com/postcss/postcss\n[mfv]:     https://github.com/trysound/postcss-minify-font-values\n"
+}

package/src/index.js

@@ -0,0 +1,213 @@
+'use strict';
+const selectorParser = require('postcss-selector-parser');
+
+const atrule = 'atrule';
+const decl = 'decl';
+const rule = 'rule';
+/**
+ * @param {{value: string}} arg
+ * @param {(input: string) => string[]} comma
+ * @param {(input: string) => string[]} space
+ * @return {string[]}
+ */
+function splitValues({ value }, comma, space) {
+  /** @type {string[]} */
+  let result = [];
+  for (const val of comma(value)) {
+    result = result.concat(space(val));
+  }
+  return result;
+}
+
+/**
+ * @param {{atRules: import('postcss').AtRule[], values: string[]}} arg
+ * @return {void}
+ */
+function filterAtRule({ atRules, values }) {
+  const uniqueValues = new Set(values);
+  atRules.forEach((node) => {
+    const hasAtRule = uniqueValues.has(node.params);
+
+    if (!hasAtRule) {
+      node.remove();
+    }
+  });
+}
+
+/**
+ * @param {{atRules: import('postcss').AtRule[], rules: (string | true)[]}} arg
+ * @return {void}
+ */
+function filterNamespace({ atRules, rules }) {
+  const uniqueRules = new Set(rules);
+  atRules.forEach((atRule) => {
+    const { 0: param, length: len } = atRule.params.split(' ').filter(Boolean);
+
+    if (len === 1) {
+      return;
+    }
+
+    const hasRule = uniqueRules.has(param) || uniqueRules.has('*');
+
+    if (!hasRule) {
+      atRule.remove();
+    }
+  });
+}
+
+/**
+ * @param {string} fontFamily
+ * @param {string[]} cache
+ * @param {(input: string) => string[]} comma
+ * @return {boolean}
+ */
+function hasFont(fontFamily, cache, comma) {
+  return comma(fontFamily).some((font) => cache.some((c) => c.includes(font)));
+}
+
+/** 
+ * fonts have slightly different logic
+
+ * @param {{atRules: import('postcss').AtRule[], values: string[]}} cache
+ * @param {(input: string) => string[]} comma
+ * @return {void}
+ */
+function filterFont({ atRules, values }, comma) {
+  values = [...new Set(values)];
+  atRules.forEach((r) => {
+    /** @type {import('postcss').Declaration[]} */
+    const families = /** @type {import('postcss').Declaration[]} */ (
+      r.nodes.filter(
+        (node) => node.type === 'decl' && node.prop === 'font-family'
+      )
+    );
+
+    // Discard the @font-face if it has no font-family
+    if (!families.length) {
+      return r.remove();
+    }
+
+    families.forEach((family) => {
+      if (!hasFont(family.value.toLowerCase(), values, comma)) {
+        r.remove();
+      }
+    });
+  });
+}
+
+/**@typedef {{fontFace?: boolean, counterStyle?: boolean, keyframes?: boolean, namespace?: boolean}} Options */
+/**
+ * @type {import('postcss').PluginCreator<Options>}
+ * @param {Options} opts
+ * @return {import('postcss').Plugin}
+ */
+function pluginCreator(opts) {
+  const { fontFace, counterStyle, keyframes, namespace } = Object.assign(
+    {},
+    {
+      fontFace: true,
+      counterStyle: true,
+      keyframes: true,
+      namespace: true,
+    },
+    opts
+  );
+
+  return {
+    postcssPlugin: 'postcss-discard-unused',
+
+    prepare() {
+      /** @type {{atRules: import('postcss').AtRule[], values: string[]}} */
+      const counterStyleCache = { atRules: [], values: [] };
+      /** @type {{atRules: import('postcss').AtRule[], values: string[]}} */
+      const keyframesCache = { atRules: [], values: [] };
+      /** @type {{atRules: import('postcss').AtRule[], rules: (string | true)[]}} */
+      const namespaceCache = { atRules: [], rules: [] };
+      /** @type {{atRules: import('postcss').AtRule[], values: string[]}} */
+      const fontCache = { atRules: [], values: [] };
+
+      return {
+        OnceExit(css, { list }) {
+          const { comma, space } = list;
+          css.walk((node) => {
+            const { type } = node;
+
+            if (type === rule && namespace && node.selector.includes('|')) {
+              if (node.selector.includes('[')) {
+                // Attribute selector, so we should parse further.
+                selectorParser((ast) => {
+                  ast.walkAttributes(({ namespace: ns }) => {
+                    namespaceCache.rules = namespaceCache.rules.concat(ns);
+                  });
+                }).process(node.selector);
+              } else {
+                // Use a simple split function for the namespace
+                namespaceCache.rules = namespaceCache.rules.concat(
+                  node.selector.split('|')[0]
+                );
+              }
+              return;
+            }
+
+            if (type === decl) {
+              const { prop } = node;
+              if (counterStyle && /list-style|system/.test(prop)) {
+                counterStyleCache.values = counterStyleCache.values.concat(
+                  splitValues(node, comma, space)
+                );
+              }
+
+              if (
+                fontFace &&
+                node.parent !== undefined &&
+                node.parent.type === rule &&
+                /font(|-family)/.test(prop)
+              ) {
+                fontCache.values = fontCache.values.concat(
+                  comma(node.value.toLowerCase())
+                );
+              }
+
+              if (keyframes && /animation/.test(prop)) {
+                keyframesCache.values = keyframesCache.values.concat(
+                  splitValues(node, comma, space)
+                );
+              }
+
+              return;
+            }
+
+            if (type === atrule) {
+              const { name } = node;
+              if (counterStyle && /counter-style/.test(name)) {
+                counterStyleCache.atRules.push(node);
+              }
+
+              if (fontFace && name === 'font-face' && node.nodes) {
+                fontCache.atRules.push(node);
+              }
+
+              if (keyframes && /keyframes/.test(name)) {
+                keyframesCache.atRules.push(node);
+              }
+
+              if (namespace && name === 'namespace') {
+                namespaceCache.atRules.push(node);
+              }
+
+              return;
+            }
+          });
+
+          counterStyle && filterAtRule(counterStyleCache);
+          fontFace && filterFont(fontCache, comma);
+          keyframes && filterAtRule(keyframesCache);
+          namespace && filterNamespace(namespaceCache);
+        },
+      };
+    },
+  };
+}
+
+pluginCreator.postcss = true;
+module.exports = pluginCreator;

package/types/index.d.ts

@@ -0,0 +1,18 @@
+export = pluginCreator;
+/**@typedef {{fontFace?: boolean, counterStyle?: boolean, keyframes?: boolean, namespace?: boolean}} Options */
+/**
+ * @type {import('postcss').PluginCreator<Options>}
+ * @param {Options} opts
+ * @return {import('postcss').Plugin}
+ */
+declare function pluginCreator(opts: Options): import('postcss').Plugin;
+declare namespace pluginCreator {
+    export { postcss, Options };
+}
+type Options = {
+    fontFace?: boolean;
+    counterStyle?: boolean;
+    keyframes?: boolean;
+    namespace?: boolean;
+};
+declare var postcss: true;

package/CHANGELOG.md

@@ -1,63 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [5.0.1](https://github.com/cssnano/cssnano/compare/postcss-discard-unused@5.0.0...postcss-discard-unused@5.0.1) (2021-05-19)
-
-**Note:** Version bump only for package postcss-discard-unused
-
-
-
-
-
-# [5.0.0](https://github.com/cssnano/cssnano/compare/postcss-discard-unused@5.0.0-rc.2...postcss-discard-unused@5.0.0) (2021-04-06)
-
-**Note:** Version bump only for package postcss-discard-unused
-
-
-
-
-
-# [5.0.0-rc.2](https://github.com/cssnano/cssnano/compare/postcss-discard-unused@5.0.0-rc.1...postcss-discard-unused@5.0.0-rc.2) (2021-03-15)
-
-**Note:** Version bump only for package postcss-discard-unused
-
-
-
-
-
-# [5.0.0-rc.1](https://github.com/cssnano/cssnano/compare/postcss-discard-unused@5.0.0-rc.0...postcss-discard-unused@5.0.0-rc.1) (2021-03-04)
-
-**Note:** Version bump only for package postcss-discard-unused
-
-
-
-
-
-# 5.0.0-rc.0 (2021-02-19)
-
-
-### chore
-
-* minimum require version of node is 10.13 ([#871](https://github.com/cssnano/cssnano/issues/871)) ([28bda24](https://github.com/cssnano/cssnano/commit/28bda243e32ce3ba89b3c358a5f78727b3732f11))
-
-
-### Features
-
-* migarete to PostCSS 8 ([#975](https://github.com/cssnano/cssnano/issues/975)) ([40b82dc](https://github.com/cssnano/cssnano/commit/40b82dca7f53ac02cd4fe62846dec79b898ccb49))
-
-
-### BREAKING CHANGES
-
-* minimum supported `postcss` version is `8.2.1`
-* minimum require version of node is 10.13
-
-
-
-## 4.1.1 (2018-09-24)
-
-
-### Bug Fixes
-
-* **postcss-merge-longhand:** not mangle border output ([#555](https://github.com/cssnano/cssnano/issues/555)) ([9a70605](https://github.com/cssnano/cssnano/commit/9a706050b621e7795a9bf74eb7110b5c81804ffe)), closes [#553](https://github.com/cssnano/cssnano/issues/553) [#554](https://github.com/cssnano/cssnano/issues/554)

package/dist/index.js

@@ -1,209 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _postcssSelectorParser = _interopRequireDefault(require("postcss-selector-parser"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const atrule = 'atrule';
-const decl = 'decl';
-const rule = 'rule';
-
-function uniqs(items) {
-  return items.filter(function (item, i) {
-    return i === items.indexOf(item);
-  });
-}
-
-function addValues(cache, {
-  value
-}, comma, space) {
-  return comma(value).reduce((memo, val) => [...memo, ...space(val)], cache);
-}
-
-function filterAtRule({
-  atRules,
-  values
-}) {
-  values = uniqs(values);
-  atRules.forEach(node => {
-    const hasAtRule = values.some(value => value === node.params);
-
-    if (!hasAtRule) {
-      node.remove();
-    }
-  });
-}
-
-function filterNamespace({
-  atRules,
-  rules
-}) {
-  rules = uniqs(rules);
-  atRules.forEach(atRule => {
-    const {
-      0: param,
-      length: len
-    } = atRule.params.split(' ').filter(Boolean);
-
-    if (len === 1) {
-      return;
-    }
-
-    const hasRule = rules.some(r => r === param || r === '*');
-
-    if (!hasRule) {
-      atRule.remove();
-    }
-  });
-}
-
-function hasFont(fontFamily, cache, comma) {
-  return comma(fontFamily).some(font => cache.some(c => ~c.indexOf(font)));
-} // fonts have slightly different logic
-
-
-function filterFont({
-  atRules,
-  values
-}, comma) {
-  values = uniqs(values);
-  atRules.forEach(r => {
-    const families = r.nodes.filter(({
-      prop
-    }) => prop === 'font-family'); // Discard the @font-face if it has no font-family
-
-    if (!families.length) {
-      return r.remove();
-    }
-
-    families.forEach(family => {
-      if (!hasFont(family.value.toLowerCase(), values, comma)) {
-        r.remove();
-      }
-    });
-  });
-}
-
-function pluginCreator(opts) {
-  const {
-    fontFace,
-    counterStyle,
-    keyframes,
-    namespace
-  } = Object.assign({}, {
-    fontFace: true,
-    counterStyle: true,
-    keyframes: true,
-    namespace: true
-  }, opts);
-  return {
-    postcssPlugin: 'postcss-discard-unused',
-
-    prepare() {
-      const counterStyleCache = {
-        atRules: [],
-        values: []
-      };
-      const keyframesCache = {
-        atRules: [],
-        values: []
-      };
-      const namespaceCache = {
-        atRules: [],
-        rules: []
-      };
-      const fontCache = {
-        atRules: [],
-        values: []
-      };
-      return {
-        OnceExit(css, {
-          list
-        }) {
-          const {
-            comma,
-            space
-          } = list;
-          css.walk(node => {
-            const {
-              type,
-              prop,
-              selector,
-              name
-            } = node;
-
-            if (type === rule && namespace && ~selector.indexOf('|')) {
-              if (~selector.indexOf('[')) {
-                // Attribute selector, so we should parse further.
-                (0, _postcssSelectorParser.default)(ast => {
-                  ast.walkAttributes(({
-                    namespace: ns
-                  }) => {
-                    namespaceCache.rules = namespaceCache.rules.concat(ns);
-                  });
-                }).process(selector);
-              } else {
-                // Use a simple split function for the namespace
-                namespaceCache.rules = namespaceCache.rules.concat(selector.split('|')[0]);
-              }
-
-              return;
-            }
-
-            if (type === decl) {
-              if (counterStyle && /list-style|system/.test(prop)) {
-                counterStyleCache.values = addValues(counterStyleCache.values, node, comma, space);
-              }
-
-              if (fontFace && node.parent.type === rule && /font(|-family)/.test(prop)) {
-                fontCache.values = fontCache.values.concat(comma(node.value.toLowerCase()));
-              }
-
-              if (keyframes && /animation/.test(prop)) {
-                keyframesCache.values = addValues(keyframesCache.values, node, comma, space);
-              }
-
-              return;
-            }
-
-            if (type === atrule) {
-              if (counterStyle && /counter-style/.test(name)) {
-                counterStyleCache.atRules.push(node);
-              }
-
-              if (fontFace && name === 'font-face' && node.nodes) {
-                fontCache.atRules.push(node);
-              }
-
-              if (keyframes && /keyframes/.test(name)) {
-                keyframesCache.atRules.push(node);
-              }
-
-              if (namespace && name === 'namespace') {
-                namespaceCache.atRules.push(node);
-              }
-
-              return;
-            }
-          });
-          counterStyle && filterAtRule(counterStyleCache);
-          fontFace && filterFont(fontCache, comma);
-          keyframes && filterAtRule(keyframesCache);
-          namespace && filterNamespace(namespaceCache);
-        }
-
-      };
-    }
-
-  };
-}
-
-pluginCreator.postcss = true;
-var _default = pluginCreator;
-exports.default = _default;
-module.exports = exports.default;