Anri/svg-obsidian
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Format, rebrand and add license file

Browse source
This commit is contained in:
Mylloon 2023-10-01 21:29:46 +02:00
parent a190028d8a
commit a4b575fdff
Signed by: Anri
GPG key ID: A82D63DFF8D1317F
11 changed files with 2026 additions and 160 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
.eslintrc
View file

@ -1,23 +1,21 @@
{ {
"root": true, "root": true,
"parser": "@typescript-eslint/parser", "parser": "@typescript-eslint/parser",
"env": { "node": true }, "env": { "node": true },
"plugins": [ "plugins": ["@typescript-eslint"],
"@typescript-eslint" "extends": [
], "eslint:recommended",
"extends": [ "plugin:@typescript-eslint/eslint-recommended",
"eslint:recommended", "plugin:@typescript-eslint/recommended"
"plugin:@typescript-eslint/eslint-recommended", ],
"plugin:@typescript-eslint/recommended" "parserOptions": {
], "sourceType": "module"
"parserOptions": { },
"sourceType": "module" "rules": {
}, "no-unused-vars": "off",
"rules": { "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
"no-unused-vars": "off", "@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], "no-prototype-builtins": "off",
"@typescript-eslint/ban-ts-comment": "off", "@typescript-eslint/no-empty-function": "off"
"no-prototype-builtins": "off", }
"@typescript-eslint/no-empty-function": "off" }
}
}

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Mylloon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

101
README.md
View file

@ -1,95 +1,60 @@
# Obsidian Sample Plugin # SVG-Obsidian
This is a sample plugin for Obsidian (https://obsidian.md). Plugin Obsidian pour pouvoir voir les SVG sans se soucier du thème clair/sombre.
This project uses Typescript to provide type checking and documentation. Utile principalement pour les exports des dessins excalidraw.
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
**Note:** The Obsidian API is still in early alpha and is subject to change at any time! <!-- ## First time developing plugins?
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 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.
## First time developing plugins?
Quick starting guide for new plugin devs: Quick starting guide for new plugin devs:
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with. - Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). - Install NodeJS, then run `npm i` in the command line under your repo folder.
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. - Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Install NodeJS, then run `npm i` in the command line under your repo folder. - Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. - Reload Obsidian to load the new version of your plugin.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. - Enable plugin in settings window.
- Reload Obsidian to load the new version of your plugin. - For updates to the Obsidian API run `npm update` in the command line under your repo folder.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
## Releasing new releases ## Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. - Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible. - Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases - Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release. - Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release. - Publish the release.
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`. > You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json` > The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
## Adding your plugin to the community plugin list ## Adding your plugin to the community plugin list
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md - Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
- Publish an initial version. - Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo. - Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. - Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. -->
## How to use ## How to use
- Clone this repo. - Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`). - Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies. - `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode. - `npm run dev` to start compilation in watch mode.
## Manually installing the plugin ## Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. - 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 (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 - [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:
You can include funding URLs where people who use your plugin can financially support it. - `npm install -g eslint`
- To use eslint to analyze this project use this command:
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file: - `eslint main.ts`
- eslint will then create a report with suggestions for code improvement by file and line number.
```json - 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\`
"fundingUrl": "https://buymeacoffee.com"
}
```
If you have multiple URLs, you can also do:
```json
{
"fundingUrl": {
"Buy Me a Coffee": "https://buymeacoffee.com",
"GitHub Sponsor": "https://github.com/sponsors",
"Patreon": "https://www.patreon.com/"
}
}
```
## API Documentation ## API Documentation

8
esbuild.config.mjs
View file

@ -2,14 +2,13 @@ import esbuild from "esbuild";
import process from "process"; import process from "process";
import builtins from "builtin-modules"; import builtins from "builtin-modules";
const banner = const banner = `/*
`/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin if you want to view the source, please visit the github repository of this plugin
*/ */
`; `;
const prod = (process.argv[2] === "production"); const prod = process.argv[2] === "production";
const context = await esbuild.context({ const context = await esbuild.context({
banner: { banner: {
@ -31,7 +30,8 @@ const context = await esbuild.context({
"@lezer/common", "@lezer/common",
"@lezer/highlight", "@lezer/highlight",
"@lezer/lr", "@lezer/lr",
...builtins], ...builtins,
],
format: "cjs", format: "cjs",
target: "es2018", target: "es2018",
logLevel: "info", logLevel: "info",

12
manifest.json
View file

@ -1,11 +1,11 @@
{ {
"id": "sample-plugin", "id": "svg-obsidian",
"name": "Sample Plugin", "name": "SVG Obsidian",
"version": "1.0.0", "version": "1.0.0",
"minAppVersion": "0.15.0", "minAppVersion": "0.15.0",
"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.", "description": "View SVGs without worrying about the light/dark theme.",
"author": "Obsidian", "author": "Mylloon",
"authorUrl": "https://obsidian.md", "authorUrl": "https://mylloon.fr",
"fundingUrl": "https://obsidian.md/pricing", "fundingUrl": "https://github.com/sponsors/Mylloon",
"isDesktopOnly": false "isDesktopOnly": false
} }

1885
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

12
package.json
View file

@ -1,15 +1,19 @@
{ {
"name": "obsidian-sample-plugin", "name": "svg-obsidian",
"version": "1.0.0", "version": "1.0.0",
"description": "This is a sample plugin for Obsidian (https://obsidian.md)", "description": "View SVGs without worrying about the light/dark theme.",
"main": "main.js", "main": "main.js",
"scripts": { "scripts": {
"dev": "node esbuild.config.mjs", "dev": "node esbuild.config.mjs",
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production", "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"version": "node version-bump.mjs && git add manifest.json versions.json" "version": "node version-bump.mjs && git add manifest.json versions.json"
}, },
"keywords": [], "keywords": [
"author": "", "obsidian",
"plugin",
"svg"
],
"author": "Mylloon",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"@types/node": "^16.11.6", "@types/node": "^16.11.6",

37
tsconfig.json
View file

@ -1,24 +1,17 @@
{ {
"compilerOptions": { "compilerOptions": {
"baseUrl": ".", "baseUrl": ".",
"inlineSourceMap": true, "inlineSourceMap": true,
"inlineSources": true, "inlineSources": true,
"module": "ESNext", "module": "ESNext",
"target": "ES6", "target": "ES6",
"allowJs": true, "allowJs": true,
"noImplicitAny": true, "noImplicitAny": true,
"moduleResolution": "node", "moduleResolution": "node",
"importHelpers": true, "importHelpers": true,
"isolatedModules": true, "isolatedModules": true,
"strictNullChecks": true, "strictNullChecks": true,
"lib": [ "lib": ["DOM", "ES5", "ES6", "ES7"]
"DOM", },
"ES5", "include": ["**/*.ts"]
"ES6",
"ES7"
]
},
"include": [
"**/*.ts"
]
} }