Skip to content

RepoPaths

Common file paths and patterns used by the TypeScript project tooling.

Import:

import type { RepoPaths } from '@mnaoumov/typescript-dev-toolkit/repo-paths';

Signature:

export enum RepoPaths

Members:

Member Value Description
Any '*' Any file or folder.
AnyCjs '*.cjs' CommonJS file.
AnyDcts '*.d.cts' CommonJS TypeScript declaration file.
AnyDmts '*.d.mts' ESM TypeScript declaration file.
AnyDts '*.d.ts' TypeScript declaration file.
AnyMjs '*.mjs' ESM JavaScript file.
AnyPath '**' Any path recursively.
AnyTestTs '*.test.ts' Any test TypeScript file.
AnyTs '*.ts' Any TypeScript file.
AnyTsx '*.tsx' Any TSX file.
BatExtension '.bat' Windows batch file extension.
Bin '.bin' Folder holding the executable shims of locally-installed packages.
BiomeJson 'biome.json' Biome configuration file.
BiomeJsonc 'biome.jsonc' Biome configuration file, with comments.
BunLock 'bun.lock' Bun lockfile.
BunLockb 'bun.lockb' Binary bun lockfile, written by bun before v1.2.
ChangelogMd 'CHANGELOG.md' Changelog file.
Cjs 'cjs' CommonJS folder.
CjsExtension '.cjs' CommonJS file extension.
ClaudeWorktrees '.claude/worktrees' Claude Code’s worktree folder. git worktree add puts a second, complete checkout of the repository here, INSIDE the repository, which is the only reason a repo ever contains a copy of itself. Never source, so every linter that walks the tree has to skip it.
CommandExtension '.cmd' Windows command script extension.
CommitlintConfigTs 'commitlint.config.ts' Commitlint configuration file.
CurrentFolder '.' Current folder.
DctsExtension '.d.cts' CommonJS TypeScript declaration file extension.
Dist 'dist' Distribution folder.
DistLib 'dist/lib' A path to the lib folder within the Dist folder.
DistTemplates 'dist/templates' A path to the templates folder within the Dist folder, holding the consumer-facing templates.
DjsExtension '.d.js' Transpiled TypeScript declaration file extension.
DmtsExtension '.d.mts' ESM TypeScript declaration file extension.
DotObsidian '.obsidian' Obsidian configuration folder within a vault.
DprintJson 'dprint.json' Dprint configuration file.
DtsExtension '.d.ts' TypeScript declaration file extension.
EslintConfigCjs 'eslint.config.cjs' CommonJS ESLint configuration file.
EslintConfigCts 'eslint.config.cts' CommonJS TypeScript ESLint configuration file.
EslintConfigJs 'eslint.config.js' JavaScript ESLint configuration file.
EslintConfigMjs 'eslint.config.mjs' ESM JavaScript ESLint configuration file.
EslintConfigMts 'eslint.config.mts' ESM TypeScript ESLint configuration file.
EslintConfigTs 'eslint.config.ts' TypeScript ESLint configuration file.
Esm 'esm' ESM JavaScript folder.
ExeExtension '.exe' Windows executable extension.
IndexCjs 'index.cjs' CommonJS JavaScript index file.
IndexDcts 'index.d.cts' CommonJS TypeScript declaration file index file.
IndexDmts 'index.d.mts' ESM TypeScript declaration file index file.
IndexMjs 'index.mjs' ESM JavaScript index file.
IndexTs 'index.ts' TypeScript index file.
JsExtension '.js' JavaScript file extension.
MarkdownlintCli2ConfigCjs '.markdownlint-cli2.cjs' CommonJS Markdownlint CLI2 configuration file.
MarkdownlintCli2ConfigJsonc '.markdownlint-cli2.jsonc' JSONC Markdownlint CLI2 configuration file.
MarkdownlintCli2ConfigMjs '.markdownlint-cli2.mjs' ESM Markdownlint CLI2 configuration file.
MarkdownlintCli2ConfigYaml '.markdownlint-cli2.yaml' YAML Markdownlint CLI2 configuration file.
MarkdownlintConfigCjs '.markdownlint.cjs' CommonJS Markdownlint configuration file.
MarkdownlintConfigJson '.markdownlint.json' JSON Markdownlint configuration file.
MarkdownlintConfigJsonc '.markdownlint.jsonc' JSONC Markdownlint configuration file.
MarkdownlintConfigMjs '.markdownlint.mjs' ESM Markdownlint configuration file.
MarkdownlintConfigYaml '.markdownlint.yaml' YAML Markdownlint configuration file.
MarkdownlintConfigYml '.markdownlint.yml' YAML Markdownlint configuration file.
MjsExtension '.mjs' ESM JavaScript file extension.
Mocks 'src/test-helpers' Test mocks folder.
NodeModules 'node_modules' Node modules folder.
NpmShrinkwrapJson 'npm-shrinkwrap.json' NPM shrinkwrap file.
PackageJson 'package.json' Package JSON file.
PackageLockJson 'package-lock.json' NPM lockfile.
PnpmLockYaml 'pnpm-lock.yaml' Pnpm lockfile.
RootFolder '/' Root folder.
Scripts 'scripts' Scripts folder.
Src 'src' Source folder.
Styles 'styles' Styles folder.
StylesCss 'styles.css' Styles CSS file.
Templates 'templates' Templates folder.
TestHelpers 'test-helpers' Test helpers folder.
Tests '__tests__' Tests folder.
TsConfigJson 'tsconfig.json' TypeScript configuration file.
TsConfigValidateDeclarationsCjsJson 'tsconfig.validate-declarations-cjs.json' TypeScript configuration file that validates the generated CommonJS declarations.
TsConfigValidateDeclarationsJson 'tsconfig.validate-declarations.json' TypeScript configuration file that validates the generated ESM declarations.
TsExtension '.ts' TypeScript file extension.
Types '@types' Types folder.
VitestConfigTs 'vitest.config.ts' Vitest configuration file.
YarnLock 'yarn.lock' Yarn lockfile.