env-paths 3.0.0

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:npm/env-paths@3.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/env-paths@3.0.0

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:b26e1813e0887c1a843662debd9ad9c29c28fcbfbec759a38bf26ecdb9f7b1a2","contract":["Calling envPaths returns standard XDG paths on Linux including data, config, cache, log, and temp directories","Calling envPaths with default options appends the '-nodejs' suffix to the application directory name","Setting suffix option to false disables the suffix and uses the bare application name","Setting suffix option to a custom string appends the custom suffix to the application directory name","Passing a non-string name argument throws a TypeError"],"goal":"verify pkg:npm/env-paths@3.0.0","kind":"HOW","packages":["pkg:npm/env-paths@3.0.0"],"schemaVersion":1},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/env-paths@3.0.0"],"schemaVersion":1,"subject":"pkg:npm/env-paths@3.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-env-paths",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-env-paths",
      "version": "1.0.0",
      "dependencies": {
        "env-paths": "3.0.0"
      }
    },
    "node_modules/env-paths": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/env-paths/-/env-paths-3.0.0.tgz",
      "integrity": "sha512-dtJUTepzMW3Lm/NPxRf3wP4642UWhjL2sQxc+ym2YMj1m/H2zDNQOlezafzkHwn6sMstjHTwG6iQQsctDW/b1A==",
      "license": "MIT",
      "engines": {
        "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    }
  }
}

{
  "name": "sample-env-paths",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "env-paths": "3.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/env-paths@3.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/env-paths@3.0.0"
  ]
}

import assert from 'node:assert/strict';
import os from 'node:os';
import path from 'node:path';
import process from 'node:process';
import envPaths from 'env-paths';

// 1. envPaths returns an object containing data, config, cache, log, and temp directory paths
{
	const paths = envPaths('myapp', { suffix: false });
	assert.equal(typeof paths, 'object');
	assert.ok(typeof paths.data === 'string' && paths.data.length > 0);
	assert.ok(typeof paths.config === 'string' && paths.config.length > 0);
	assert.ok(typeof paths.cache === 'string' && paths.cache.length > 0);
	assert.ok(typeof paths.log === 'string' && paths.log.length > 0);
	assert.ok(typeof paths.temp === 'string' && paths.temp.length > 0);

	const homedir = os.homedir();
	const expectedData = process.env.XDG_DATA_HOME || path.join(homedir, '.local', 'share');
	const expectedConfig = process.env.XDG_CONFIG_HOME || path.join(homedir, '.config');
	const expectedCache = process.env.XDG_CACHE_HOME || path.join(homedir, '.cache');
	const expectedLog = process.env.XDG_STATE_HOME || path.join(homedir, '.local', 'state');

	assert.equal(paths.data, path.join(expectedData, 'myapp'));
	assert.equal(paths.config, path.join(expectedConfig, 'myapp'));
	assert.equal(paths.cache, path.join(expectedCache, 'myapp'));
	assert.equal(paths.log, path.join(expectedLog, 'myapp'));
}

// 2. envPaths defaults to appending '-nodejs' suffix to the provided application name
{
	const paths = envPaths('myapp');
	assert.ok(paths.data.endsWith('myapp-nodejs'));
	assert.ok(paths.config.endsWith('myapp-nodejs'));
	assert.ok(paths.cache.endsWith('myapp-nodejs'));
	assert.ok(paths.log.endsWith('myapp-nodejs'));
	assert.ok(paths.temp.endsWith('myapp-nodejs'));
}

// 3. envPaths with suffix option set to false disables suffixing and keeps the original application name
{
	const paths = envPaths('myapp', { suffix: false });
	assert.ok(paths.data.endsWith(path.sep + 'myapp'));
	assert.ok(!paths.data.endsWith('myapp-nodejs'));
}

// 4. envPaths with custom suffix option appends the custom suffix string to the application name
{
	const paths = envPaths('myapp', { suffix: 'server' });
	assert.ok(paths.data.endsWith('myapp-server'));
}

// 5. envPaths validates argument type and throws TypeError when name is not a string
{
	assert.throws(
		() => {
			envPaths(12345);
		},
		{
			name: 'TypeError',
			message: 'Expected a string, got number',
		}
	);
}