aaronsb_obsidian-mcp-plugin/eslint.config.mts
Aaron Bockelie 8bb580cc56 fix: .mcpignore semantics, TLS 1.3 startup, rename extension (#250, #252, #253)
Bundles the three reported bugs plus an unreported under-blocking bug found
while writing the tests for #250, and adds the coverage tooling that would
have caught all four.

#250 — .mcpignore negation was inverted
The parser stripped the leading '!' before Minimatch saw it, so .negate was
always false and the branch reading it was dead code. '!folder/*' compiled
into a positive exclusion: negation did not merely fail, it inverted.

Under-blocking (found while testing the above, not reported)
Patterns were handed to Minimatch raw, so two gitignore rules were never
implemented: a slash-less pattern matches at any depth ('*.secret' must hide
'a/b/creds.secret'), and a directory match covers its contents ('private/'
must hide 'private/notes.md'). No consumer of isExcluded() checks ancestors —
every caller passes a full file path — so nothing compensated downstream. The
plugin's own shipped .mcpignore template promises both behaviours, so a user
following it believed private files were hidden while they were being served
to the model. Patterns are now translated into the globs that implement
gitignore semantics, and negation is interpreted here rather than by Minimatch.

#252 — min TLS 1.3 crashed the server
secureProtocol mapped 1.3 to 'TLSv1_3_method', which OpenSSL never shipped, so
context creation threw "Unknown method: TLSv1_3_method". Switched to minVersion,
which also fixes a second latent bug: secureProtocol PINS one version, so
"minimum TLS 1.2" was silently refusing TLS 1.3 clients. The setting now
behaves as the floor it is labelled.

#253 — rename dropped the extension
'newName' was concatenated onto the source directory verbatim, so renaming
'note.md' to 'renamed' produced an extension-less file that drops out of
markdown views. The source extension is now carried over when newName omits
one, before the overwrite guard so it checks the right path.

Coverage + test contract
All four bugs shipped through code paths with zero coverage. Adds `make
coverage` / `coverage-map` / `coverage-gate`, a ratcheting coverageThreshold
(security boundary held to a far higher floor than global, since a hole there
leaks vault content), and tests/test-contract.test.ts enforcing that a green
run means something: no .only, no .skip, every file asserts, no tautologies.
The contract immediately caught an `expect(true).toBe(true)` placeholder in the
path-validator suite, now replaced with real assertions.

BREAKING (.mcpignore, both intended):
- The double-'!' workaround for #250 now correctly parses as a double negation
  (net exclude) and will stop working.
- A bare '*' now excludes at every depth, per gitignore, rather than top-level
  only. This is what makes the '*' + '!keep/**' whitelist idiom work.
2026-07-13 17:46:50 -05:00

90 lines
2.6 KiB
TypeScript

import tseslint from 'typescript-eslint';
import obsidianmd from "eslint-plugin-obsidianmd";
import globals from "globals";
import { globalIgnores } from "eslint/config";
export default tseslint.config(
{
languageOptions: {
globals: {
...globals.browser,
// Node.js globals needed for desktop-only plugin (isDesktopOnly: true)
require: "readonly",
process: "readonly",
Buffer: "readonly",
__dirname: "readonly",
__filename: "readonly",
module: "readonly",
exports: "readonly",
},
parserOptions: {
projectService: {
allowDefaultProject: [
'eslint.config.mts',
'manifest.json'
]
},
tsconfigRootDir: import.meta.dirname,
extraFileExtensions: ['.json']
},
},
},
...obsidianmd.configs.recommended,
{
files: ["**/*.ts"],
rules: {
// Enable auto-fix for sentence case UI text
"obsidianmd/ui/sentence-case": ["error", { allowAutoFix: true }],
},
},
// builtin-modules is build-tooling only (esbuild.config.mjs), not plugin code.
// js-yaml is used for YAML parsing in Bases API — no built-in alternative exists.
//
// obsidianmd >= 0.3.0 wires its typed plugin rules into the hybrid recommended
// config without a `**/*.ts` files scope, so ESLint also tries to run them on
// package.json (which uses the JSON language and has no parser services). The
// rules call getParserServices() and abort the whole run. Disable the typed
// rules here for the JSON files the recommended config inspects.
{
files: ["package.json", "**/*.json"],
rules: {
"depend/ban-dependencies": "off",
"obsidianmd/no-plugin-as-component": "off",
"obsidianmd/no-view-references-in-plugin": "off",
"obsidianmd/no-unsupported-api": "off",
"obsidianmd/prefer-file-manager-trash-file": "off",
"obsidianmd/prefer-instanceof": "off",
},
},
globalIgnores([
"node_modules",
"dist",
"tests",
// Generated by `make coverage` — istanbul's HTML report ships its own vendored
// JS, which is not project code and has no tsconfig entry.
"coverage",
"test-*.js",
"*.config.js",
"*.config.mjs",
"esbuild.config.mjs",
"eslint.config.mts",
"sync-version.mjs",
"version-bump.mjs",
"jest.config.js",
"versions.json",
"main.js",
"worker.js",
"mcpb",
"scripts",
// Data files — obsidianmd's recommended config only wires the JSON
// language to package.json; other .json files fall through to the JS
// parser and fail with "Unexpected token :". They aren't code anyway.
// (The validate-manifest rule reads manifest.json directly via fs.)
"tsconfig.json",
"package-lock.json",
"manifest.json",
"versions.json",
".claude/**",
"src/config/**/*.json",
]),
);