vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • index
    • read-project-folders
    • Reference
  • Overview
  • Usage
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/project

@vltpkg/project

@vltpkg/project

Project-level utilities shared across workspaces.

Usage

Overview

This package contains shared helpers to discover candidate project folders, skipping well-known non-project folders in the user's home directory.

They back the :host() query selector.

Usage

JavaScript
import { PathScurry } from 'path-scurry'
import { readProjectFolders } from '@vltpkg/project'

const folders = await readProjectFolders({
  scurry: new PathScurry(process.cwd()),
  // defaults to scanning the user's home directory
  userDefinedProjectPaths: [],
})

console.log(folders.map(folder => folder.fullpath()))

PreviousReferenceNextindex

On this page

  • Overview
  • Usage

Deploy your package on vlt.io

Publish scoped and private packages, manage organizations and access, and give every developer and CI environment a consistent source for public and private JavaScript dependencies.

Publish now