Skip to content

Commit

Permalink
Add setting "Preloading rules"
Browse files Browse the repository at this point in the history
Signed-off-by: William So <polyipseity@gmail.com>
  • Loading branch information
polyipseity committed Aug 13, 2023
1 parent 3134d52 commit 4d79665
Show file tree
Hide file tree
Showing 55 changed files with 234 additions and 10 deletions.
5 changes: 5 additions & 0 deletions .changeset/great-parrots-admire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"obsidian-modules": minor
---

Add setting "Preloading rules".
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,9 @@ eat(2 * pi)
const mod = await self.require.import("[[module]]")
mod.eat(2 * mod.pi)
```
- To create a module, create a JavaScript file or a Markdown file with JavaScript code blocks. For `require` (but not `require.import`), the file needs to have one of the following extensions: `.js`, `.mjs`, `.js.md`, `.mjs.md`. We recommend that your modules do not have global or side effects because modules are cached and thus not reloaded on every request.
- To create a module, create a JavaScript file or a Markdown file with JavaScript code blocks.
- For `require` (but not `require.import`), the module file needs to be preloaded, which can be configured in settings. By default, preloaded files have the following extensions: `.js`, `.mjs`, `.js.md`, `.mjs.md`
- Modules should not have global or side effects because they are cached and thus not reloaded on every requiring.
- Module exports can be CommonJS-style or ES module-style:
```JavaScript
// ES module-style, supported by `require.import`.
Expand All @@ -110,7 +112,6 @@ Contributions are welcome!

The todos here, ordered alphabetically, are things planned for the plugin. There are no guarantees that they will be completed. However, we are likely to accept contributions for them.

- Configure preloaded files.
- Configure accepted code block languages.
- Autocomplete with JSDoc.

Expand Down
3 changes: 3 additions & 0 deletions assets/locales/af/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/am/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/ar/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/be/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/bg/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/bn/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/ca/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/cs/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/da/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/de/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/el/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
2 changes: 2 additions & 0 deletions assets/locales/en/asset.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
},
"expose-internal-modules-icon": "puzzle",
"open-changelog-on-update-icon": "$t(asset:generic.documentations.changelog-icon)",
"preloading-rules-edit-icon": "$t(asset:generic.edit-list-icon)",
"preloading-rules-icon": "$t(asset:generic.rule-icon)",
"require-name-icon": "key"
}
}
3 changes: 3 additions & 0 deletions assets/locales/en/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/eo/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/es/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/eu/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/fa/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/fi/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/fr/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/gl/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/he/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/hi/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/hu/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/id/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/it/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/ja/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
3 changes: 3 additions & 0 deletions assets/locales/ko/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"expose-internal-modules-description-HTML": "<code>obsidian</code>, <code>@codemirror/*</code>, <code>@lezer/*</code>…",
"interface": "Interface",
"open-changelog-on-update": "$t(generic.open, capitalize) $t(generic.documentations.changelog) on update",
"preloading-rules": "Preloading $t(generic.rule_other)",
"preloading-rules-description-HTML": "Required for using <code>require</code> (but not <code>require.import</code>). $t(generic.list-description, capitalize)",
"preloading-rules-edit": "$t(generic.edit)",
"require-name": "Require $t(generic.name)",
"require-name-description-invalid": "Using the default as the specified $t(generic.name) is unavailable."
}
Expand Down
Loading

0 comments on commit 4d79665

Please sign in to comment.