Merge pull request #132 from posthtml/feat/types

readme.md → README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <img width="150" height="150" title="PostHTML" src="https://posthtml.github.io/posthtml/logo.svg">
-  <h1>Merge inline longhand</h1>
+  <h1>Merge Longhand</h1>
   <p>Merge longhand inline CSS into shorthand</p>
 
   [![Version][npm-version-shield]][npm]

index.d.ts

@@ -0,0 +1,29 @@
+export type PluginOptions = {
+  /**
+  Array of tag names to process. All other tags will be skipped.
+
+  @default []
+
+  @example
+  ```js
+  const posthtml = require('posthtml')
+  const mergeInlineLonghand = require('posthtml-postcss-merge-longhand')
+
+  const html = `
+    <div style="margin: 0; margin-top: 20px;"></div>
+    <p style="margin: 0; margin-top: 10px;"></p>
+  `
+
+  posthtml([
+    mergeInlineLonghand({tags: ['div']})
+  ])
+    .process(html)
+    .then(result => console.log(result.html))
+
+  // Result:
+  // <div style="margin: 0; margin-top: 20px;"></div>
+  // <p style="margin: 0; margin-top: 10px;"></p>
+  ```
+  */
+  tags?: string[];
+};

package.json

@@ -8,6 +8,7 @@
   "homepage": "https://github.com/posthtml/posthtml-postcss-merge-longhand",
   "repository": "posthtml/posthtml-postcss-merge-longhand",
   "main": "lib",
+  "types": "index.d.ts",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -41,6 +42,7 @@
     "xo": "^0.54.2"
   },
   "files": [
-    "lib/*"
+    "lib/*",
+    "index.d.ts"
   ]
 }