Update readme

This commit is contained in:
Andras Schmelczer 2025-01-02 15:49:37 +00:00
parent c738b96b62
commit 00f9bcf638
No known key found for this signature in database
GPG key ID: FC8F2C3D3D1A718C
2 changed files with 3 additions and 14 deletions

View file

@ -57,15 +57,6 @@ Quick starting guide for new plugin devs:
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Improve code quality with eslint (optional)
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint`
- To use eslint to analyze this project use this command:
- `eslint main.ts`
- eslint will then create a report with suggestions for code improvement by file and line number.
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
- `eslint .\src\`
## Funding URL
@ -99,5 +90,3 @@ See https://github.com/obsidianmd/obsidian-api
npm install -g openapi-typescript
openapi-typescript http://localhost:3000/api.json --output plugin/src/services/types.ts