filetraits
A VS Code extension that lets you define traits — TypeScript-based rules that control how new files are named and where they are placed in your workspace.
Inspired by traits in Dendron (no longer maintained).
How It Works
- Define trait files in your workspace (by default in
.vscode/filetraits/)
- Run Filetraits: Apply Trait from the command palette
- Pick a trait, confirm the file name and location, and the file is created
Traits are written in TypeScript and loaded at runtime — no compilation step needed.
Commands
| Command |
Description |
Filetraits: Create Trait from Template |
Scaffold a new trait file with boilerplate |
Filetraits: Apply Trait |
Pick a trait and create a new file based on its rules |
Writing a Trait
A trait is a TypeScript file that exports a Trait object using defineTrait():
/// <reference path="..." />
export default defineTrait({
name: "React Component",
description: "Creates a new React component file",
getDirectory: (ctx) => {
// Place the file in the same directory as the active file
return ctx.activeDocument?.workspaceDirpath ?? "src/components";
},
getName: (ctx) => ({
name: "MyComponent",
extension: ".tsx",
}),
});
Trait API
name — display name shown in the quick pick menudescription (optional) — description of what the trait doesgetDirectory(context) (optional) — returns the directory for the new file (defaults to .)getName(context) — returns { name, extension? } for the new fileeditName (optional) — whether the user can edit the file name (defaults to true)
Context
The context object passed to trait functions provides:
activeDocument — info about the currently open file (workspacePath, baseName, extension, absolutePath, etc.), or undefined if no editor is activeluxon.DateTime — the Luxon DateTime class for date/time operations
Configuration
| Setting |
Default |
Description |
filetraits.traitsDirectory |
./.vscode/filetraits |
Path (relative to workspace root) where trait files are stored |
Installation
From Source
npm install
npm run vscode:deploy:local
This packages the extension into a .vsix and installs it into VS Code.
Development
npm run compile # Build
npm run watch # Build in watch mode
npm run lint # Lint
npm run test # Run tests
Press F5 in VS Code to launch the Extension Development Host for debugging.
License
MIT
