davila7--claude-code-templates
1 行
17 KiB
JSON
1 行
17 KiB
JSON
{"content": "---\nname: obsidian-bases\ndescription: Create and edit Obsidian Bases (.base files) with views, filters, formulas, and summaries. Use when working with .base files, creating database-like views of notes, or when the user mentions Bases, table views, card views, filters, or formulas in Obsidian.\n---\n\n# Obsidian Bases Skill\n\nThis skill enables Claude Code to create and edit valid Obsidian Bases (`.base` files) including views, filters, formulas, and all related configurations.\n\n## Overview\n\nObsidian Bases are YAML-based files that define dynamic views of notes in an Obsidian vault. A Base file can contain multiple views, global filters, formulas, property configurations, and custom summaries.\n\n## File Format\n\nBase files use the `.base` extension and contain valid YAML. They can also be embedded in Markdown code blocks.\n\n## Complete Schema\n\n```yaml\n# Global filters apply to ALL views in the base\nfilters:\n # Can be a single filter string\n # OR a recursive filter object with and/or/not\n and: []\n or: []\n not: []\n\n# Define formula properties that can be used across all views\nformulas:\n formula_name: 'expression'\n\n# Configure display names and settings for properties\nproperties:\n property_name:\n displayName: \"Display Name\"\n formula.formula_name:\n displayName: \"Formula Display Name\"\n file.ext:\n displayName: \"Extension\"\n\n# Define custom summary formulas\nsummaries:\n custom_summary_name: 'values.mean().round(3)'\n\n# Define one or more views\nviews:\n - type: table | cards | list | map\n name: \"View Name\"\n limit: 10 # Optional: limit results\n groupBy: # Optional: group results\n property: property_name\n direction: ASC | DESC\n filters: # View-specific filters\n and: []\n order: # Properties to display in order\n - file.name\n - property_name\n - formula.formula_name\n summaries: # Map properties to summary formulas\n property_name: Average\n```\n\n## Filter Syntax\n\nFilters narrow down results. They can be applied globally or per-view.\n\n### Filter Structure\n\n```yaml\n# Single filter\nfilters: 'status == \"done\"'\n\n# AND - all conditions must be true\nfilters:\n and:\n - 'status == \"done\"'\n - 'priority > 3'\n\n# OR - any condition can be true\nfilters:\n or:\n - 'file.hasTag(\"book\")'\n - 'file.hasTag(\"article\")'\n\n# NOT - exclude matching items\nfilters:\n not:\n - 'file.hasTag(\"archived\")'\n\n# Nested filters\nfilters:\n or:\n - file.hasTag(\"tag\")\n - and:\n - file.hasTag(\"book\")\n - file.hasLink(\"Textbook\")\n - not:\n - file.hasTag(\"book\")\n - file.inFolder(\"Required Reading\")\n```\n\n### Filter Operators\n\n| Operator | Description |\n|----------|-------------|\n| `==` | equals |\n| `!=` | not equal |\n| `>` | greater than |\n| `<` | less than |\n| `>=` | greater than or equal |\n| `<=` | less than or equal |\n| `&&` | logical and |\n| `\\|\\|` | logical or |\n| `!` | logical not |\n\n## Properties\n\n### Three Types of Properties\n\n1. **Note properties** - From frontmatter: `note.author` or just `author`\n2. **File properties** - File metadata: `file.name`, `file.mtime`, etc.\n3. **Formula properties** - Computed values: `formula.my_formula`\n\n### File Properties Reference\n\n| Property | Type | Description |\n|----------|------|-------------|\n| `file.name` | String | File name |\n| `file.basename` | String | File name without extension |\n| `file.path` | String | Full path to file |\n| `file.folder` | String | Parent folder path |\n| `file.ext` | String | File extension |\n| `file.size` | Number | File size in bytes |\n| `file.ctime` | Date | Created time |\n| `file.mtime` | Date | Modified time |\n| `file.tags` | List | All tags in file |\n| `file.links` | List | Internal links in file |\n| `file.backlinks` | List | Files linking to this file |\n| `file.embeds` | List | Embeds in the note |\n| `file.properties` | Object | All frontmatter properties |\n\n### The `this` Keyword\n\n- In main content area: refers to the base file itself\n- When embedded: refers to the embedding file\n- In sidebar: refers to the active file in main content\n\n## Formula Syntax\n\nFormulas compute values from properties. Defined in the `formulas` section.\n\n```yaml\nformulas:\n # Simple arithmetic\n total: \"price * quantity\"\n \n # Conditional logic\n status_icon: 'if(done, \"✅\", \"⏳\")'\n \n # String formatting\n formatted_price: 'if(price, price.toFixed(2) + \" dollars\")'\n \n # Date formatting\n created: 'file.ctime.format(\"YYYY-MM-DD\")'\n \n # Complex expressions\n days_old: '((now() - file.ctime) / 86400000).round(0)'\n```\n\n## Functions Reference\n\n### Global Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `date()` | `date(string): date` | Parse string to date. Format: `YYYY-MM-DD HH:mm:ss` |\n| `duration()` | `duration(string): duration` | Parse duration string |\n| `now()` | `now(): date` | Current date and time |\n| `today()` | `today(): date` | Current date (time = 00:00:00) |\n| `if()` | `if(condition, trueResult, falseResult?)` | Conditional |\n| `min()` | `min(n1, n2, ...): number` | Smallest number |\n| `max()` | `max(n1, n2, ...): number` | Largest number |\n| `number()` | `number(any): number` | Convert to number |\n| `link()` | `link(path, display?): Link` | Create a link |\n| `list()` | `list(element): List` | Wrap in list if not already |\n| `file()` | `file(path): file` | Get file object |\n| `image()` | `image(path): image` | Create image for rendering |\n| `icon()` | `icon(name): icon` | Lucide icon by name |\n| `html()` | `html(string): html` | Render as HTML |\n| `escapeHTML()` | `escapeHTML(string): string` | Escape HTML characters |\n\n### Any Type Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `isTruthy()` | `any.isTruthy(): boolean` | Coerce to boolean |\n| `isType()` | `any.isType(type): boolean` | Check type |\n| `toString()` | `any.toString(): string` | Convert to string |\n\n### Date Functions & Fields\n\n**Fields:** `date.year`, `date.month`, `date.day`, `date.hour`, `date.minute`, `date.second`, `date.millisecond`\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `date()` | `date.date(): date` | Remove time portion |\n| `format()` | `date.format(string): string` | Format with Moment.js pattern |\n| `time()` | `date.time(): string` | Get time as string |\n| `relative()` | `date.relative(): string` | Human-readable relative time |\n| `isEmpty()` | `date.isEmpty(): boolean` | Always false for dates |\n\n### Date Arithmetic\n\n```yaml\n# Duration units: y/year/years, M/month/months, d/day/days, \n# w/week/weeks, h/hour/hours, m/minute/minutes, s/second/seconds\n\n# Add/subtract durations\n\"date + \\\"1M\\\"\" # Add 1 month\n\"date - \\\"2h\\\"\" # Subtract 2 hours\n\"now() + \\\"1 day\\\"\" # Tomorrow\n\"today() + \\\"7d\\\"\" # A week from today\n\n# Subtract dates for millisecond difference\n\"now() - file.ctime\"\n\n# Complex duration arithmetic\n\"now() + (duration('1d') * 2)\"\n```\n\n### String Functions\n\n**Field:** `string.length`\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `contains()` | `string.contains(value): boolean` | Check substring |\n| `containsAll()` | `string.containsAll(...values): boolean` | All substrings present |\n| `containsAny()` | `string.containsAny(...values): boolean` | Any substring present |\n| `startsWith()` | `string.startsWith(query): boolean` | Starts with query |\n| `endsWith()` | `string.endsWith(query): boolean` | Ends with query |\n| `isEmpty()` | `string.isEmpty(): boolean` | Empty or not present |\n| `lower()` | `string.lower(): string` | To lowercase |\n| `title()` | `string.title(): string` | To Title Case |\n| `trim()` | `string.trim(): string` | Remove whitespace |\n| `replace()` | `string.replace(pattern, replacement): string` | Replace pattern |\n| `repeat()` | `string.repeat(count): string` | Repeat string |\n| `reverse()` | `string.reverse(): string` | Reverse string |\n| `slice()` | `string.slice(start, end?): string` | Substring |\n| `split()` | `string.split(separator, n?): list` | Split to list |\n\n### Number Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `abs()` | `number.abs(): number` | Absolute value |\n| `ceil()` | `number.ceil(): number` | Round up |\n| `floor()` | `number.floor(): number` | Round down |\n| `round()` | `number.round(digits?): number` | Round to digits |\n| `toFixed()` | `number.toFixed(precision): string` | Fixed-point notation |\n| `isEmpty()` | `number.isEmpty(): boolean` | Not present |\n\n### List Functions\n\n**Field:** `list.length`\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `contains()` | `list.contains(value): boolean` | Element exists |\n| `containsAll()` | `list.containsAll(...values): boolean` | All elements exist |\n| `containsAny()` | `list.containsAny(...values): boolean` | Any element exists |\n| `filter()` | `list.filter(expression): list` | Filter by condition (uses `value`, `index`) |\n| `map()` | `list.map(expression): list` | Transform elements (uses `value`, `index`) |\n| `reduce()` | `list.reduce(expression, initial): any` | Reduce to single value (uses `value`, `index`, `acc`) |\n| `flat()` | `list.flat(): list` | Flatten nested lists |\n| `join()` | `list.join(separator): string` | Join to string |\n| `reverse()` | `list.reverse(): list` | Reverse order |\n| `slice()` | `list.slice(start, end?): list` | Sublist |\n| `sort()` | `list.sort(): list` | Sort ascending |\n| `unique()` | `list.unique(): list` | Remove duplicates |\n| `isEmpty()` | `list.isEmpty(): boolean` | No elements |\n\n### File Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `asLink()` | `file.asLink(display?): Link` | Convert to link |\n| `hasLink()` | `file.hasLink(otherFile): boolean` | Has link to file |\n| `hasTag()` | `file.hasTag(...tags): boolean` | Has any of the tags |\n| `hasProperty()` | `file.hasProperty(name): boolean` | Has property |\n| `inFolder()` | `file.inFolder(folder): boolean` | In folder or subfolder |\n\n### Link Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `asFile()` | `link.asFile(): file` | Get file object |\n| `linksTo()` | `link.linksTo(file): boolean` | Links to file |\n\n### Object Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `isEmpty()` | `object.isEmpty(): boolean` | No properties |\n| `keys()` | `object.keys(): list` | List of keys |\n| `values()` | `object.values(): list` | List of values |\n\n### Regular Expression Functions\n\n| Function | Signature | Description |\n|----------|-----------|-------------|\n| `matches()` | `regexp.matches(string): boolean` | Test if matches |\n\n## View Types\n\n### Table View\n\n```yaml\nviews:\n - type: table\n name: \"My Table\"\n order:\n - file.name\n - status\n - due_date\n summaries:\n price: Sum\n count: Average\n```\n\n### Cards View\n\n```yaml\nviews:\n - type: cards\n name: \"Gallery\"\n order:\n - file.name\n - cover_image\n - description\n```\n\n### List View\n\n```yaml\nviews:\n - type: list\n name: \"Simple List\"\n order:\n - file.name\n - status\n```\n\n### Map View\n\nRequires latitude/longitude properties and the Maps plugin.\n\n```yaml\nviews:\n - type: map\n name: \"Locations\"\n # Map-specific settings for lat/lng properties\n```\n\n## Default Summary Formulas\n\n| Name | Input Type | Description |\n|------|------------|-------------|\n| `Average` | Number | Mathematical mean |\n| `Min` | Number | Smallest number |\n| `Max` | Number | Largest number |\n| `Sum` | Number | Sum of all numbers |\n| `Range` | Number | Max - Min |\n| `Median` | Number | Mathematical median |\n| `Stddev` | Number | Standard deviation |\n| `Earliest` | Date | Earliest date |\n| `Latest` | Date | Latest date |\n| `Range` | Date | Latest - Earliest |\n| `Checked` | Boolean | Count of true values |\n| `Unchecked` | Boolean | Count of false values |\n| `Empty` | Any | Count of empty values |\n| `Filled` | Any | Count of non-empty values |\n| `Unique` | Any | Count of unique values |\n\n## Complete Examples\n\n### Task Tracker Base\n\n```yaml\nfilters:\n and:\n - file.hasTag(\"task\")\n - 'file.ext == \"md\"'\n\nformulas:\n days_until_due: 'if(due, ((date(due) - today()) / 86400000).round(0), \"\")'\n is_overdue: 'if(due, date(due) < today() && status != \"done\", false)'\n priority_label: 'if(priority == 1, \"🔴 High\", if(priority == 2, \"🟡 Medium\", \"🟢 Low\"))'\n\nproperties:\n status:\n displayName: Status\n formula.days_until_due:\n displayName: \"Days Until Due\"\n formula.priority_label:\n displayName: Priority\n\nviews:\n - type: table\n name: \"Active Tasks\"\n filters:\n and:\n - 'status != \"done\"'\n order:\n - file.name\n - status\n - formula.priority_label\n - due\n - formula.days_until_due\n groupBy:\n property: status\n direction: ASC\n summaries:\n formula.days_until_due: Average\n\n - type: table\n name: \"Completed\"\n filters:\n and:\n - 'status == \"done\"'\n order:\n - file.name\n - completed_date\n```\n\n### Reading List Base\n\n```yaml\nfilters:\n or:\n - file.hasTag(\"book\")\n - file.hasTag(\"article\")\n\nformulas:\n reading_time: 'if(pages, (pages * 2).toString() + \" min\", \"\")'\n status_icon: 'if(status == \"reading\", \"📖\", if(status == \"done\", \"✅\", \"📚\"))'\n year_read: 'if(finished_date, date(finished_date).year, \"\")'\n\nproperties:\n author:\n displayName: Author\n formula.status_icon:\n displayName: \"\"\n formula.reading_time:\n displayName: \"Est. Time\"\n\nviews:\n - type: cards\n name: \"Library\"\n order:\n - cover\n - file.name\n - author\n - formula.status_icon\n filters:\n not:\n - 'status == \"dropped\"'\n\n - type: table\n name: \"Reading List\"\n filters:\n and:\n - 'status == \"to-read\"'\n order:\n - file.name\n - author\n - pages\n - formula.reading_time\n```\n\n### Project Notes Base\n\n```yaml\nfilters:\n and:\n - file.inFolder(\"Projects\")\n - 'file.ext == \"md\"'\n\nformulas:\n last_updated: 'file.mtime.relative()'\n link_count: 'file.links.length'\n \nsummaries:\n avgLinks: 'values.filter(value.isType(\"number\")).mean().round(1)'\n\nproperties:\n formula.last_updated:\n displayName: \"Updated\"\n formula.link_count:\n displayName: \"Links\"\n\nviews:\n - type: table\n name: \"All Projects\"\n order:\n - file.name\n - status\n - formula.last_updated\n - formula.link_count\n summaries:\n formula.link_count: avgLinks\n groupBy:\n property: status\n direction: ASC\n\n - type: list\n name: \"Quick List\"\n order:\n - file.name\n - status\n```\n\n### Daily Notes Index\n\n```yaml\nfilters:\n and:\n - file.inFolder(\"Daily Notes\")\n - '/^\\d{4}-\\d{2}-\\d{2}$/.matches(file.basename)'\n\nformulas:\n word_estimate: '(file.size / 5).round(0)'\n day_of_week: 'date(file.basename).format(\"dddd\")'\n\nproperties:\n formula.day_of_week:\n displayName: \"Day\"\n formula.word_estimate:\n displayName: \"~Words\"\n\nviews:\n - type: table\n name: \"Recent Notes\"\n limit: 30\n order:\n - file.name\n - formula.day_of_week\n - formula.word_estimate\n - file.mtime\n```\n\n## Embedding Bases\n\nEmbed in Markdown files:\n\n```markdown\n![[MyBase.base]]\n\n<!-- Specific view -->\n![[MyBase.base#View Name]]\n```\n\n## YAML Quoting Rules\n\n- Use single quotes for formulas containing double quotes: `'if(done, \"Yes\", \"No\")'`\n- Use double quotes for simple strings: `\"My View Name\"`\n- Escape nested quotes properly in complex expressions\n\n## Common Patterns\n\n### Filter by Tag\n```yaml\nfilters:\n and:\n - file.hasTag(\"project\")\n```\n\n### Filter by Folder\n```yaml\nfilters:\n and:\n - file.inFolder(\"Notes\")\n```\n\n### Filter by Date Range\n```yaml\nfilters:\n and:\n - 'file.mtime > now() - \"7d\"'\n```\n\n### Filter by Property Value\n```yaml\nfilters:\n and:\n - 'status == \"active\"'\n - 'priority >= 3'\n```\n\n### Combine Multiple Conditions\n```yaml\nfilters:\n or:\n - and:\n - file.hasTag(\"important\")\n - 'status != \"done\"'\n - and:\n - 'priority == 1'\n - 'due != \"\"'\n```\n\n## References\n\n- [Bases Syntax](https://help.obsidian.md/bases/syntax)\n- [Functions](https://help.obsidian.md/bases/functions)\n- [Views](https://help.obsidian.md/bases/views)\n- [Formulas](https://help.obsidian.md/formulas)\n\n"} |