Socket
Socket
Sign inDemoInstall

@storybook/preset-svelte-webpack

Package Overview
Dependencies
6
Maintainers
11
Versions
679
Alerts
File Explorer

Advanced tools

npm Scripts
License

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 0.0.0-pr-28318-sha-24019b5c to 0.0.0-pr-28319-sha-b5e94723

1105

dist/index.d.ts

@@ -1,1107 +0,4 @@

import { FileSystemCache } from 'file-system-cache';
import { Server } from 'http';
import { PresetProperty } from 'storybook/internal/types';
export { BuilderResult, StorybookConfig, TypescriptOptions } from '@storybook/core-webpack';
/**
Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
@category Type
*/
type Primitive =
| null
| undefined
| string
| number
| boolean
| symbol
| bigint;
declare global {
interface SymbolConstructor {
readonly observable: symbol;
}
}
/**
Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
@example
```
import type {LiteralUnion} from 'type-fest';
// Before
type Pet = 'dog' | 'cat' | string;
const pet: Pet = '';
// Start typing in your TypeScript-enabled IDE.
// You **will not** get auto-completion for `dog` and `cat` literals.
// After
type Pet2 = LiteralUnion<'dog' | 'cat', string>;
const pet: Pet2 = '';
// You **will** get auto-completion for `dog` and `cat` literals.
```
@category Type
*/
type LiteralUnion<
LiteralType,
BaseType extends Primitive,
> = LiteralType | (BaseType & Record<never, never>);
declare namespace PackageJson$1 {
/**
A person who has been involved in creating or maintaining the package.
*/
export type Person =
| string
| {
name: string;
url?: string;
email?: string;
};
export type BugsLocation =
| string
| {
/**
The URL to the package's issue tracker.
*/
url?: string;
/**
The email address to which issues should be reported.
*/
email?: string;
};
export interface DirectoryLocations {
[directoryType: string]: unknown;
/**
Location for executable scripts. Sugar to generate entries in the `bin` property by walking the folder.
*/
bin?: string;
/**
Location for Markdown files.
*/
doc?: string;
/**
Location for example scripts.
*/
example?: string;
/**
Location for the bulk of the library.
*/
lib?: string;
/**
Location for man pages. Sugar to generate a `man` array by walking the folder.
*/
man?: string;
/**
Location for test files.
*/
test?: string;
}
export type Scripts = {
/**
Run **before** the package is published (Also run on local `npm install` without any arguments).
*/
prepublish?: string;
/**
Run both **before** the package is packed and published, and on local `npm install` without any arguments. This is run **after** `prepublish`, but **before** `prepublishOnly`.
*/
prepare?: string;
/**
Run **before** the package is prepared and packed, **only** on `npm publish`.
*/
prepublishOnly?: string;
/**
Run **before** a tarball is packed (on `npm pack`, `npm publish`, and when installing git dependencies).
*/
prepack?: string;
/**
Run **after** the tarball has been generated and moved to its final destination.
*/
postpack?: string;
/**
Run **after** the package is published.
*/
publish?: string;
/**
Run **after** the package is published.
*/
postpublish?: string;
/**
Run **before** the package is installed.
*/
preinstall?: string;
/**
Run **after** the package is installed.
*/
install?: string;
/**
Run **after** the package is installed and after `install`.
*/
postinstall?: string;
/**
Run **before** the package is uninstalled and before `uninstall`.
*/
preuninstall?: string;
/**
Run **before** the package is uninstalled.
*/
uninstall?: string;
/**
Run **after** the package is uninstalled.
*/
postuninstall?: string;
/**
Run **before** bump the package version and before `version`.
*/
preversion?: string;
/**
Run **before** bump the package version.
*/
version?: string;
/**
Run **after** bump the package version.
*/
postversion?: string;
/**
Run with the `npm test` command, before `test`.
*/
pretest?: string;
/**
Run with the `npm test` command.
*/
test?: string;
/**
Run with the `npm test` command, after `test`.
*/
posttest?: string;
/**
Run with the `npm stop` command, before `stop`.
*/
prestop?: string;
/**
Run with the `npm stop` command.
*/
stop?: string;
/**
Run with the `npm stop` command, after `stop`.
*/
poststop?: string;
/**
Run with the `npm start` command, before `start`.
*/
prestart?: string;
/**
Run with the `npm start` command.
*/
start?: string;
/**
Run with the `npm start` command, after `start`.
*/
poststart?: string;
/**
Run with the `npm restart` command, before `restart`. Note: `npm restart` will run the `stop` and `start` scripts if no `restart` script is provided.
*/
prerestart?: string;
/**
Run with the `npm restart` command. Note: `npm restart` will run the `stop` and `start` scripts if no `restart` script is provided.
*/
restart?: string;
/**
Run with the `npm restart` command, after `restart`. Note: `npm restart` will run the `stop` and `start` scripts if no `restart` script is provided.
*/
postrestart?: string;
} & Partial<Record<string, string>>;
/**
Dependencies of the package. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or Git URL.
*/
export type Dependency = Partial<Record<string, string>>;
/**
Conditions which provide a way to resolve a package entry point based on the environment.
*/
export type ExportCondition = LiteralUnion<
| 'import'
| 'require'
| 'node'
| 'node-addons'
| 'deno'
| 'browser'
| 'electron'
| 'react-native'
| 'default',
string
>;
type ExportConditions = {[condition in ExportCondition]: Exports};
/**
Entry points of a module, optionally with conditions and subpath exports.
*/
export type Exports =
| null
| string
| Array<string | ExportConditions>
| ExportConditions
| {[path: string]: Exports}; // eslint-disable-line @typescript-eslint/consistent-indexed-object-style
/**
Import map entries of a module, optionally with conditions.
*/
export type Imports = { // eslint-disable-line @typescript-eslint/consistent-indexed-object-style
[key: string]: string | {[key in ExportCondition]: Exports};
};
export interface NonStandardEntryPoints {
/**
An ECMAScript module ID that is the primary entry point to the program.
*/
module?: string;
/**
A module ID with untranspiled code that is the primary entry point to the program.
*/
esnext?:
| string
| {
[moduleName: string]: string | undefined;
main?: string;
browser?: string;
};
/**
A hint to JavaScript bundlers or component tools when packaging modules for client side use.
*/
browser?:
| string
| Partial<Record<string, string | false>>;
/**
Denote which files in your project are "pure" and therefore safe for Webpack to prune if unused.
[Read more.](https://webpack.js.org/guides/tree-shaking/)
*/
sideEffects?: boolean | string[];
}
export interface TypeScriptConfiguration {
/**
Location of the bundled TypeScript declaration file.
*/
types?: string;
/**
Version selection map of TypeScript.
*/
typesVersions?: Partial<Record<string, Partial<Record<string, string[]>>>>;
/**
Location of the bundled TypeScript declaration file. Alias of `types`.
*/
typings?: string;
}
/**
An alternative configuration for Yarn workspaces.
*/
export interface WorkspaceConfig {
/**
An array of workspace pattern strings which contain the workspace packages.
*/
packages?: WorkspacePattern[];
/**
Designed to solve the problem of packages which break when their `node_modules` are moved to the root workspace directory - a process known as hoisting. For these packages, both within your workspace, and also some that have been installed via `node_modules`, it is important to have a mechanism for preventing the default Yarn workspace behavior. By adding workspace pattern strings here, Yarn will resume non-workspace behavior for any package which matches the defined patterns.
[Read more](https://classic.yarnpkg.com/blog/2018/02/15/nohoist/)
*/
nohoist?: WorkspacePattern[];
}
/**
A workspace pattern points to a directory or group of directories which contain packages that should be included in the workspace installation process.
The patterns are handled with [minimatch](https://github.com/isaacs/minimatch).
@example
`docs` → Include the docs directory and install its dependencies.
`packages/*` → Include all nested directories within the packages directory, like `packages/cli` and `packages/core`.
*/
type WorkspacePattern = string;
export interface YarnConfiguration {
/**
Used to configure [Yarn workspaces](https://classic.yarnpkg.com/docs/workspaces/).
Workspaces allow you to manage multiple packages within the same repository in such a way that you only need to run `yarn install` once to install all of them in a single pass.
Please note that the top-level `private` property of `package.json` **must** be set to `true` in order to use workspaces.
*/
workspaces?: WorkspacePattern[] | WorkspaceConfig;
/**
If your package only allows one version of a given dependency, and you’d like to enforce the same behavior as `yarn install --flat` on the command-line, set this to `true`.
Note that if your `package.json` contains `"flat": true` and other packages depend on yours (e.g. you are building a library rather than an app), those other packages will also need `"flat": true` in their `package.json` or be installed with `yarn install --flat` on the command-line.
*/
flat?: boolean;
/**
Selective version resolutions. Allows the definition of custom package versions inside dependencies without manual edits in the `yarn.lock` file.
*/
resolutions?: Dependency;
}
export interface JSPMConfiguration {
/**
JSPM configuration.
*/
jspm?: PackageJson$1;
}
/**
Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Containing standard npm properties.
*/
export interface PackageJsonStandard {
/**
The name of the package.
*/
name?: string;
/**
Package version, parseable by [`node-semver`](https://github.com/npm/node-semver).
*/
version?: string;
/**
Package description, listed in `npm search`.
*/
description?: string;
/**
Keywords associated with package, listed in `npm search`.
*/
keywords?: string[];
/**
The URL to the package's homepage.
*/
homepage?: LiteralUnion<'.', string>;
/**
The URL to the package's issue tracker and/or the email address to which issues should be reported.
*/
bugs?: BugsLocation;
/**
The license for the package.
*/
license?: string;
/**
The licenses for the package.
*/
licenses?: Array<{
type?: string;
url?: string;
}>;
author?: Person;
/**
A list of people who contributed to the package.
*/
contributors?: Person[];
/**
A list of people who maintain the package.
*/
maintainers?: Person[];
/**
The files included in the package.
*/
files?: string[];
/**
Resolution algorithm for importing ".js" files from the package's scope.
[Read more.](https://nodejs.org/api/esm.html#esm_package_json_type_field)
*/
type?: 'module' | 'commonjs';
/**
The module ID that is the primary entry point to the program.
*/
main?: string;
/**
Subpath exports to define entry points of the package.
[Read more.](https://nodejs.org/api/packages.html#subpath-exports)
*/
exports?: Exports;
/**
Subpath imports to define internal package import maps that only apply to import specifiers from within the package itself.
[Read more.](https://nodejs.org/api/packages.html#subpath-imports)
*/
imports?: Imports;
/**
The executable files that should be installed into the `PATH`.
*/
bin?:
| string
| Partial<Record<string, string>>;
/**
Filenames to put in place for the `man` program to find.
*/
man?: string | string[];
/**
Indicates the structure of the package.
*/
directories?: DirectoryLocations;
/**
Location for the code repository.
*/
repository?:
| string
| {
type: string;
url: string;
/**
Relative path to package.json if it is placed in non-root directory (for example if it is part of a monorepo).
[Read more.](https://github.com/npm/rfcs/blob/latest/implemented/0010-monorepo-subdirectory-declaration.md)
*/
directory?: string;
};
/**
Script commands that are run at various times in the lifecycle of the package. The key is the lifecycle event, and the value is the command to run at that point.
*/
scripts?: Scripts;
/**
Is used to set configuration parameters used in package scripts that persist across upgrades.
*/
config?: Record<string, unknown>;
/**
The dependencies of the package.
*/
dependencies?: Dependency;
/**
Additional tooling dependencies that are not required for the package to work. Usually test, build, or documentation tooling.
*/
devDependencies?: Dependency;
/**
Dependencies that are skipped if they fail to install.
*/
optionalDependencies?: Dependency;
/**
Dependencies that will usually be required by the package user directly or via another dependency.
*/
peerDependencies?: Dependency;
/**
Indicate peer dependencies that are optional.
*/
peerDependenciesMeta?: Partial<Record<string, {optional: true}>>;
/**
Package names that are bundled when the package is published.
*/
bundledDependencies?: string[];
/**
Alias of `bundledDependencies`.
*/
bundleDependencies?: string[];
/**
Engines that this package runs on.
*/
engines?: {
[EngineName in 'npm' | 'node' | string]?: string;
};
/**
@deprecated
*/
engineStrict?: boolean;
/**
Operating systems the module runs on.
*/
os?: Array<LiteralUnion<
| 'aix'
| 'darwin'
| 'freebsd'
| 'linux'
| 'openbsd'
| 'sunos'
| 'win32'
| '!aix'
| '!darwin'
| '!freebsd'
| '!linux'
| '!openbsd'
| '!sunos'
| '!win32',
string
>>;
/**
CPU architectures the module runs on.
*/
cpu?: Array<LiteralUnion<
| 'arm'
| 'arm64'
| 'ia32'
| 'mips'
| 'mipsel'
| 'ppc'
| 'ppc64'
| 's390'
| 's390x'
| 'x32'
| 'x64'
| '!arm'
| '!arm64'
| '!ia32'
| '!mips'
| '!mipsel'
| '!ppc'
| '!ppc64'
| '!s390'
| '!s390x'
| '!x32'
| '!x64',
string
>>;
/**
If set to `true`, a warning will be shown if package is installed locally. Useful if the package is primarily a command-line application that should be installed globally.
@deprecated
*/
preferGlobal?: boolean;
/**
If set to `true`, then npm will refuse to publish it.
*/
private?: boolean;
/**
A set of config values that will be used at publish-time. It's especially handy to set the tag, registry or access, to ensure that a given package is not tagged with 'latest', published to the global public registry or that a scoped module is private by default.
*/
publishConfig?: PublishConfig;
/**
Describes and notifies consumers of a package's monetary support information.
[Read more.](https://github.com/npm/rfcs/blob/latest/accepted/0017-add-funding-support.md)
*/
funding?: string | {
/**
The type of funding.
*/
type?: LiteralUnion<
| 'github'
| 'opencollective'
| 'patreon'
| 'individual'
| 'foundation'
| 'corporation',
string
>;
/**
The URL to the funding page.
*/
url: string;
};
}
export interface PublishConfig {
/**
Additional, less common properties from the [npm docs on `publishConfig`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#publishconfig).
*/
[additionalProperties: string]: unknown;
/**
When publishing scoped packages, the access level defaults to restricted. If you want your scoped package to be publicly viewable (and installable) set `--access=public`. The only valid values for access are public and restricted. Unscoped packages always have an access level of public.
*/
access?: 'public' | 'restricted';
/**
The base URL of the npm registry.
Default: `'https://registry.npmjs.org/'`
*/
registry?: string;
/**
The tag to publish the package under.
Default: `'latest'`
*/
tag?: string;
}
}
/**
Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Also includes types for fields used by other popular projects, like TypeScript and Yarn.
@category File
*/
type PackageJson$1 =
PackageJson$1.PackageJsonStandard &
PackageJson$1.NonStandardEntryPoints &
PackageJson$1.TypeScriptConfiguration &
PackageJson$1.YarnConfiguration &
PackageJson$1.JSPMConfiguration;
type StoryId = string;
type ComponentTitle = string;
type StoryName = string;
type Tag$1 = string;
interface Options$1 {
allowRegExp: boolean;
allowFunction: boolean;
allowSymbol: boolean;
allowDate: boolean;
allowUndefined: boolean;
allowClass: boolean;
allowError: boolean;
maxDepth: number;
space: number | undefined;
lazyEval: boolean;
}
type ExportName = string;
type MetaId = string;
interface StoriesSpecifier {
/**
* When auto-titling, what to prefix all generated titles with (default: '')
*/
titlePrefix?: string;
/**
* Where to start looking for story files
*/
directory: string;
/**
* What does the filename of a story file look like?
* (a glob, relative to directory, no leading `./`)
* If unset, we use `** / *.@(mdx|stories.@(mdx|js|jsx|mjs|ts|tsx))` (no spaces)
*/
files?: string;
}
type StoriesEntry = string | StoriesSpecifier;
interface IndexerOptions {
makeTitle: (userTitle?: string) => string;
}
/**
* FIXME: This is a temporary type to allow us to deprecate the old indexer API.
* We should remove this type and the deprecated indexer API in 8.0.
*/
type BaseIndexer = {
/**
* A regular expression that should match all files to be handled by this indexer
*/
test: RegExp;
};
/**
* An indexer describes which filenames it handles, and how to index each individual file - turning it into an entry in the index.
*/
type Indexer = BaseIndexer & {
/**
* Indexes a file containing stories or docs.
* @param fileName The name of the file to index.
* @param options {@link IndexerOptions} for indexing the file.
* @returns A promise that resolves to an array of {@link IndexInput} objects.
*/
createIndex: (fileName: string, options: IndexerOptions) => Promise<IndexInput[]>;
};
/**
* The base input for indexing a story or docs entry.
*/
type BaseIndexInput = {
/** The file to import from e.g. the story file. */
importPath: Path;
/** The raw path/package of the file that provides meta.component, if one exists */
rawComponentPath?: Path;
/** The name of the export to import. */
exportName: ExportName;
/** The name of the entry, auto-generated from {@link exportName} if unspecified. */
name?: StoryName;
/** The location in the sidebar, auto-generated from {@link importPath} if unspecified. */
title?: ComponentTitle;
/**
* The custom id optionally set at `meta.id` if it needs to differ from the id generated via {@link title}.
* If unspecified, the meta id will be auto-generated from {@link title}.
* If specified, the meta in the CSF file _must_ have a matching id set at `meta.id`, to be correctly matched.
*/
metaId?: MetaId;
/** Tags for filtering entries in Storybook and its tools. */
tags?: Tag$1[];
/**
* The id of the entry, auto-generated from {@link title}/{@link metaId} and {@link exportName} if unspecified.
* If specified, the story in the CSF file _must_ have a matching id set at `parameters.__id`, to be correctly matched.
* Only use this if you need to override the auto-generated id.
*/
__id?: StoryId;
};
/**
* The input for indexing a story entry.
*/
type StoryIndexInput = BaseIndexInput & {
type: 'story';
};
/**
* The input for indexing a docs entry.
*/
type DocsIndexInput = BaseIndexInput & {
type: 'docs';
/** Paths to story files that must be pre-loaded for this docs entry. */
storiesImports?: Path[];
};
type IndexInput = StoryIndexInput | DocsIndexInput;
/**
* ⚠️ This file contains internal WIP types they MUST NOT be exported outside this package for now!
*/
type BuilderName = 'webpack5' | '@storybook/builder-webpack5' | string;
type RendererName = string;
interface CoreConfig {
builder?: BuilderName | {
name: BuilderName;
options?: Record<string, any>;
};
renderer?: RendererName;
disableWebpackDefaults?: boolean;
channelOptions?: Partial<Options$1>;
/**
* Disables the generation of project.json, a file containing Storybook metadata
*/
disableProjectJson?: boolean;
/**
* Disables Storybook telemetry
* @see https://storybook.js.org/telemetry
*/
disableTelemetry?: boolean;
/**
* Disables notifications for Storybook updates.
*/
disableWhatsNewNotifications?: boolean;
/**
* Enable crash reports to be sent to Storybook telemetry
* @see https://storybook.js.org/telemetry
*/
enableCrashReports?: boolean;
/**
* enable CORS headings to run document in a "secure context"
* see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements
* This enables these headers in development-mode:
* Cross-Origin-Opener-Policy: same-origin
* Cross-Origin-Embedder-Policy: require-corp
*/
crossOriginIsolated?: boolean;
}
interface DirectoryMapping {
from: string;
to: string;
}
interface Presets {
apply(extension: 'typescript', config: TypescriptOptions, args?: Options): Promise<TypescriptOptions>;
apply(extension: 'framework', config?: {}, args?: any): Promise<Preset>;
apply(extension: 'babel', config?: {}, args?: any): Promise<any>;
apply(extension: 'swc', config?: {}, args?: any): Promise<any>;
apply(extension: 'entries', config?: [], args?: any): Promise<unknown>;
apply(extension: 'stories', config?: [], args?: any): Promise<StoriesEntry[]>;
apply(extension: 'managerEntries', config: [], args?: any): Promise<string[]>;
apply(extension: 'refs', config?: [], args?: any): Promise<StorybookConfigRaw['refs']>;
apply(extension: 'core', config?: StorybookConfigRaw['core'], args?: any): Promise<NonNullable<StorybookConfigRaw['core']>>;
apply(extension: 'docs', config?: StorybookConfigRaw['docs'], args?: any): Promise<NonNullable<StorybookConfigRaw['docs']>>;
apply(extension: 'features', config?: StorybookConfigRaw['features'], args?: any): Promise<NonNullable<StorybookConfigRaw['features']>>;
apply(extension: 'typescript', config?: StorybookConfigRaw['typescript'], args?: any): Promise<NonNullable<StorybookConfigRaw['typescript']>>;
apply(extension: 'build', config?: StorybookConfigRaw['build'], args?: any): Promise<NonNullable<StorybookConfigRaw['build']>>;
apply(extension: 'staticDirs', config?: StorybookConfigRaw['staticDirs'], args?: any): Promise<StorybookConfigRaw['staticDirs']>;
apply<T>(extension: string, config?: T, args?: unknown): Promise<T>;
}
interface LoadedPreset {
name: string;
preset: any;
options: any;
}
interface VersionCheck {
success: boolean;
cached: boolean;
data?: any;
error?: any;
time: number;
}
type PackageJson = PackageJson$1 & Record<string, any>;
interface LoadOptions {
packageJson: PackageJson;
outputDir?: string;
configDir?: string;
cacheKey?: string;
ignorePreview?: boolean;
extendServer?: (server: Server) => void;
}
interface CLIOptions {
port?: number;
ignorePreview?: boolean;
previewUrl?: string;
forceBuildPreview?: boolean;
disableTelemetry?: boolean;
enableCrashReports?: boolean;
host?: string;
initialPath?: string;
exactPort?: boolean;
configDir?: string;
https?: boolean;
sslCa?: string[];
sslCert?: string;
sslKey?: string;
smokeTest?: boolean;
managerCache?: boolean;
open?: boolean;
ci?: boolean;
loglevel?: string;
quiet?: boolean;
versionUpdates?: boolean;
docs?: boolean;
test?: boolean;
debugWebpack?: boolean;
webpackStatsJson?: string | boolean;
statsJson?: string | boolean;
outputDir?: string;
}
interface BuilderOptions {
configType?: 'DEVELOPMENT' | 'PRODUCTION';
ignorePreview?: boolean;
cache?: FileSystemCache;
configDir: string;
docsMode?: boolean;
features?: StorybookConfigRaw['features'];
versionCheck?: VersionCheck;
disableWebpackDefaults?: boolean;
serverChannelUrl?: string;
}
interface StorybookConfigOptions {
presets: Presets;
presetsList?: LoadedPreset[];
}
type Options = LoadOptions & StorybookConfigOptions & CLIOptions & BuilderOptions & {
build?: TestBuildConfig;
};
/**
* Options for TypeScript usage within Storybook.
*/
interface TypescriptOptions {
/**
* Enables type checking within Storybook.
*
* @default `false`
*/
check: boolean;
/**
* Disable parsing TypeScript files through compiler.
*
* @default `false`
*/
skipCompiler: boolean;
}
type Preset = string | {
name: string;
options?: any;
};
/**
* An additional script that gets injected into the
* preview or the manager,
*/
type Entry = string;
type CoreCommon_StorybookRefs = Record<string, {
title: string;
url: string;
} | {
disable: boolean;
expanded?: boolean;
}>;
type DocsOptions = {
/**
* What should we call the generated docs entries?
*/
defaultName?: string;
/**
* Should we generate a docs entry per CSF file?
* Set to 'tag' (the default) to generate an entry for every CSF file with the
* 'autodocs' tag.
*
* @deprecated Use `tags: ['autodocs']` in `.storybook/preview.js` instead
*/
autodocs?: boolean | 'tag';
/**
* Only show doc entries in the side bar (usually set with the `--docs` CLI flag)
*/
docsMode?: boolean;
};
interface TestBuildFlags {
/**
* The package @storybook/blocks will be excluded from the bundle, even when imported in e.g. the preview.
*/
disableBlocks?: boolean;
/**
* Disable specific addons
*/
disabledAddons?: string[];
/**
* Filter out .mdx stories entries
*/
disableMDXEntries?: boolean;
/**
* Override autodocs to be disabled
*/
disableAutoDocs?: boolean;
/**
* Override docgen to be disabled.
*/
disableDocgen?: boolean;
/**
* Override sourcemaps generation to be disabled.
*/
disableSourcemaps?: boolean;
/**
* Override tree-shaking (dead code elimination) to be disabled.
*/
disableTreeShaking?: boolean;
/**
* Minify with ESBuild when using webpack.
*/
esbuildMinify?: boolean;
}
interface TestBuildConfig {
test?: TestBuildFlags;
}
type Tag = string;
interface TagOptions {
excludeFromSidebar: boolean;
excludeFromDocsStories: boolean;
}
type TagsOptions = Record<Tag, Partial<TagOptions>>;
/**
* The interface for Storybook configuration used internally in presets
* The difference is that these values are the raw values, AKA, not wrapped with `PresetValue<>`
*/
interface StorybookConfigRaw {
/**
* Sets the addons you want to use with Storybook.
*
* @example `['@storybook/addon-essentials']` or `[{ name: '@storybook/addon-essentials', options: { backgrounds: false } }]`
*/
addons?: Preset[];
core?: CoreConfig;
staticDirs?: (DirectoryMapping | string)[];
logLevel?: string;
features?: {
/**
* Filter args with a "target" on the type from the render function (EXPERIMENTAL)
*/
argTypeTargetsV7?: boolean;
/**
* Apply decorators from preview.js before decorators from addons or frameworks
*/
legacyDecoratorFileOrder?: boolean;
/**
* Disallow implicit actions during rendering. This will be the default in Storybook 8.
*
* This will make sure that your story renders the same no matter if docgen is enabled or not.
*/
disallowImplicitActionsInRenderV8?: boolean;
/**
* Enable asynchronous component rendering in React renderer
*/
experimentalRSC?: boolean;
};
build?: TestBuildConfig;
stories: StoriesEntry[];
framework?: Preset;
typescript?: Partial<TypescriptOptions>;
refs?: CoreCommon_StorybookRefs;
babel?: any;
swc?: any;
env?: Record<string, string>;
babelDefault?: any;
previewAnnotations?: Entry[];
experimental_indexers?: Indexer[];
docs?: DocsOptions;
previewHead?: string;
previewBody?: string;
previewMainTemplate?: string;
managerHead?: string;
tags?: TagsOptions;
}
type PresetProperty<K, TStorybookConfig = StorybookConfigRaw> = TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | PresetPropertyFn<K, TStorybookConfig>;
type PresetPropertyFn<K, TStorybookConfig = StorybookConfigRaw, TOptions = {}> = (config: TStorybookConfig[K extends keyof TStorybookConfig ? K : never], options: Options & TOptions) => TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | Promise<TStorybookConfig[K extends keyof TStorybookConfig ? K : never]>;
type Path = string;
type SvelteOptions = {

@@ -1108,0 +5,0 @@ preprocess?: any;

2

dist/svelte-docgen-loader.js

@@ -1,3 +0,3 @@

"use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var svelte_docgen_loader_exports={};__export(svelte_docgen_loader_exports,{default:()=>svelteDocgen});module.exports=__toCommonJS(svelte_docgen_loader_exports);var import_sveltedoc_parser=__toESM(require("sveltedoc-parser")),import_ts_dedent=require("ts-dedent"),path=__toESM(require("path")),fs=__toESM(require("fs")),import_compiler=require("svelte/compiler"),import_node_logger=require("@storybook/node-logger"),svelteDocParserOptions=require("sveltedoc-parser/lib/options.js");svelteDocParserOptions.getAstDefaultOptions=()=>({range:!0,loc:!0,comment:!0,tokens:!0,ecmaVersion:12,sourceType:"module",ecmaFeatures:{}});function getNameFromFilename(filename){if(!filename)return null;let parts=filename.split(/[/\\]/).map(encodeURI);if(parts.length>1){let index_match=parts[parts.length-1].match(/^index(\.\w+)/);index_match&&(parts.pop(),parts[parts.length-1]+=index_match[1])}let value=parts.pop();if(!value)throw new Error(`Could not derive component name from file ${filename}`);let base=value.replace(/%/g,"u").replace(/\.[^.]+$/,"").replace(/[^a-zA-Z_$0-9]+/g,"_").replace(/^_/,"").replace(/_$/,"").replace(/^(\d)/,"_$1");if(!base)throw new Error(`Could not derive component name from file ${filename}`);return base[0].toUpperCase()+base.slice(1)}async function svelteDocgen(source){let{resource}=this._module,svelteOptions=this.getOptions(),{preprocess:preprocessOptions,logDocgen=!1}=svelteOptions,docOptions;if(preprocessOptions){let src=fs.readFileSync(resource).toString(),{code:fileContent}=await(0,import_compiler.preprocess)(src,preprocessOptions);docOptions={fileContent}}else docOptions={filename:resource};let options={...docOptions,version:3},docgen="",componentDoc;try{componentDoc=await import_sveltedoc_parser.default.parse(options)}catch(error){componentDoc={keywords:[],data:[]},logDocgen&&import_node_logger.logger.error(error)}let file=path.basename(resource);componentDoc.name=path.basename(file);let componentName=getNameFromFilename(resource);return docgen=import_ts_dedent.dedent`
"use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var svelte_docgen_loader_exports={};__export(svelte_docgen_loader_exports,{default:()=>svelteDocgen});module.exports=__toCommonJS(svelte_docgen_loader_exports);var import_sveltedoc_parser=__toESM(require("sveltedoc-parser")),import_ts_dedent=require("ts-dedent"),path=__toESM(require("path")),fs=__toESM(require("fs")),import_compiler=require("svelte/compiler"),import_node_logger=require("storybook/internal/node-logger"),svelteDocParserOptions=require("sveltedoc-parser/lib/options.js");svelteDocParserOptions.getAstDefaultOptions=()=>({range:!0,loc:!0,comment:!0,tokens:!0,ecmaVersion:12,sourceType:"module",ecmaFeatures:{}});function getNameFromFilename(filename){if(!filename)return null;let parts=filename.split(/[/\\]/).map(encodeURI);if(parts.length>1){let index_match=parts[parts.length-1].match(/^index(\.\w+)/);index_match&&(parts.pop(),parts[parts.length-1]+=index_match[1])}let value=parts.pop();if(!value)throw new Error(`Could not derive component name from file ${filename}`);let base=value.replace(/%/g,"u").replace(/\.[^.]+$/,"").replace(/[^a-zA-Z_$0-9]+/g,"_").replace(/^_/,"").replace(/_$/,"").replace(/^(\d)/,"_$1");if(!base)throw new Error(`Could not derive component name from file ${filename}`);return base[0].toUpperCase()+base.slice(1)}async function svelteDocgen(source){let{resource}=this._module,svelteOptions=this.getOptions(),{preprocess:preprocessOptions,logDocgen=!1}=svelteOptions,docOptions;if(preprocessOptions){let src=fs.readFileSync(resource).toString(),{code:fileContent}=await(0,import_compiler.preprocess)(src,preprocessOptions);docOptions={fileContent}}else docOptions={filename:resource};let options={...docOptions,version:3},docgen="",componentDoc;try{componentDoc=await import_sveltedoc_parser.default.parse(options)}catch(error){componentDoc={keywords:[],data:[]},logDocgen&&import_node_logger.logger.error(error)}let file=path.basename(resource);componentDoc.name=path.basename(file);let componentName=getNameFromFilename(resource);return docgen=import_ts_dedent.dedent`
${componentName}.__docgen = ${JSON.stringify(componentDoc)};
`,source+docgen}

6

package.json
{
"name": "@storybook/preset-svelte-webpack",
"version": "0.0.0-pr-28318-sha-24019b5c",
"version": "0.0.0-pr-28319-sha-b5e94723",
"description": "Storybook for Svelte: Develop Svelte Component in isolation with Hot Reloading.",

@@ -67,4 +67,3 @@ "keywords": [

"dependencies": {
"@storybook/core-webpack": "0.0.0-pr-28318-sha-24019b5c",
"@storybook/node-logger": "0.0.0-pr-28318-sha-24019b5c",
"@storybook/core-webpack": "0.0.0-pr-28319-sha-b5e94723",
"sveltedoc-parser": "^4.2.1",

@@ -79,2 +78,3 @@ "ts-dedent": "^2.0.0"

"peerDependencies": {
"storybook": "^0.0.0-pr-28319-sha-b5e94723",
"svelte": "^4.0.0 || ^5.0.0-next.65",

@@ -81,0 +81,0 @@ "svelte-loader": "*"

dist/svelte-docgen-loader.mjs

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc