diff --git a/README.md b/README.md index c3990d2..7c06557 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ pnpm add use-file-system ```tsx import React from 'react'; -import { commonFilters, useWatchDirectory } from 'use-file-system'; +import { commonFilters, useFileSystem } from 'use-file-system'; export const Example = () => { - const { onDirectorySelection, files } = useWatchDirectory({ + const { onDirectorySelection, files } = useFileSystem({ filters: commonFilters, // filters out .gitignore paths and output paths like node_modules or dist, etc onFilesAdded: (newFiles, previousFiles) => { console.log('onFilesAdded', newFiles, previousFiles); @@ -93,7 +93,7 @@ export const Example = () => { - [distFilter](#gear-distfilter) - [miscFilter](#gear-miscfilter) - [processDirectory](#gear-processdirectory) -- [useWatchDirectory](#gear-usewatchdirectory) +- [useFileSystem](#gear-usefilesystem) ### :gear: gitFilter @@ -119,11 +119,11 @@ export const Example = () => { | ---------- | ---------- | | `processDirectory` | `(directoryHandle: FileSystemDirectoryHandle, directoryPath: string, filters: Filter[], includeFiles: Map, ignoreFilePaths: Set<...>) => Promise<...>` | -### :gear: useWatchDirectory +### :gear: useFileSystem | Function | Type | | ---------- | ---------- | -| `useWatchDirectory` | `(props: UseFileHandlingHookProps) => { handles: Map; onDirectorySelection: () => Promise; files: Map<...>; isProcessing: boolean; }` | +| `useFileSystem` | `(props: UseFileHandlingHookProps) => { handles: Map; onDirectorySelection: () => Promise; files: Map<...>; isProcessing: boolean; }` | ## :wrench: Constants diff --git a/src/filters.ts b/src/filters.ts index 320f325..9bbcdda 100644 --- a/src/filters.ts +++ b/src/filters.ts @@ -76,9 +76,6 @@ export const distFilter: FilterFn = async () => { if (filepath.includes(`/node_modules/`)) { return true; } - if (filepath.includes(`/node_modules/`)) { - return true; - } if (filepath.includes(`/.next/`)) { return true; } diff --git a/src/index.ts b/src/index.ts index f9d787e..93d8929 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,3 +1,3 @@ export * from './filters'; export * from './processDirectory'; -export * from './useWatchDirectory'; +export * from './useFileSystem'; diff --git a/src/stories/Example.stories.tsx b/src/stories/Example.stories.tsx index cad08b2..245fc42 100644 --- a/src/stories/Example.stories.tsx +++ b/src/stories/Example.stories.tsx @@ -12,6 +12,4 @@ const Template: StoryFn = () => ; export const Primary = Template.bind({}); -Primary.args = { - text: 'Clicked this many times:', -}; +Primary.args = {}; diff --git a/src/stories/Example.tsx b/src/stories/Example.tsx index 46b3dc8..6a29af5 100644 --- a/src/stories/Example.tsx +++ b/src/stories/Example.tsx @@ -1,9 +1,9 @@ import React from 'react'; import { action } from '@storybook/addon-actions'; -import { commonFilters, useWatchDirectory } from '..'; +import { commonFilters, useFileSystem } from '..'; export const Example = () => { - const { onDirectorySelection, files } = useWatchDirectory({ + const { onDirectorySelection, files } = useFileSystem({ filters: commonFilters, onFilesAdded: (newFiles, previousFiles) => { console.log('onFilesAdded', newFiles, previousFiles); diff --git a/src/useWatchDirectory.tsx b/src/useFileSystem.tsx similarity index 99% rename from src/useWatchDirectory.tsx rename to src/useFileSystem.tsx index bb72ac2..0460254 100644 --- a/src/useWatchDirectory.tsx +++ b/src/useFileSystem.tsx @@ -30,7 +30,7 @@ export interface UseFileHandlingHookProps { const DEFAULT_POLL_INTERVAL = 500; -export const useWatchDirectory = (props: UseFileHandlingHookProps) => { +export const useFileSystem = (props: UseFileHandlingHookProps) => { const { onFilesAdded: onAddFile, onFilesChanged: onChangeFile,