Dovenv Documentation

dovenv is a versatile tool that helps manage and transform your workspace files, directories, and configurations with ease.

This page provides examples and commands to guide you in using dovenv effectively.

• Alias Commands: Create shortcuts for other commands.
• Check Commands: Validate the workspace structure.
• Transform Commands: Process and modify files based on specific inputs.

🔑 Installation

npm

npm install @dovenv/core

pnpm

pnpm install @dovenv/core

yarn

yarn add @dovenv/core

bun

bun add @dovenv/core

deno

deno add @dovenv/core

---

Features

Check

Check commands validate workspace structure, ensuring required files or directories exist and follow expected patterns.

Configuration

import {defineConfig} from '@dovenv/core'
import {joinPath, existsFile, existsDir} from '@dovenv/utils'

export default defineConfig({ check: {
  packages: {
    desc: 'Repo packages structure.',
    type: 'dir',
    patterns: [
      './packages/*',
      '!./packages/{plugin,config,theme}',
      './packages/{plugin,config,theme}/*',
    ],
    validateAll: async ({ paths }) => {
      if (paths.length === 0) throw new Error('No packages found');
    },
    validate: async ({ path }) => {
      const files = [joinPath(path, 'README.md')];
      const dirs = [joinPath(path, 'src')];
      for (const file of files) {
        const exists = await existsFile(file);
        if (!exists) throw new Error(`File [${file}] must exist`);
      }
      for (const dir of dirs) {
        const exists = await existsDir(dir);
        if (!exists) throw new Error(`Directory [${dir}] must exist`);
      }
    },
  },
} })

Example Usage

dovenv check -k packages

This validates the structure of the packages directory and ensures required files and subdirectories are present.

---

Transform

Transform commands allow you to process and modify specific files. For example, adding a watermark or replacing placeholders in templates.

Configuration

import {defineConfig} from '@dovenv/core'
import {replacePlaceholders} from '@dovenv/utils'

export default defineConfig( { transform : {
 readme : {
  input : [ 'README.md' ],
  fn    : async props => {

   const mark = props.const?.mark as string
   if ( mark === undefined ) throw new Error( 'Missing mark in configuration' )
   return props.content + `\n<!--${mark}-->\n`

  },
 },
 pp : {
  input : [ '.pigeonposse.yml' ],
  fn    : async props => {

   const ppTemplate = props.const?.template['.pigeonposse.yml'] as string
   const content    = await replacePlaceholders( {
    content : ppTemplate,
    params  : props.const || {},
   } )
   return content

  },
 },
} } )

Example Usage

dovenv transform -k readme

This command appends a custom ASCII watermark to the README.md file.

---

Aliases

Configuration

import {defineConfig} from '@dovenv/core'

export default defineConfig({
alias: {
  deps: {
	desc: 'List pacakge dependencies',
	cmd: 'pnpm list --depth=0',
  },
}
})

Example Usage

dovenv x deps

---

Constants

Configuration

import {defineConfig} from '@dovenv/core'

export default defineConfig({
const: {
  hello: 'world',
  foo: 'bar',
}
})

Example Usage

View all constants

dovenv const view

View specific constant(s)

dovenv const view -k hello

---

More Usage

Check Specific Key

dovenv check -k packages

Check Pattern Key

dovenv check -k 'package*'

Check Multiple Keys

dovenv check -k 'package*' 'docs'

Transform Specific Key

dovenv transform -k readme

Show Constants

dovenv const

Show Aliases

Lists aliases of your config file. Use the following to display a specific alias:

dovenv alias -k deps

Execute Alias

Run a specific alias. For example:

dovenv x deps

Print Config File in Terminal

dovenv config

➕ More

• 💡 Examples
• 📖 API Docs
• 📦 NPM