Trait typescript_tools::configuration_file::ConfigurationFile

pub trait ConfigurationFile: Sized {
    type Contents: Serialize;

    const FILENAME: &'static str;

    // Required methods
    fn from_directory(
        monorepo_root: &Directory,
        relative_directory: Directory
    ) -> Result<Self, FromFileError>;
    fn directory(&self) -> &Directory;
    fn path(&self) -> PathBuf;
    fn contents(&self) -> &Self::Contents;

    // Provided method
    fn write(
        monorepo_root: &Path,
        configuration_file: impl ConfigurationFile
    ) -> Result<(), WriteError> { ... }
}

Configuration file for some component of the monorepo.

Required Associated Types

type Contents: Serialize

Required Associated Constants

const FILENAME: &'static str

Basename of the configuration file.

Required Methods

fn from_directory( monorepo_root: &Directory, relative_directory: Directory ) -> Result<Self, FromFileError>

Create an instance of this configuration file by reading the specified file from this directory on disk.

fn directory(&self) -> &Directory

Relative path to directory containing this configuration file, from monorepo root.

fn path(&self) -> PathBuf

Relative path to this configuration file from the monorepo root.

fn contents(&self) -> &Self::Contents

Provided Methods

fn write( monorepo_root: &Path, configuration_file: impl ConfigurationFile ) -> Result<(), WriteError>

Object Safety

This trait is not object safe.

Implementors

impl ConfigurationFile for PackageManifest

type Contents = PackageManifestFile

const FILENAME: &'static str = "package.json"

impl ConfigurationFile for TypescriptConfig

type Contents = Map<String, Value>

const FILENAME: &'static str = "tsconfig.json"

impl ConfigurationFile for TypescriptParentProjectReference

type Contents = TypescriptParentProjectReferenceFile

const FILENAME: &'static str = "tsconfig.json"