ts-pkgx/dist/packages/cruftgithubio.d.ts

A library & CLI for managing packages

/**
 * **cruft** - Allows you to maintain all the necessary cruft for packaging and building projects separate from the code you intentionally write. Built on-top of, and fully compatible with, CookieCutter.
 *
 * @domain `cruft.github.io`
 * @programs `cruft`
 * @version `2.16.0` (2 versions available)
 * @versions From newest version to oldest.
 *
 * @install `launchpad install cruft`
 * @name `cruft`
 * @dependencies `python.org>=3.7<3.12`, `git-scm.org^2`
 *
 * @example
 * ```typescript
 * import { pantry } from 'ts-pkgx'
 *
 * // Access the package
 * const pkg = pantry.cruft
 * // Or access via domain
 * const samePkg = pantry.cruftgithubio
 * console.log(pkg === samePkg) // true
 * console.log(pkg.name)        // "cruft"
 * console.log(pkg.description) // "Allows you to maintain all the necessary cruft ..."
 * console.log(pkg.programs)    // ["cruft"]
 * console.log(pkg.versions[0]) // "2.16.0" (latest)
 * ```
 *
 * @see https://ts-pkgx.netlify.app/packages/cruft-github-io.md
 * @see https://ts-pkgx.netlify.app/usage
 */
export declare const cruftPackage: {
  /**
   * The display name of this package.
   */
  name: 'cruft';
  /**
   * The canonical domain name for this package.
   */
  domain: 'cruft.github.io';
  /**
   * Brief description of what this package does.
   */
  description: 'Allows you to maintain all the necessary cruft for packaging and building projects separate from the code you intentionally write. Built on-top of, and fully compatible with, CookieCutter.';
  packageYmlUrl: 'https://github.com/pkgxdev/pantry/tree/main/projects/cruft.github.io/package.yml';
  homepageUrl: '';
  githubUrl: 'https://github.com/pkgxdev/pantry/';
  /**
   * Command to install this package using launchpad.
   * @example launchpad install package-name
   */
  installCommand: 'launchpad install cruft';
  /**
   * Executable programs provided by this package.
   * These can be run after installation.
   */
  programs: readonly ['cruft'];
  companions: readonly [];
  /**
   * Required dependencies for this package.
   * These will be automatically installed.
   */
  dependencies: readonly ['python.org>=3.7<3.12', 'git-scm.org^2'];
  /**
   * Available versions from newest to oldest.
   * @see https://ts-pkgx.netlify.app/usage for installation instructions
   */
  versions: readonly ['2.16.0', '2.15.0'];
  /**
   * Alternative names for this package.
   * You can use any of these names to access the package.
   */
  aliases: readonly [];
  pkgxInstallCommand: 'sh <(curl https://pkgx.sh) cruft -- $SHELL -i';
  launchpadInstallCommand: 'launchpad install cruft'
};
export type CruftPackage = typeof cruftPackage