@component-controls/config NPM

Overview

Configuration file utilities. Uses the glob package to locate story files from the configuration

Installation

This package is usually installed as part of the @component-controls package, but you can also install it standalone:

$ npm install @component-controls/config --save-dev

API

loadConfigurations

function

loads bot the build time and run time configurations

defined in @component-controls/config/core/config/src/index.ts

parameters

Name	Type	Description
`rootPath*`	`string`	the roo path of the project
`returns`	RunConfiguration	merged configuration

extractDocuments

react component

Find the story files out of a configuration file using glob for the regex file search

defined in @component-controls/config/core/config/src/index.ts

properties

Name	Type	Parent
`config*`	`BuildConfigurationwebpack`: `Configuration` \| `WebpackConfigFnfinalWebpack`: `Configuration` \| `WebpackConfigFnpresets`: `RuleType`[]`configPath`: `stringdistFolder`: `stringbundleName`: `stringstaticFolder`: `stringcssFileName`: `stringlogOptions`: `Partial`<`LogOptions`>`mode`: `"none"` \| `"development"` \| `"production"loadersat`: function* (`index`: `number`) => `T` \| `undefinedmodule`: `stringident`: `stringloader`: `stringoptions`: `string` \| `typestories`: `string` \| `string`[]`files`: `string` \| `string`[]`siteRoot`: `stringignore`: `string`[]`pages`[`string`]: `categories`: `DocType`[]`siteMap`: `type` \| `booleansiteUrl`: `stringinstrument`: `anysearchindexingModule`: `stringsearchingModule`: `stringfields`: `SearchFields`[]`emptySearchDocuments`: `string`[]`hitsPerPage`: `numberoptions`: `anytokensfigmaAccessToken`: `stringgithubAccessToken`: `stringcomponent`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<> \| `ComponentControlButton`<> \| `ComponentControlOptions`<> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFilessmartControlssmart`: `booleaninclude`: `string`[] \| `IncludeFnexclude`: `string`[] \| `IncludeFndecorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `string`	`ConfigurationResult`
`configPath*`	`string`	`ConfigurationResult`
`optionsFilePath`	`string`	`ConfigurationResult`

ConfigurationResult

interface

defined in @component-controls/config/core/config/src/index.ts

properties

Name	Type
`config*`	`BuildConfigurationwebpack`: `Configuration` \| `WebpackConfigFnfinalWebpack`: `Configuration` \| `WebpackConfigFnpresets`: `RuleType`[]`configPath`: `stringdistFolder`: `stringbundleName`: `stringstaticFolder`: `stringcssFileName`: `stringlogOptions`: `Partial`<`LogOptions`>`mode`: `"none"` \| `"development"` \| `"production"loadersat`: function* (`index`: `number`) => `T` \| `undefinedmodule`: `stringident`: `stringloader`: `stringoptions`: `string` \| `typestories`: `string` \| `string`[]`files`: `string` \| `string`[]`siteRoot`: `stringignore`: `string`[]`pages`[`string`]: `categories`: `DocType`[]`siteMap`: `type` \| `booleansiteUrl`: `stringinstrument`: `anysearchindexingModule`: `stringsearchingModule`: `stringfields`: `SearchFields`[]`emptySearchDocuments`: `string`[]`hitsPerPage`: `numberoptions`: `anytokensfigmaAccessToken`: `stringgithubAccessToken`: `stringcomponent`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>`controls`[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<> \| `ComponentControlButton`<> \| `ComponentControlOptions`<> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFilessmartControlssmart`: `booleaninclude`: `string`[] \| `IncludeFnexclude`: `string`[] \| `IncludeFndecorators`: `StoryRenderFn`[]`plugins`: `anycategory`: `string`
`configPath*`	`string`
`optionsFilePath`	`string`