Documentation
    Preparing search index...

    Interface AutoBinOptions

    interface AutoBinOptions {
        binBaseDir?: string;
        binIgnore?: string[];
        bins?: string | string[];
        defaultBinIgnore?: string[];
        enabledNpmHooks?: string[];
        shimDir?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    binBaseDir? binIgnore? bins? defaultBinIgnore? enabledNpmHooks? shimDir?

    Properties

    binBaseDir?: string

    Relative path from srcDir if you want your exports to start from a different directory.

    'bin'
    binIgnore?: string[]

    What paths to ignore when collecting bins in addition to defaultBinIgnore so you're not dropping the defaults when you just want to add additional ignore entries.

    []
    bins?: string | string[]

    The files to treat as bins elative from the srcDir + binBaseDir directory. It's usually * meaning all files directly here are considered the entry points of the library.

    '*'
    defaultBinIgnore?: string[]

    By default test files are excluded

    ['*.(spec|test).*']
    enabledNpmHooks?: string[]

    If a bin's name matches with an entry here (which is by default every NPM hook, 'postinstall' 'prebuild' etc.) then it will be automatically added to your packageJson file's scripts. To not interfere with development, hooks invoked during install are disabled for the source packageJson and are only avilable in the distributed packageJson.

    ALL_NPM_HOOKS
    shimDir?: string

    A directory where shims for the built bins would be placed All these scripts do is to import the yet-to-be-built binary so package managers hava something to symlink to before it's built.

    ! This folder has to be ignored by typescript as it contains broken ! imports before the package is built

    'shims'

    Settings

    Member Visibility

    On This Page

    Properties