Add JSDoc typings to main export

Author: decompil3d

lib/index.js

@@ -4,6 +4,26 @@ import { createProcessor } from 'rollup-copy-transform-css'
 import cssToModule from './css-to-module.js'
 import handleError from './error.js'
 
+/**
+ * lit CSS rollup plugin
+ *
+ * @param {Object} opts Options
+ * @param {string[]} [opts.include] Pattern to match files which will be processed by the plugin.
+ * @param {string[]} [opts.exclude] Pattern to match files which will be ignored by the plugin.
+ * @param {Object} [opts.options] Options for the Sass compiler. Use any options supported by the `compileString`
+ *  method from the Sass package.
+ * @param {boolean|Object} [opts.minify] Enables minifying of the transformed CSS output. If an object is specified, it
+ *  will be passed to the cssnano plugin.
+ * @param {boolean|Object} [opts.inline] Enables inlining of stylesheets and other assets. If an object is specified,
+ *  it will have to include two properties pointing to objects: { stylesheets, assets }. The stylesheets objects will
+ *  be passed to the postcss-import plugin. The assets objects will be passed to the postcss-url plugin.
+ * @param {Object[]} [opts.plugins] An array of PostCSS plugins to fully customise the transformation of the CSS input.
+ * @param {string} [opts.tag='css'] The tag used for the tagged template literal exported from the generated module.
+ *  Use 'css' (default) with both lit-html and fast-element.
+ * @param {string} [opts.specifier='lit'] The import specifier used in the import declaration of the tag above. Use
+ *  'lit' (default) with lit-html and '@microsoft/fast-element' with fast-element.
+ * @returns {import('rollup').Plugin}
+ */
 export function litCss({
   include = ['**/*.css'], exclude, minify, inline, plugins,
   tag = 'css', specifier = 'lit'