@pakk/core/plugins/bin/auto-bin.class.options.d.ts

The core library of pakk, that can manage your package.json for library development.

import { Defined } from '@alexaegis/common';
export interface AutoBinOptions {
    /**
     * ### AutoBin
     *
     * 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.
     *
     * @defaultValue '*'
     */
    bins?: string | string[] | undefined;
    /**
     * ### AutoBin
     *
     * 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.
     *
     * @defaultValue []
     */
    binIgnore?: string[] | undefined;
    /**
     * ### AutoBin
     *
     * By default test files are excluded
     *
     * @defaultValue ['*.(spec|test).*']
     */
    defaultBinIgnore?: string[] | undefined;
    /**
     * ### AutoBin
     *
     * Relative path from `srcDir` if you want your exports to start from a
     * different directory.
     *
     * @defaultValue 'bin'
     */
    binBaseDir?: string | undefined;
    /**
     * ### AutoBin
     *
     * 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.
     *
     * @defaultValue ALL_NPM_HOOKS
     */
    enabledNpmHooks?: string[] | undefined;
    /**
     * ### AutoBin
     *
     * 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
     *
     * @defaultValue 'shims'
     */
    shimDir?: string | undefined;
}
export type NormalizedAutoBinOptions = Defined<AutoBinOptions>;
export declare const normalizeAutoBinOptions: (options?: AutoBinOptions) => NormalizedAutoBinOptions;
//# sourceMappingURL=auto-bin.class.options.d.ts.map