createAutoImportTask.types.ts

import { Options } from './index.types'

export interface CreateAutoImportTaskProps {
   /**
    * The folder holding the files for this import task.
    *
    * If you have multiple folders, create a separate task
    * for each folder or target a shared common folder instead.
    */
   sourceFolder: string
   /**
    * The file extension for the type of files you want to target.
    *
    * Leave undefined to target all files inside the source folder
    */
   fileExtension?: string
   /**
    * Files and folders that start with this string will be ignored
    * @default "#"
    */
   ignoreCharacter?: string
   /**
    * Provide a unique string for helping identify the task.
    *
    * Typically not needed as the file extension and source folder are usually enough on their own.
    */
   taskPrefix?: string
   /**
    * Specify if the output file should be ignored.
    * Useful if the output file is in the same directory as the input files.
    * @default true
    */
   ignoreImporterFile?: boolean
   /**
    * The exact same object that you would normally pass
    * into the `autoImports()` gulp plugin
    */
   importerSettings?: Options
}

/**
 * The return value will return an array of two strings.
 *
 * The first string will be the name of the main gulp auto-imports task.
 *
 * The second string will be the name of the import task watcher.
 *
 * Use this pattern when creating your gulp tasks:
 *
 * ```js
 * const [ jsAutoImportsTask, jsAutoImportsWatcher ] = createAutoImportsTask({
 *  sourceFolder: './src/js-folder',
 *  fileExtension: 'js', // optional
 *  ignoreCharacter: 'X_', // optional
 *  importerSettings: { preset: 'js', dest: 'build' }
 * })
 *
 * gulp.task('default', gulp.parallel(jsAutoImportsTask, jsAutoImportsWatcher))
 * ```
 */
export type CreateAutoImportTaskReturn = [importerTaskName, watchTaskName]

type importerTaskName = string
type watchTaskName = string

export interface GetTaskNamesProps {
   name: string
   fileExtension?: string
   taskPrefix?: string
}
export interface GetTaskNamesReturn {
   taskName: string
   watchName: string
}