Skip to content

Commit

Permalink
fix(options): use type
Browse files Browse the repository at this point in the history
  • Loading branch information
Anidetrix committed Mar 17, 2020
1 parent 7db718f commit 41884fb
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 22 deletions.
22 changes: 11 additions & 11 deletions docs/interfaces/options.html
Original file line number Diff line number Diff line change
Expand Up @@ -2871,7 +2871,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="postcssloadconfigoptions.html" class="tsd-signature-type">PostCSSLoadConfigOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L297">src/types.ts:297</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L298">src/types.ts:298</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2994,7 +2994,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> loaders</h3>
<div class="tsd-signature tsd-kind-icon">loaders<span class="tsd-signature-symbol">:</span> <a href="loader.html" class="tsd-signature-type">Loader</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L317">src/types.ts:317</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L318">src/types.ts:318</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3014,7 +3014,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> minimize</h3>
<div class="tsd-signature tsd-kind-icon">minimize<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CssNanoOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L272">src/types.ts:272</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L273">src/types.ts:273</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3077,7 +3077,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Extract</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Extract<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="extracteddata.html" class="tsd-signature-type">ExtractedData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L328">src/types.ts:328</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L329">src/types.ts:329</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3098,7 +3098,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Import</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Import<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L322">src/types.ts:322</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L323">src/types.ts:323</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3118,7 +3118,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> parser</h3>
<div class="tsd-signature tsd-kind-icon">parser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Parser</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L282">src/types.ts:282</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L283">src/types.ts:283</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3158,7 +3158,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> source<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">source<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inline"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L277">src/types.ts:277</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L278">src/types.ts:278</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3178,7 +3178,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stringifier</h3>
<div class="tsd-signature tsd-kind-icon">stringifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Stringifier</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L287">src/types.ts:287</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L288">src/types.ts:288</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3198,7 +3198,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> syntax</h3>
<div class="tsd-signature tsd-kind-icon">syntax<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Syntax</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L292">src/types.ts:292</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L293">src/types.ts:293</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3215,10 +3215,10 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> syntax</h3>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="use" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> use</h3>
<div class="tsd-signature tsd-kind-icon">use<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>less<span class="tsd-signature-symbol">?: </span><a href="../globals.html#objectwithunknownprops" class="tsd-signature-type">ObjectWithUnknownProps</a><span class="tsd-signature-symbol">; </span>sass<span class="tsd-signature-symbol">?: </span><a href="../globals.html#sassloaderoptions" class="tsd-signature-type">SASSLoaderOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../globals.html#objectwithunknownprops" class="tsd-signature-type">ObjectWithUnknownProps</a><span class="tsd-signature-symbol">; </span>stylus<span class="tsd-signature-symbol">?: </span><a href="../globals.html#objectwithunknownprops" class="tsd-signature-type">ObjectWithUnknownProps</a><span class="tsd-signature-symbol"> }</span></div>
<div class="tsd-signature tsd-kind-icon">use<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>less<span class="tsd-signature-symbol">?: </span><a href="../globals.html#objectwithunknownprops" class="tsd-signature-type">ObjectWithUnknownProps</a><span class="tsd-signature-symbol">; </span>sass<span class="tsd-signature-symbol">?: </span><a href="../globals.html#sassloaderoptions" class="tsd-signature-type">SASSLoaderOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../globals.html#objectwithunknownprops" class="tsd-signature-type">ObjectWithUnknownProps</a><span class="tsd-signature-symbol">; </span>stylus<span class="tsd-signature-symbol">?: </span><a href="../globals.html#objectwithunknownprops" class="tsd-signature-type">ObjectWithUnknownProps</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L306">src/types.ts:306</a></li>
<li>Defined in <a href="https://github.com/Anidetrix/rollup-plugin-styles/blob/master/src/types.ts#L307">src/types.ts:307</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
LoaderContext,
Payload,
ExtractedData,
ObjectWithUnknownProps,
LoadersOptions,
} from "./types";
import Loaders from "./loaders";
import { relativePath, normalizePath } from "./utils/path-utils";
Expand Down Expand Up @@ -87,7 +87,7 @@ export default (options: Options = {}): Plugin => {
},
};

let use: (string | [string, ObjectWithUnknownProps])[] = ["sass", "stylus", "less"];
let use: NonNullable<LoadersOptions["use"]> = ["sass", "stylus", "less"];

if (Array.isArray(options.use)) {
use = options.use;
Expand Down
13 changes: 7 additions & 6 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export type ModulesOptions = {
/**
* Default mode for classes
* @default "local"
*/
* */
mode?: LocalByDefaultOptions["mode"];
/** Fail on wrong order of composition */
failOnWrongOrder?: ExtractImportsOptions["failOnWrongOrder"];
Expand Down Expand Up @@ -204,7 +204,7 @@ export interface Options {
/**
* A list of plugins for PostCSS.
* @default undefined
*/
* */
plugins?: (
| postcss.Transformer
| string
Expand Down Expand Up @@ -235,7 +235,7 @@ export interface Options {
/**
* Container for `<style>` tag(s) injection
* @default document.head
*/
* */
container?: HTMLElement;
}
| ((varname: string, id: string) => string);
Expand All @@ -249,7 +249,7 @@ export interface Options {
* Enable and optionally pass additional configuration for
* [CSS Modules](https://github.com/css-modules/css-modules)
* @default false
*/
* */
modules?: boolean | ModulesOptions;
/**
* Automatically enable
Expand All @@ -268,7 +268,8 @@ export interface Options {
/**
* Enable CSS minification and optionally pass additional configuration for
* [cssnano](https://github.com/cssnano/cssnano)
* @default false */
* @default false
* */
minimize?: boolean | cssnano.CssNanoOptions;
/**
* Enable sourceMap.
Expand Down Expand Up @@ -304,7 +305,7 @@ export interface Options {
* @default ["sass", "stylus", "less"]
* */
use?:
| (string | [string, ObjectWithUnknownProps])[]
| (string | [string] | [string, ObjectWithUnknownProps])[]
| {
sass?: SASSLoaderOptions & ObjectWithUnknownProps;
stylus?: ObjectWithUnknownProps;
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2828,9 +2828,9 @@ ecc-jsbn@~0.1.1:
safer-buffer "^2.1.0"

electron-to-chromium@^1.3.363:
version "1.3.376"
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.376.tgz#7cb7b5205564a06c8f8ecfbe832cbd47a1224bb1"
integrity sha512-cv/PYVz5szeMz192ngilmezyPNFkUjuynuL2vNdiqIrio440nfTDdc0JJU0TS2KHLSVCs9gBbt4CFqM+HcBnjw==
version "1.3.377"
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.377.tgz#b49d420b36ee6c48b0cd3137bfc7fec75f369b2e"
integrity sha512-cm2WzMKf/3dW5+hNANKm8GAW6SwIWOqLTJ6GPCD0Bbw1qJ9Wzm9nmx9M+byzSsgw8CdCv5fb/wzLFqVS5h6QrA==

elegant-spinner@^1.0.1:
version "1.0.1"
Expand Down

0 comments on commit 41884fb

Please sign in to comment.