diff options
| author | Johannes Theiner <[email protected]> | 2025-12-18 11:53:40 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-12-18 11:53:40 +0100 |
| commit | 2323eddbb126e0cc03ecffb176ba6cecc41f2753 (patch) | |
| tree | 5e3817c1130e5c3b2f2195cc28524871cf4592fb /README.md | |
| parent | e2a64e0534ec6cdfacaa2e70da3d65eca2776edb (diff) | |
| parent | 911b773800976c41b4eafd6ad5a58594959d297c (diff) | |
| download | ai-pulse-obsidian-plugin-2323eddbb126e0cc03ecffb176ba6cecc41f2753.tar.gz ai-pulse-obsidian-plugin-2323eddbb126e0cc03ecffb176ba6cecc41f2753.zip | |
Merge pull request #164 from joethei/master
Include eslint config
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 6 insertions, 10 deletions
@@ -7,7 +7,7 @@ The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definiti This sample plugin demonstrates some of the basic functionality the plugin API can do. - Adds a ribbon icon, which shows a Notice when clicked. -- Adds a command "Open Sample Modal" which opens a Modal. +- Adds a command "Open modal (simple)" which opens a Modal. - Adds a plugin setting tab to the settings page. - Registers a global click event and output 'click' to the console. - Registers a global interval which logs 'setInterval' to the console. @@ -55,15 +55,11 @@ 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) +## Improve code quality with eslint - [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/` +- This project already has eslint preconfigured, you can invoke a check by running`npm run lint` +- Together with a custom eslint [plugin](https://github.com/eslint-plugin) for Obsidan specific code guidelines. +- A GitHub action is preconfigured to automatically lint every commit on all branches. ## Funding URL @@ -91,4 +87,4 @@ If you have multiple URLs, you can also do: ## API Documentation -See https://github.com/obsidianmd/obsidian-api +See https://docs.obsidian.md |