Skip to content

docs: update mwe for eslint config #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
superle3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update mwe for eslint config #170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# eslint-plugin-obsidianmd

## Installation

You'll first need to install [ESLint](https://eslint.org/):
Expand All @@ -24,17 +23,21 @@ To use the recommended configuration, add it to your `eslint.config.js` file. Th

```javascript
// eslint.config.mjs
import tsparser from "@typescript-eslint/parser";
import { defineConfig } from "eslint/config";
import obsidianmd from "eslint-plugin-obsidianmd";

export default defineConfig([
...obsidianmd.configs.recommended,
{
files: ["**/*.ts"],
extends: [obsidianmd.configs.recommended],
languageOptions: {
parser: tsparser,
parserOptions: { project: "./tsconfig.json" },
parserOptions: {
projectService: {
allowDefaultProject: ["manifest.json"],
},
tsconfigRootDir: import.meta.dirname,
extraFileExtensions: [".json"],
},
},

// You can add your own configuration to override or add rules
Expand Down
Loading