projectz

  • Version 2.22.0
  • Published
  • 204 kB
  • 9 dependencies
  • MIT license

Install

npm i projectz
yarn add projectz
pnpm add projectz

Overview

Stop wasting time syncing and updating your project's README and Package Files!

Index

Classes

class Projectz

class Projectz {}

    constructor

    constructor(opts: Options);

      property cwd

      protected readonly cwd: string;
      • the current working directory (the path) that projectz is working on

      property dataForPackageFiles

      protected readonly dataForPackageFiles: DataForPackageFiles;
      • the data for each of our package files

      property dataForReadmeFiles

      protected readonly dataForReadmeFiles: DataForReadmeFiles;
      • the data for each of our readme files

      property filenamesForPackageFiles

      protected readonly filenamesForPackageFiles: FilenamesForPackageFiles;
      • The absolute paths for all the package files. Should be arranged in the order of merging preference.

      property filenamesForReadmeFiles

      protected readonly filenamesForReadmeFiles: FilenamesForReadmeFiles;
      • the absolute paths for all the meta files

      property log

      protected readonly log: Function;
      • our log function to use (logLevel, ...messages)

      method compile

      compile: () => Promise<void>;
      • Compile the project

      method enhancePackagesData

      protected enhancePackagesData: () => Promise<EnhancedPackagesData>;
      • Merge and enhance the packages data

      method enhanceReadmesData

      protected enhanceReadmesData: (
      data: EnhancedPackagesData
      ) => Promise<DataForReadmeFiles>;
      • Merge and enhance the readmes data

      method loadPaths

      protected loadPaths: () => Promise<void>;
      • Load in the paths we have specified

      method save

      protected save: (
      enhancedPackagesData: EnhancedPackagesData,
      enhancedReadmesData: EnhancedReadmesData
      ) => Promise<void>;
      • Save the data we've loaded into the files

      Package Files (1)

      Dependencies (9)

      Dev Dependencies (17)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/projectz.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/projectz)
      • HTML
        <a href="https://www.jsdocs.io/package/projectz"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>