postcss-normalize-string 5.0.4 → 6.0.0

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "postcss-normalize-string",
-  "version": "5.0.4",
+  "version": "6.0.0",
   "description": "Normalize wrapping quotes for CSS string literals.",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
     "src",
-    "LICENSE-MIT"
+    "LICENSE-MIT",
+    "types"
   ],
   "keywords": [
     "css",
@@ -27,13 +29,12 @@
     "url": "https://github.com/cssnano/cssnano/issues"
   },
   "engines": {
-    "node": "^10 || ^12 || >=14.0"
+    "node": "^14 || ^16 || >=18.0"
   },
   "devDependencies": {
     "postcss": "^8.2.15"
   },
   "peerDependencies": {
     "postcss": "^8.2.15"
-  },
-  "readme": "# [postcss][postcss]-normalize-string\n\n> Normalize strings with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-normalize-string) do:\n\n```\nnpm install postcss-normalize-string --save\n```\n\n## Example\n\n### Input\n\n```css\np:after{ content: '\\\\'string\\\\' is intact' }\n```\n\n### Output\n\n```css\np:after{ content:\"'string' is intact\" }\n```\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## API\n\n### normalize([options])\n\n#### options\n\n##### preferredQuote\n\nType: `string`\nDefault: `double`\n\nSets what type of quote to prefer. Possible values are `single` and `double`.\n\n```js\nvar css = 'p:after{content:\"\"}';\nconsole.log(postcss(normalize({preferredQuote: 'single'})).process(css).css);\n//=> p:after{content:''}\n```\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[postcss]: https://github.com/postcss/postcss\n"
+  }
 }

package/src/index.js

@@ -46,6 +46,17 @@ const T_SINGLE_QUOTE = { type: C_SINGLE_QUOTE, value: L_SINGLE_QUOTE };
 const T_DOUBLE_QUOTE = { type: C_DOUBLE_QUOTE, value: L_DOUBLE_QUOTE };
 const T_NEWLINE = { type: C_NEWLINE, value: L_NEWLINE };
 
+/** @typedef {T_ESCAPED_SINGLE_QUOTE | T_ESCAPED_DOUBLE_QUOTE | T_SINGLE_QUOTE | T_NEWLINE} StringAstNode */
+/**
+ * @typedef {{nodes: StringAstNode[],
+ *            types: {escapedSingleQuote: number, escapedDoubleQuote: number, singleQuote: number, doubleQuote: number},
+ *            quotes: boolean}} StringAst
+ */
+
+/**
+ * @param {StringAst} ast
+ * @return {string}
+ */
 function stringify(ast) {
   return ast.nodes.reduce((str, { value }) => {
     // Collapse multiple line strings automatically
@@ -57,11 +68,16 @@ function stringify(ast) {
   }, '');
 }
 
+/**
+ * @param {string} str
+ * @return {StringAst}
+ */
 function parse(str) {
   let code, next, value;
   let pos = 0;
   let len = str.length;
 
+  /** @type StringAst */
   const ast = {
     nodes: [],
     types: {
@@ -159,6 +175,11 @@ function parse(str) {
   return ast;
 }
 
+/**
+ * @param {valueParser.StringNode} node
+ * @param {StringAst} ast
+ * @return {void}
+ */
 function changeWrappingQuotes(node, ast) {
   const { types } = ast;
 
@@ -185,7 +206,9 @@ function changeWrappingQuotes(node, ast) {
   ast.nodes = changeChildQuotes(ast.nodes, node.quote);
 }
 /**
+ * @param {StringAstNode[]} childNodes
  * @param {string} parentQuote
+ * @return {StringAstNode[]}
  */
 function changeChildQuotes(childNodes, parentQuote) {
   const updatedChildren = [];
@@ -207,6 +230,11 @@ function changeChildQuotes(childNodes, parentQuote) {
   return updatedChildren;
 }
 
+/**
+ * @param {string} value
+ * @param {'single' | 'double'} preferredQuote
+ * @return {string}
+ */
 function normalize(value, preferredQuote) {
   if (!value || !value.length) {
     return value;
@@ -233,16 +261,28 @@ function normalize(value, preferredQuote) {
     .toString();
 }
 
+/**
+ * @param {string} original
+ * @param {Map<string, string>} cache
+ * @param {'single' | 'double'} preferredQuote
+ * @return {string}
+ */
 function minify(original, cache, preferredQuote) {
   const key = original + '|' + preferredQuote;
   if (cache.has(key)) {
-    return cache.get(key);
+    return /** @type {string} */ (cache.get(key));
   }
   const newValue = normalize(original, preferredQuote);
   cache.set(key, newValue);
   return newValue;
 }
 
+/** @typedef {{preferredQuote?: 'double' | 'single'}} Options */
+/**
+ * @type {import('postcss').PluginCreator<Options>}
+ * @param {Options} opts
+ * @return {import('postcss').Plugin}
+ */
 function pluginCreator(opts) {
   const { preferredQuote } = Object.assign(
     {},

package/types/index.d.ts

@@ -0,0 +1,38 @@
+export = pluginCreator;
+/** @typedef {{preferredQuote?: 'double' | 'single'}} 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, StringAstNode, StringAst, Options };
+}
+type Options = {
+    preferredQuote?: 'double' | 'single';
+};
+declare var postcss: true;
+type StringAstNode = {
+    type: string;
+    value: string;
+} | {
+    type: string;
+    value: string;
+} | {
+    type: string;
+    value: string;
+} | {
+    type: string;
+    value: string;
+};
+type StringAst = {
+    nodes: StringAstNode[];
+    types: {
+        escapedSingleQuote: number;
+        escapedDoubleQuote: number;
+        singleQuote: number;
+        doubleQuote: number;
+    };
+    quotes: boolean;
+};