Skip to content

Part 1: Project Setup

Terminal window
mkdir dp-mini-demo && cd dp-mini-demo
npm init -y

Edit package.json to set "type": "module" and "private": true:

{
"name": "dp-mini-demo",
"version": "1.0.0",
"type": "module",
"private": true
}
Terminal window
npm install @libar-dev/delivery-process@pre
added 63 packages, and audited 64 packages in 4s
23 packages are looking for funding
run `npm fund` for details
Terminal window
npm install -D typescript tsx
added 31 packages, and audited 95 packages in 3s
25 packages are looking for funding
run `npm fund` for details

Pre-release note: The @pre dist-tag installs the latest pre-release version (currently v1.0.0-pre.0). Once 1.0.0 stable ships, this becomes npm install @libar-dev/delivery-process.

  • @libar-dev/delivery-process — the documentation generation engine
  • typescript — for type checking
  • tsx — for running TypeScript CLI tools directly
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"outDir": "dist"
},
"include": ["src/**/*.ts", "delivery-process.config.ts"]
}
Terminal window
mkdir -p src/sample-sources src/specs src/stubs
  • package.json has "type": "module"
  • @libar-dev/delivery-process appears in dependencies
  • typescript and tsx appear in devDependencies
  • tsconfig.json exists
  • Empty folders: src/sample-sources/, src/specs/, src/stubs/