Merge pull request storybookjs#179 from xeho91/chores

xeho91 · web-flow · commit 69b4c28d7753 · 2024-05-16T15:26:33.000+08:00
chore: Remove `fs-extra` in favor of `node:fs`
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.svelte-kit/
 dist/
 node_modules/
 storybook-static/
diff --git a/package.json b/package.json
@@ -49,7 +49,6 @@
   "dependencies": {
     "@babel/runtime": "^7.22.6",
     "dedent": "^1.2.0",
-    "fs-extra": "^11.1.1",
     "magic-string": "^0.30.1"
   },
   "devDependencies": {
@@ -69,6 +68,7 @@
     "@storybook/test": "^8.0.0-rc.2",
     "@storybook/theming": "^8.0.0-rc.2",
     "@storybook/types": "^8.0.0-rc.2",
+    "@sveltejs/kit": "^2.5.7",
     "@sveltejs/package": "^2.2.0",
     "@sveltejs/vite-plugin-svelte": "^2.4.2",
     "@tsconfig/svelte": "^5.0.0",
diff --git a/src/config-loader.ts b/src/config-loader.ts
@@ -1,28 +1,28 @@
 // This file is a rewrite of `@sveltejs/vite-plugin-svelte` without the `Vite`
 // parts: https://github.com/sveltejs/vite-plugin-svelte/blob/e8e52deef93948da735c4ab69c54aced914926cf/packages/vite-plugin-svelte/src/utils/load-svelte-config.ts
-import { fileURLToPath, pathToFileURL } from 'url';
+import fs from 'node:fs';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
 
-import { createRequire } from 'module';
-import fs from 'fs';
 import { logger } from '@storybook/node-logger';
-import path from 'path';
-import { pathExists } from 'fs-extra';
+import type { Config } from '@sveltejs/kit';
 
 /**
  * Try find svelte config and then load it.
  *
- * @returns {import('@sveltejs/kit').Config | undefined}
+ * @returns
  * Returns the svelte configuration object.
  */
-export async function loadSvelteConfig() {
+export async function loadSvelteConfig(): Promise<Config | undefined> {
   const configFile = await findSvelteConfig();
 
   // no need to throw error since we handle projects without config files
   if (configFile === undefined) {
     return undefined;
   }
 
-  let err;
+  let err: unknown;
 
   // try to use dynamic import for svelte.config.js first
   if (configFile.endsWith('.js') || configFile.endsWith('.mjs')) {
@@ -61,13 +61,13 @@ const importSvelteOptions = (() => {
   /**
    * Try import specified svelte configuration.
    *
-   * @param {string} configFile
+   * @param configFile
    * Absolute path of the svelte config file to import.
    *
-   * @returns {import('@sveltejs/kit').Config}
+   * @returns
    * Returns the svelte configuration object.
    */
-  return async (configFile) => {
+  return async (configFile: string): Promise<Config> => {
     const result = await dynamicImportDefault(
       pathToFileURL(configFile).href,
       fs.statSync(configFile).mtimeMs
@@ -81,19 +81,18 @@ const importSvelteOptions = (() => {
 })();
 
 const requireSvelteOptions = (() => {
-  /** @type {NodeRequire} */
-  let esmRequire;
+  let esmRequire: NodeRequire;
 
   /**
    * Try import specified svelte configuration.
    *
-   * @param {string} configFile
+   * @param configFile
    * Absolute path of the svelte config file to require.
    *
-   * @returns {import('@sveltejs/kit').Config}
+   * @returns
    * Returns the svelte configuration object.
    */
-  return (configFile) => {
+  return (configFile: string): Config => {
     // identify which require function to use (esm and cjs mode)
     const requireFn = import.meta.url
       ? (esmRequire = esmRequire ?? createRequire(import.meta.url))
@@ -114,10 +113,10 @@ const requireSvelteOptions = (() => {
  * Try find svelte config. First in current working dir otherwise try to
  * find it by climbing up the directory tree.
  *
- * @returns {Promise<string | undefined>}
+ * @returns
  * Returns the absolute path of the config file.
  */
-async function findSvelteConfig() {
+async function findSvelteConfig(): Promise<string | undefined> {
   const lookupDir = process.cwd();
   let configFiles = await getConfigFiles(lookupDir);
 
@@ -140,10 +139,10 @@ async function findSvelteConfig() {
  * Returning the first found. Should solves most of monorepos with
  * only one config at workspace root.
  *
- * @returns {Promise<string[]>}
+ * @returns
  * Returns an array containing all available config files.
  */
-async function getConfigFilesUp() {
+async function getConfigFilesUp(): Promise<string[]> {
   const importPath = fileURLToPath(import.meta.url);
   const pathChunks = path.dirname(importPath).split(path.sep);
 
@@ -164,22 +163,21 @@ async function getConfigFilesUp() {
 /**
  * Gets all svelte config from a specified `lookupDir`.
  *
- * @param {string} lookupDir
+ * @param lookupDir
  * Directory in which to look for svelte files.
  *
- * @returns {Promise<string[]>}
+ * @returns
  * Returns an array containing all available config files.
  */
-async function getConfigFiles(lookupDir) {
-  /** @type {[string, boolean][]} */
-  const fileChecks = await Promise.all(
+async function getConfigFiles(lookupDir: string): Promise<string[]> {
+  const fileChecks: Array<[string, boolean]> = await Promise.all(
     knownConfigFiles.map(async (candidate) => {
       const filePath = path.resolve(lookupDir, candidate);
-      return [filePath, await pathExists(filePath)];
+      return [filePath, fs.existsSync(filePath)];
     })
   );
 
-  return fileChecks.reduce((files, [file, exists]) => {
+  return fileChecks.reduce((files: string[], [file, exists]) => {
     if (exists) files.push(file);
     return files;
   }, []);
diff --git a/src/preset/indexer.ts b/src/preset/indexer.ts
@@ -1,10 +1,11 @@
+import fs from 'node:fs/promises';
+
+import { storyNameFromExport, toId } from '@storybook/csf';
+import type { IndexInput, IndexedCSFFile, IndexerOptions } from '@storybook/types';
 import * as svelte from 'svelte/compiler';
 
 import { extractStories } from '../parser/extract-stories.js';
-import fs from 'fs-extra';
 import { loadSvelteConfig } from '../config-loader.js';
-import { storyNameFromExport, toId } from '@storybook/csf';
-import type { IndexInput, IndexedCSFFile, IndexerOptions } from '@storybook/types';
 
 export async function readStories(fileName: string) {
   let code = (await fs.readFile(fileName, 'utf-8')).toString();

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.svelte-kit/`
`1`	`2`	`dist/`
`2`	`3`	`node_modules/`
`3`	`4`	`storybook-static/`