projen/lib/javascript/license-checker.d.ts

CDK for software projects

import type { Construct } from "constructs";
import { Component } from "../component";
import type { Task } from "../task";
/**
 * Options to configure the license checker
 */
export interface LicenseCheckerOptions {
    /**
     * Check production dependencies.
     * @default true
     */
    readonly production?: boolean;
    /**
     * Check development dependencies.
     * @default false
     */
    readonly development?: boolean;
    /**
     * List of SPDX license identifiers that are allowed to be used.
     *
     * For the license check to pass, all detected licenses MUST be in this list.
     * Only one of `allowedLicenses` and `prohibitedLicenses` can be provided and must not be empty.
     * @default - no licenses are allowed
     */
    readonly allow?: string[];
    /**
     * List of SPDX license identifiers that are prohibited to be used.
     *
     * For the license check to pass, no detected licenses can be in this list.
     * Only one of `allowedLicenses` and `prohibitedLicenses` can be provided and must not be empty.
     * @default - no licenses are prohibited
     */
    readonly deny?: string[];
    /**
     * Exclude packages marked as private from the check.
     *
     * Private packages are local to the repository and not published, so their
     * licenses typically don't need to be checked. This also applies to the project
     * itself.
     *
     * @default true
     */
    readonly excludePrivatePackages?: boolean;
    /**
     * The name of the task that is added to check licenses
     *
     * @default "check-licenses"
     */
    readonly taskName?: string;
}
/**
 * Enforces allowed licenses used by dependencies.
 */
export declare class LicenseChecker extends Component {
    readonly task: Task;
    constructor(scope: Construct, options: LicenseCheckerOptions);
}